ShortcutTrigger

open class ShortcutTrigger : GLibObject.Object, ShortcutTriggerProtocol

GtkShortcutTrigger tracks how a GtkShortcut should be activated.

To find out if a GtkShortcutTrigger triggers, you can call [methodGtk.ShortcutTrigger.trigger] on a GdkEvent.

GtkShortcutTriggers contain functions that allow easy presentation to end users as well as being printed for debugging.

All GtkShortcutTriggers are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one.

The ShortcutTrigger type acts as a reference-counted owner of an underlying GtkShortcutTrigger instance. It provides the methods that can operate on this data type through ShortcutTriggerProtocol conformance. Use ShortcutTrigger as a strong reference or owner of a GtkShortcutTrigger instance.

Show on GitHub 
  • Designated initialiser from the underlying `C` data type.

    This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafeMutablePointer<GtkShortcutTrigger>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
public init(_ op: UnsafePointer<GtkShortcutTrigger>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
override public init!(gpointer op: gpointer?)

    Parameters

    op

    gpointer to the underlying object
    Show on GitHub

  • Optional initialiser from a non-mutating gconstpointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
override public init!(gconstpointer op: gconstpointer?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from a constant pointer to the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafePointer<GtkShortcutTrigger>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Optional initialiser from the underlying C data type. This creates an instance without performing an unbalanced retain i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
public init!(_ op: UnsafeMutablePointer<GtkShortcutTrigger>?)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Designated initialiser from the underlying C data type. Will retain GtkShortcutTrigger. i.e., ownership is transferred to the ShortcutTrigger instance.

    Declaration

    Swift

    @inlinable
public init(retaining op: UnsafeMutablePointer<GtkShortcutTrigger>)

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements ShortcutTriggerProtocol Will retain GtkShortcutTrigger.

    Declaration

    Swift

    @inlinable
public init<T>(shortcutTrigger other: T) where T : ShortcutTriggerProtocol

    Parameters

    other

    an instance of a related type that implements ShortcutTriggerProtocol
    Show on GitHub

  • Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(cPointer p: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe typed, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init<T>(retainingCPointer cPointer: UnsafeMutablePointer<T>)

    Parameters

    cPointer

    pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init(raw p: UnsafeRawPointer)

    Parameters

    p

    raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingRaw raw: UnsafeRawPointer)
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
public required init(raw p: UnsafeMutableRawPointer)

    Parameters

    p

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
required public init(retainingRaw raw: UnsafeMutableRawPointer)

    Parameters

    raw

    mutable raw pointer to the underlying object
    Show on GitHub

  • Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init(opaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Unsafe untyped, retaining initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutTriggerProtocol.

    Declaration

    Swift

    @inlinable
override public init(retainingOpaquePointer p: OpaquePointer)

    Parameters

    p

    opaque pointer to the underlying object
    Show on GitHub

  • Tries to parse the given string into a trigger.

    On success, the parsed trigger is returned. When parsing failed, nil is returned.

    The accepted strings are:

    • never, for GtkNeverTrigger
    • a string parsed by gtk_accelerator_parse(), for a GtkKeyvalTrigger, e.g. &lt;Control&gt;C
    • underscore, followed by a single character, for GtkMnemonicTrigger, e.g. _l
    • two valid trigger strings, separated by a | character, for a GtkAlternativeTrigger: &lt;Control&gt;q|&lt;Control&gt;w

    Note that you will have to escape the &lt; and &gt; characters when specifying triggers in XML files, such as GtkBuilder ui files. Use &lt; instead of &lt; and &gt; instead of &gt;.

    Declaration

    Swift

    @inlinable
public init(string: UnsafePointer<CChar>!)
    Show on GitHub

  • Tries to parse the given string into a trigger.

    On success, the parsed trigger is returned. When parsing failed, nil is returned.

    The accepted strings are:

    • never, for GtkNeverTrigger
    • a string parsed by gtk_accelerator_parse(), for a GtkKeyvalTrigger, e.g. &lt;Control&gt;C
    • underscore, followed by a single character, for GtkMnemonicTrigger, e.g. _l
    • two valid trigger strings, separated by a | character, for a GtkAlternativeTrigger: &lt;Control&gt;q|&lt;Control&gt;w

    Note that you will have to escape the &lt; and &gt; characters when specifying triggers in XML files, such as GtkBuilder ui files. Use &lt; instead of &lt; and &gt; instead of &gt;.

    Declaration

    Swift

    @inlinable
public static func parse(string: UnsafePointer<CChar>!) -> ShortcutTrigger!
    Show on GitHub