CellAreaBoxProtocol

public protocol CellAreaBoxProtocol : CellAreaProtocol, OrientableProtocol

A cell area that renders GtkCellRenderers into a row or a column

The GtkCellAreaBox renders cell renderers into a row or a column depending on its GtkOrientation.

GtkCellAreaBox uses a notion of packing. Packing refers to adding cell renderers with reference to a particular position in a GtkCellAreaBox. There are two reference positions: the start and the end of the box. When the GtkCellAreaBox is oriented in the GTK_ORIENTATION_VERTICAL orientation, the start is defined as the top of the box and the end is defined as the bottom. In the GTK_ORIENTATION_HORIZONTAL orientation start is defined as the left side and the end is defined as the right side.

Alignments of GtkCellRenderers rendered in adjacent rows can be configured by configuring the GtkCellAreaBox align child cell property with gtk_cell_area_cell_set_property() or by specifying the “align” argument to gtk_cell_area_box_pack_start() and gtk_cell_area_box_pack_end().

The CellAreaBoxProtocol protocol exposes the methods and properties of an underlying GtkCellAreaBox instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see CellAreaBox. Alternatively, use CellAreaBoxRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub
  • ptr

    Untyped pointer to the underlying GtkCellAreaBox instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
    Show on GitHub
  • cell_area_box_ptr Default implementation

    Typed pointer to the underlying GtkCellAreaBox instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkCellAreaBox instance.

    Declaration

    Swift

    var cell_area_box_ptr: UnsafeMutablePointer<GtkCellAreaBox>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to CellAreaBoxProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

CellAreaBox Class

  • Bind a CellAreaBoxPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: CellAreaBoxPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind
    target

    the target object to bind to
    target_property

    the target property to bind to
    flags

    the flags to pass to the Binding
    transform_from

    ValueTransformer to use for forward transformation
    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

    Show on GitHub
  • get(property:) Extension method

    Get the value of a CellAreaBox property

    Declaration

    Swift

    @inlinable
func get(property: CellAreaBoxPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub
  • set(property:value:) Extension method

    Set the value of a CellAreaBox property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
func set(property: CellAreaBoxPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

CellAreaBox Class: CellAreaBoxProtocol extension (methods and fields)

  • getSpacing() Extension method

    Gets the spacing added between cell renderers.

    Declaration

    Swift

    @inlinable
func getSpacing() -> Int
    Show on GitHub

  • Adds renderer to box, packed with reference to the end of box.

    The renderer is packed after (away from end of) any other GtkCellRenderer packed with reference to the end of box.

    Declaration

    Swift

    @inlinable
func packEnd<CellRendererT>(renderer: CellRendererT, expand: Bool, align: Bool, fixed: Bool) where CellRendererT : CellRendererProtocol
    Show on GitHub

  • Adds renderer to box, packed with reference to the start of box.

    The renderer is packed after any other GtkCellRenderer packed with reference to the start of box.

    Declaration

    Swift

    @inlinable
func packStart<CellRendererT>(renderer: CellRendererT, expand: Bool, align: Bool, fixed: Bool) where CellRendererT : CellRendererProtocol
    Show on GitHub
  • set(spacing:) Extension method

    Sets the spacing to add between cell renderers in box.

    Declaration

    Swift

    @inlinable
func set(spacing: Int)
    Show on GitHub
  • spacing Extension method

    The amount of space to reserve between cells.

    Declaration

    Swift

    @inlinable
var spacing: Int { get nonmutating set }
    Show on GitHub