OrientableProtocol

public protocol OrientableProtocol

The GtkOrientable interface is implemented by all widgets that can be oriented horizontally or vertically. Historically, such widgets have been realized as subclasses of a common base class (e.g GtkBox/GtkHBox/GtkVBox or GtkScale/GtkHScale/GtkVScale). GtkOrientable is more flexible in that it allows the orientation to be changed at runtime, allowing the widgets to “flip”.

GtkOrientable was introduced in GTK+ 2.16.

The OrientableProtocol protocol exposes the methods and properties of an underlying GtkOrientable 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 Orientable. Alternatively, use OrientableRef 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 GtkOrientable instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkOrientable instance.

    Default Implementation

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

    Declaration

    Swift

    var orientable_ptr: UnsafeMutablePointer<GtkOrientable>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to OrientableProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Orientable Interface

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Orientable Interface: OrientableProtocol extension (methods and fields)

  • getOrientation() Extension method

    Retrieves the orientation of the orientable.

    Declaration

    Swift

    @inlinable
func getOrientation() -> GtkOrientation
    Show on GitHub
  • set(orientation:) Extension method

    Sets the orientation of the orientable.

    Declaration

    Swift

    @inlinable
func set(orientation: GtkOrientation)
    Show on GitHub
  • orientation Extension method

    The orientation of the orientable.

    Declaration

    Swift

    @inlinable
var orientation: GtkOrientation { get nonmutating set }
    Show on GitHub