BoxProtocol

public protocol BoxProtocol : ContainerProtocol, OrientableProtocol

The GtkBox widget arranges child widgets into a single row or column, depending upon the value of its GtkOrientable:orientation property. Within the other dimension, all children are allocated the same size. Of course, the GtkWidget:halign and GtkWidget:valign properties can be used on the children to influence their allocation.

GtkBox uses a notion of packing. Packing refers to adding widgets with reference to a particular position in a GtkContainer. For a GtkBox, there are two reference positions: the start and the end of the box. For a vertical GtkBox, the start is defined as the top of the box and the end is defined as the bottom. For a horizontal GtkBox the start is defined as the left side and the end is defined as the right side.

Use repeated calls to gtk_box_pack_start() to pack widgets into a GtkBox from start to end. Use gtk_box_pack_end() to add widgets from end to start. You may intersperse these calls and add widgets from both ends of the same GtkBox.

Because GtkBox is a GtkContainer, you may also use gtk_container_add() to insert widgets into the box, and they will be packed with the default values for expand and fill child properties. Use gtk_container_remove() to remove widgets from the GtkBox.

Use gtk_box_set_homogeneous() to specify whether or not all children of the GtkBox are forced to get the same amount of space.

Use gtk_box_set_spacing() to determine how much space will be minimally placed between all children in the GtkBox. Note that spacing is added between the children, while padding added by gtk_box_pack_start() or gtk_box_pack_end() is added on either side of the widget it belongs to.

Use gtk_box_reorder_child() to move a GtkBox child to a different place in the box.

Use gtk_box_set_child_packing() to reset the expand, fill and padding child properties. Use gtk_box_query_child_packing() to query these fields.

CSS nodes

GtkBox uses a single CSS node with name box.

In horizontal orientation, the nodes of the children are always arranged from left to right. So :first-child will always select the leftmost child, regardless of text direction.

The BoxProtocol protocol exposes the methods and properties of an underlying GtkBox 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 Box. Alternatively, use BoxRef 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 GtkBox instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkBox instance.

    Default Implementation

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

    Declaration

    Swift

    var box_ptr: UnsafeMutablePointer<GtkBox>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to BoxProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub
  • set(marginStart:) Extension method

    Set the start margin of the box

    Declaration

    Swift

    @inlinable
func set(marginStart: Int)

    Parameters

    marginStart

    start margin
    Show on GitHub
  • set(marginEnd:) Extension method

    Set the end margin of the box

    Declaration

    Swift

    @inlinable
func set(marginEnd: Int)

    Parameters

    marginEnd

    end margin
    Show on GitHub
  • set(child:properties:) Extension method

    Set the property of a child widget of this box

    Declaration

    Swift

    @inlinable
func set<W>(child widget: W, properties: [(BoxPropertyName, Any)]) where W : WidgetProtocol

    Parameters

    child

    widget to set property for
    property

    name of the property
    value

    value to set
    Show on GitHub
  • set(child:properties:) Extension method

    Set up a child widget of this box with the given list of properties

    Declaration

    Swift

    @inlinable
func set<W>(child widget: W, properties ps: (BoxPropertyName, Any)...) where W : WidgetProtocol

    Parameters

    widget

    child widget to set properties for
    properties

    PropertyName / value pairs to set
    Show on GitHub
  • add(_:properties:) Extension method

    Add a child widget to this box with a given list of properties

    Declaration

    Swift

    @inlinable
func add<W>(_ widget: W, properties ps: (BoxPropertyName, Any)...) where W : WidgetProtocol

    Parameters

    widget

    child widget to add
    properties

    PropertyName / value pairs of properties to set
    Show on GitHub
  • add(_:property:value:) Extension method

    Add a child widget to this box with a given property

    Declaration

    Swift

    @inlinable
func add<W, V>(_ widget: W, property p: BoxPropertyName, value v: V) where W : WidgetProtocol

    Parameters

    widget

    child widget to add
    property

    name of the property to set
    value

    value of the property to set
    Show on GitHub

Box Class

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

    Declaration

    Swift

    @discardableResult
@inlinable
func bind<Q, T>(property source_property: BoxPropertyName, 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 Box property

    Declaration

    Swift

    @inlinable
func get(property: BoxPropertyName) -> 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 Box property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Box Class: BoxProtocol extension (methods and fields)

  • getBaselinePosition() Extension method

    Gets the value set by gtk_box_set_baseline_position().

    Declaration

    Swift

    @inlinable
func getBaselinePosition() -> GtkBaselinePosition
    Show on GitHub
  • getCenterWidget() Extension method

    Retrieves the center widget of the box.

    Declaration

    Swift

    @inlinable
func getCenterWidget() -> WidgetRef!
    Show on GitHub
  • getHomogeneous() Extension method

    Returns whether the box is homogeneous (all children are the same size). See gtk_box_set_homogeneous().

    Declaration

    Swift

    @inlinable
func getHomogeneous() -> Bool
    Show on GitHub
  • getSpacing() Extension method

    Gets the value set by gtk_box_set_spacing().

    Declaration

    Swift

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

  • Adds child to box, packed with reference to the end of box. The child is packed after (away from end of) any other child packed with reference to the end of box.

    Declaration

    Swift

    @inlinable
func packEnd<WidgetT>(child: WidgetT, expand: Bool, fill: Bool, padding: Int) where WidgetT : WidgetProtocol
    Show on GitHub

  • Adds child to box, packed with reference to the start of box. The child is packed after any other child packed with reference to the start of box.

    Declaration

    Swift

    @inlinable
func packStart<WidgetT>(child: WidgetT, expand: Bool, fill: Bool, padding: Int) where WidgetT : WidgetProtocol
    Show on GitHub

  • Obtains information about how child is packed into box.

    Declaration

    Swift

    @inlinable
func queryChildPacking<WidgetT>(child: WidgetT, expand: UnsafeMutablePointer<gboolean>!, fill: UnsafeMutablePointer<gboolean>!, padding: UnsafeMutablePointer<guint>!, packType: UnsafeMutablePointer<GtkPackType>!) where WidgetT : WidgetProtocol
    Show on GitHub
  • reorder(child:position:) Extension method

    Moves child to a new position in the list of box children. The list contains widgets packed GTK_PACK_START as well as widgets packed GTK_PACK_END, in the order that these widgets were added to box.

    A widget’s position in the box children list determines where the widget is packed into box. A child widget at some position in the list will be packed just after all other widgets of the same packing type that appear earlier in the list.

    Declaration

    Swift

    @inlinable
func reorder<WidgetT>(child: WidgetT, position: Int) where WidgetT : WidgetProtocol
    Show on GitHub
  • setBaseline(position:) Extension method

    Sets the baseline position of a box. This affects only horizontal boxes with at least one baseline aligned child. If there is more vertical space available than requested, and the baseline is not allocated by the parent then position is used to allocate the baseline wrt the extra space available.

    Declaration

    Swift

    @inlinable
func setBaseline(position: GtkBaselinePosition)
    Show on GitHub
  • setCenter(widget:) Extension method

    Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

    Declaration

    Swift

    @inlinable
func setCenter(widget: WidgetRef? = nil)
    Show on GitHub
  • setCenter(widget:) Extension method

    Sets a center widget; that is a child widget that will be centered with respect to the full width of the box, even if the children at either side take up different amounts of space.

    Declaration

    Swift

    @inlinable
func setCenter<WidgetT>(widget: WidgetT?) where WidgetT : WidgetProtocol
    Show on GitHub

  • Sets the way child is packed into box.

    Declaration

    Swift

    @inlinable
func setChildPacking<WidgetT>(child: WidgetT, expand: Bool, fill: Bool, padding: Int, packType: GtkPackType) where WidgetT : WidgetProtocol
    Show on GitHub
  • set(homogeneous:) Extension method

    Sets the GtkBox:homogeneous property of box, controlling whether or not all children of box are given equal space in the box.

    Declaration

    Swift

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

    Sets the GtkBox:spacing property of box, which is the number of pixels to place between children of box.

    Declaration

    Swift

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

    Gets the value set by gtk_box_set_baseline_position().

    Declaration

    Swift

    @inlinable
var baselinePosition: GtkBaselinePosition { get nonmutating set }
    Show on GitHub
  • centerWidget Extension method

    Retrieves the center widget of the box.

    Declaration

    Swift

    @inlinable
var centerWidget: WidgetRef! { get nonmutating set }
    Show on GitHub
  • homogeneous Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var homogeneous: Bool { get nonmutating set }
    Show on GitHub
  • spacing Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var spacing: Int { get nonmutating set }
    Show on GitHub
  • container Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var container: GtkContainer { get }
    Show on GitHub