ArrowProtocol

public protocol ArrowProtocol : MiscProtocol

GtkArrow should be used to draw simple arrows that need to point in one of the four cardinal directions (up, down, left, or right). The style of the arrow can be one of shadow in, shadow out, etched in, or etched out. Note that these directions and style types may be amended in versions of GTK+ to come.

GtkArrow will fill any space alloted to it, but since it is inherited from GtkMisc, it can be padded and/or aligned, to fill exactly the space the programmer desires.

Arrows are created with a call to gtk_arrow_new(). The direction or style of an arrow can be changed after creation by using gtk_arrow_set().

GtkArrow has been deprecated; you can simply use a GtkImage with a suitable icon name, such as “pan-down-symbolic“. When replacing GtkArrow by an image, pay attention to the fact that GtkArrow is doing automatic flipping between GTK_ARROW_LEFT and GTK_ARROW_RIGHT, depending on the text direction. To get the same effect with an image, use the icon names “pan-start-symbolic“ and “pan-end-symbolic“, which react to the text direction.

The ArrowProtocol protocol exposes the methods and properties of an underlying GtkArrow 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 Arrow. Alternatively, use ArrowRef 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 GtkArrow instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkArrow instance.

    Default Implementation

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

    Declaration

    Swift

    var arrow_ptr: UnsafeMutablePointer<GtkArrow>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ArrowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

Arrow Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

Arrow Class: ArrowProtocol extension (methods and fields)

  • set(arrowType:shadowType:) Extension method

    Sets the direction and style of the GtkArrow, arrow.

    set is deprecated: Use a #GtkImage with a suitable icon.

    Declaration

    Swift

    @available(*, deprecated)
@inlinable
func set(arrowType: GtkArrowType, shadowType: GtkShadowType)
    Show on GitHub
  • misc Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var misc: GtkMisc { get }
    Show on GitHub