BoxLayoutProtocol

public protocol BoxLayoutProtocol : LayoutManagerProtocol, OrientableProtocol

GtkBoxLayout is a layout manager that arranges children in a single row or column.

Whether it is a row or column depends on the value of its [propertyGtk.Orientable:orientation] property. Within the other dimension all children all allocated the same size. The GtkBoxLayout will respect the [propertyGtk.Widget:halign] and [propertyGtk.Widget:valign] properties of each child widget.

If you want all children to be assigned the same size, you can use the [propertyGtk.BoxLayout:homogeneous] property.

If you want to specify the amount of space placed between each child, you can use the [propertyGtk.BoxLayout:spacing] property.

The BoxLayoutProtocol protocol exposes the methods and properties of an underlying GtkBoxLayout 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 BoxLayout. Alternatively, use BoxLayoutRef 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 GtkBoxLayout instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkBoxLayout instance.

    Default Implementation

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

    Declaration

    Swift

    var box_layout_ptr: UnsafeMutablePointer<GtkBoxLayout>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to BoxLayoutProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

BoxLayout Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

BoxLayout Class: BoxLayoutProtocol extension (methods and fields)

  • getBaselinePosition() Extension method

    Gets the value set by gtk_box_layout_set_baseline_position().

    Declaration

    Swift

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

    Returns whether the layout is set to be homogeneous.

    Declaration

    Swift

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

    Returns the space that box_layout puts between children.

    Declaration

    Swift

    @inlinable
func getSpacing() -> Int
    Show on GitHub
  • setBaseline(position:) Extension method

    Sets the baseline position of a box layout.

    The baseline position 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 the given position is used to allocate the baseline within the extra space available.

    Declaration

    Swift

    @inlinable
func setBaseline(position: GtkBaselinePosition)
    Show on GitHub
  • set(homogeneous:) Extension method

    Sets whether the box layout will allocate the same size to all children.

    Declaration

    Swift

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

    Sets how much spacing to put between children.

    Declaration

    Swift

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

    Gets the value set by gtk_box_layout_set_baseline_position().

    Declaration

    Swift

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

    Whether the box layout should distribute the available space equally among the children.

    Declaration

    Swift

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

    The space to put between the children.

    Declaration

    Swift

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