AlignmentProtocol

public protocol AlignmentProtocol : BinProtocol

The GtkAlignment widget controls the alignment and size of its child widget. It has four settings: xscale, yscale, xalign, and yalign.

The scale settings are used to specify how much the child widget should expand to fill the space allocated to the GtkAlignment. The values can range from 0 (meaning the child doesn’t expand at all) to 1 (meaning the child expands to fill all of the available space).

The align settings are used to place the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). Of course, if the scale settings are both set to 1, the alignment settings have no effect.

GtkAlignment has been deprecated in 3.14 and should not be used in newly-written code. The desired effect can be achieved by using the GtkWidget:halign, GtkWidget:valign and GtkWidget:margin properties on the child widget.

The AlignmentProtocol protocol exposes the methods and properties of an underlying GtkAlignment 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 Alignment. Alternatively, use AlignmentRef as a lighweight, unowned reference if you already have an instance you just want to use.

  • ptr

    Untyped pointer to the underlying GtkAlignment instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • alignment_ptr Default implementation

    Typed pointer to the underlying GtkAlignment instance.

    Default Implementation

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

    Declaration

    Swift

    var alignment_ptr: UnsafeMutablePointer<GtkAlignment>! { get }
  • Required Initialiser for types conforming to AlignmentProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

Alignment Class

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

    Declaration

    Swift

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

  • get(property:) Extension method

    Get the value of a Alignment property

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

Alignment Class: AlignmentProtocol extension (methods and fields)

  • Gets the padding on the different sides of the widget. See gtk_alignment_set_padding ().

    get_padding is deprecated: Use #GtkWidget alignment and margin properties

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func getPadding(paddingTop: UnsafeMutablePointer<guint>! = nil, paddingBottom: UnsafeMutablePointer<guint>! = nil, paddingLeft: UnsafeMutablePointer<guint>! = nil, paddingRight: UnsafeMutablePointer<guint>! = nil)
  • Sets the GtkAlignment values.

    set is deprecated: Use #GtkWidget alignment and margin properties

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func set(xalign: Double, yalign: Double, xscale: Double, yscale: Double)
  • Sets the padding on the different sides of the widget. The padding adds blank space to the sides of the widget. For instance, this can be used to indent the child widget towards the right by adding padding on the left.

    set_padding is deprecated: Use #GtkWidget alignment and margin properties

    Declaration

    Swift

    @available(*, deprecated)
    @inlinable
    func setPadding(paddingTop: Int, paddingBottom: Int, paddingLeft: Int, paddingRight: Int)
  • bin Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
    var bin: GtkBin { get }