ShortcutLabelProtocol

public protocol ShortcutLabelProtocol : BoxProtocol

GtkShortcutLabel is a widget that represents a single keyboard shortcut or gesture in the user interface.

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

  • ptr

    Untyped pointer to the underlying GtkShortcutLabel instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkShortcutLabel instance.

    Default Implementation

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

    Declaration

    Swift

    var shortcut_label_ptr: UnsafeMutablePointer<GtkShortcutLabel>! { get }
  • Required Initialiser for types conforming to ShortcutLabelProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

ShortcutLabel Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

ShortcutLabel Class: ShortcutLabelProtocol extension (methods and fields)

  • getAccelerator() Extension method

    Retrieves the current accelerator of self.

    Declaration

    Swift

    @inlinable
    func getAccelerator() -> String!
  • getDisabledText() Extension method

    Retrieves the text that is displayed when no accelerator is set.

    Declaration

    Swift

    @inlinable
    func getDisabledText() -> String!
  • set(accelerator:) Extension method

    Sets the accelerator to be displayed by self.

    Declaration

    Swift

    @inlinable
    func set(accelerator: UnsafePointer<gchar>!)
  • set(disabledText:) Extension method

    Sets the text to be displayed by self when no accelerator is set.

    Declaration

    Swift

    @inlinable
    func set(disabledText: UnsafePointer<gchar>!)
  • accelerator Extension method

    The accelerator that self displays. See GtkShortcutsShortcut:accelerator for the accepted syntax.

    Declaration

    Swift

    @inlinable
    var accelerator: String! { get nonmutating set }
  • disabledText Extension method

    Retrieves the text that is displayed when no accelerator is set.

    Declaration

    Swift

    @inlinable
    var disabledText: String! { get nonmutating set }