ShortcutAction

open class ShortcutAction : GLibObject.Object, ShortcutActionProtocol

GtkShortcutAction encodes an action that can be triggered by a keyboard shortcut.

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

All GtkShortcutActions are immutable, you can only specify their properties during construction. If you want to change a action, you have to replace it with a new one. If you need to pass arguments to an action, these are specified by the higher-level GtkShortcut object.

To activate a GtkShortcutAction manually, [methodGtk.ShortcutAction.activate] can be called.

GTK provides various actions:

  • [classGtk.MnemonicAction]: a shortcut action that calls gtk_widget_mnemonic_activate()
  • [classGtk.CallbackAction]: a shortcut action that invokes a given callback
  • [classGtk.SignalAction]: a shortcut action that emits a given signal
  • [classGtk.ActivateAction]: a shortcut action that calls gtk_widget_activate()
  • [classGtk.NamedAction]: a shortcut action that calls gtk_widget_activate_action()
  • [classGtk.NothingAction]: a shortcut action that does nothing

The ShortcutAction type acts as a reference-counted owner of an underlying GtkShortcutAction instance. It provides the methods that can operate on this data type through ShortcutActionProtocol conformance. Use ShortcutAction as a strong reference or owner of a GtkShortcutAction 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 ShortcutAction instance.

    Declaration

    Swift

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

    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 ShortcutAction instance.

    Declaration

    Swift

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

    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 ShortcutAction 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 ShortcutAction 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 ShortcutAction instance.

    Declaration

    Swift

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

    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 ShortcutAction instance.

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

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

    Declaration

    Swift

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

    Parameters

    op

    pointer to the underlying object
    Show on GitHub

  • Reference intialiser for a related type that implements ShortcutActionProtocol Will retain GtkShortcutAction.

    Declaration

    Swift

    @inlinable
public init<T>(shortcutAction other: T) where T : ShortcutActionProtocol

    Parameters

    other

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

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

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 ShortcutActionProtocol.

    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 an action.

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

    The accepted strings are:

    • nothing, for GtkNothingAction
    • activate, for GtkActivateAction
    • mnemonic-activate, for GtkMnemonicAction
    • action(NAME), for a GtkNamedAction for the action named NAME
    • signal(NAME), for a GtkSignalAction for the signal NAME

    Declaration

    Swift

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

  • Tries to parse the given string into an action.

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

    The accepted strings are:

    • nothing, for GtkNothingAction
    • activate, for GtkActivateAction
    • mnemonic-activate, for GtkMnemonicAction
    • action(NAME), for a GtkNamedAction for the action named NAME
    • signal(NAME), for a GtkSignalAction for the signal NAME

    Declaration

    Swift

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