ShortcutControllerRef

public struct ShortcutControllerRef : ShortcutControllerProtocol, GWeakCapturing

GtkShortcutController is an event controller that manages shortcuts.

Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a GtkLabel, or by installing a key binding using [methodGtk.WidgetClass.add_binding], or by adding accelerators to global actions using [methodGtk.Application.set_accels_for_action].

But it is possible to create your own shortcut controller, and add shortcuts to it.

GtkShortcutController implements GListModel for querying the shortcuts that have been added to it.

GtkShortcutController as a GtkBuildable

GtkShortcutControllers can be creates in ui files to set up shortcuts in the same place as the widgets.

An example of a UI definition fragment with GtkShortcutController:

  &lt;object class='GtkButton'&gt;
    &lt;child&gt;
      &lt;object class='GtkShortcutController'&gt;
        &lt;property name='scope'&gt;managed&lt;/property&gt;
        &lt;child&gt;
          &lt;object class='GtkShortcut'&gt;
            &lt;property name='trigger'&gt;&lt;Control&gt;k&lt;/property&gt;
            &lt;property name='action'&gt;activate&lt;/property&gt;
          &lt;/object&gt;
        &lt;/child&gt;
      &lt;/object&gt;
    &lt;/child&gt;
  &lt;/object&gt;

This example creates a [classGtk.ActivateAction] for triggering the activate signal of the GtkButton. See [ctorGtk.ShortcutAction.parse_string] for the syntax for other kinds of GtkShortcutAction. See [ctorGtk.ShortcutTrigger.parse_string] to learn more about the syntax for triggers.

The ShortcutControllerRef type acts as a lightweight Swift reference to an underlying GtkShortcutController instance. It exposes methods that can operate on this data type through ShortcutControllerProtocol conformance. Use ShortcutControllerRef only as an unowned reference to an existing GtkShortcutController instance.

Show on GitHub

ptr
```
Untyped pointer to the underlying `GtkShortcutController` instance.
```
For type-safe access, use the generated, typed pointer shortcut_controller_ptr property instead.
Declaration
Swift

public let ptr: UnsafeMutableRawPointer!
Show on GitHub

ShortcutController Class

init(_:)
Designated initialiser from the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafeMutablePointer<GtkShortcutController>)
Show on GitHub
init(_:)
Designated initialiser from a constant pointer to the underlying C data type
Declaration
Swift

@inlinable init(_ p: UnsafePointer<GtkShortcutController>)
Show on GitHub
init(_:)
Conditional initialiser from an optional pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafeMutablePointer<GtkShortcutController>?)
Show on GitHub
init(_:)
Conditional initialiser from an optional, non-mutable pointer to the underlying C data type
Declaration
Swift

@inlinable init!(_ maybePointer: UnsafePointer<GtkShortcutController>?)
Show on GitHub
init(gpointer:)
Conditional initialiser from an optional gpointer
Declaration
Swift

@inlinable init!(gpointer g: gpointer?)
Show on GitHub
init(gconstpointer:)
Conditional initialiser from an optional, non-mutable gconstpointer
Declaration
Swift

@inlinable init!(gconstpointer g: gconstpointer?)
Show on GitHub
init(_:)
Reference intialiser for a related type that implements ShortcutControllerProtocol
Declaration
Swift

@inlinable init<T>(_ other: T) where T : ShortcutControllerProtocol
Show on GitHub


                    
                    
                    unowned(_:)

This factory is syntactic sugar for setting weak pointers wrapped in GWeak<T>

Declaration

Swift

@inlinable
static func unowned<T>(_ other: T) -> ShortcutControllerRef where T : ShortcutControllerProtocol

Show on GitHub

init(cPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutControllerProtocol.
Declaration
Swift

@inlinable init<T>(cPointer: UnsafeMutablePointer<T>)
Show on GitHub
init(constPointer:)
Unsafe typed initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutControllerProtocol.
Declaration
Swift

@inlinable init<T>(constPointer: UnsafePointer<T>)
Show on GitHub
init(mutating:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutControllerProtocol.
Declaration
Swift

@inlinable init(mutating raw: UnsafeRawPointer)
Show on GitHub
init(raw:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutControllerProtocol.
Declaration
Swift

@inlinable init(raw: UnsafeMutableRawPointer)
Show on GitHub
init(opaquePointer:)
Unsafe untyped initialiser. Do not use unless you know the underlying data type the pointer points to conforms to ShortcutControllerProtocol.
Declaration
Swift

@inlinable init(opaquePointer: OpaquePointer)
Show on GitHub
init()
Creates a new shortcut controller.
Declaration
Swift

@inlinable init()
Show on GitHub
init(model:)
Creates a new shortcut controller that takes its shortcuts from the given list model.

A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model.
Declaration
Swift

@inlinable init<ListModelT>(model: ListModelT) where ListModelT : ListModelProtocol
Show on GitHub
newFor(model:)
Creates a new shortcut controller that takes its shortcuts from the given list model.

A controller created by this function does not let you add or remove individual shortcuts using the shortcut controller api, but you can change the contents of the model.
Declaration
Swift

@inlinable static func newFor<ListModelT>(model: ListModelT) -> EventControllerRef! where ListModelT : ListModelProtocol
Show on GitHub