ShortcutsWindowProtocol

public protocol ShortcutsWindowProtocol : WindowProtocol

A GtkShortcutsWindow shows brief information about the keyboard shortcuts and gestures of an application. The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.

Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.

The recommended way to construct a GtkShortcutsWindow is with GtkBuilder, by populating a GtkShortcutsWindow with one or more GtkShortcutsSection objects, which contain GtkShortcutsGroups that in turn contain objects of class GtkShortcutsShortcut.

A simple example:

This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.

The .ui file for this example can be found here.

An example with multiple views:

This example shows a GtkShortcutsWindow that has been configured to show only the shortcuts relevant to the “stopwatch” view.

The .ui file for this example can be found here.

An example with multiple sections:

This example shows a GtkShortcutsWindow with two sections, “Editor Shortcuts” and “Terminal Shortcuts”.

The .ui file for this example can be found here.

The ShortcutsWindowProtocol protocol exposes the methods and properties of an underlying GtkShortcutsWindow 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 ShortcutsWindow. Alternatively, use ShortcutsWindowRef 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 GtkShortcutsWindow instance.

    Declaration

    Swift

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

    Typed pointer to the underlying GtkShortcutsWindow instance.

    Default Implementation

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

    Declaration

    Swift

    var shortcuts_window_ptr: UnsafeMutablePointer<GtkShortcutsWindow>! { get }
    Show on GitHub

  • Required Initialiser for types conforming to ShortcutsWindowProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)
    Show on GitHub

ShortcutsWindow Class

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Declaration

    Swift

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

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

    Show on GitHub

ShortcutsWindow signals

  • Connect a Swift signal handler to the given, typed ShortcutsWindowSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ShortcutsWindowSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    handler

    The Swift signal handler (function or callback) to invoke on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub

  • Connect a C signal handler to the given, typed ShortcutsWindowSignalName signal

    Declaration

    Swift

    @discardableResult
@inlinable
func connect(signal s: ShortcutsWindowSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

    Parameters

    signal

    The signal to connect
    flags

    The connection flags to use
    data

    A pointer to user data to provide to the callback
    destroyData

    A GClosureNotify C function to destroy the data pointed to by userData
    signalHandler

    The C function to be called on the given signal

    Return Value

    The signal handler ID (always greater than 0 for successful connections)

    Show on GitHub
  • onClose(flags:handler:) Extension method

    The close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the window.

    The default binding for this signal is the Escape key.

    Note

    This represents the underlying close signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onClose(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsWindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the close signal is emitted
    Show on GitHub
  • closeSignal Extension method

    Typed close signal for using the connect(signal:) methods

    Declaration

    Swift

    static var closeSignal: ShortcutsWindowSignalName { get }
    Show on GitHub
  • onSearch(flags:handler:) Extension method

    The search signal is a keybinding signal which gets emitted when the user uses a keybinding to start a search.

    The default binding for this signal is Control-F.

    Note

    This represents the underlying search signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onSearch(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsWindowRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    handler

    The signal handler to call Run the given callback whenever the search signal is emitted
    Show on GitHub
  • searchSignal Extension method

    Typed search signal for using the connect(signal:) methods

    Declaration

    Swift

    static var searchSignal: ShortcutsWindowSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::section-name signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifySectionName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsWindowRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifySectionName signal is emitted
    Show on GitHub
  • notifySectionNameSignal Extension method

    Typed notify::section-name signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifySectionNameSignal: ShortcutsWindowSignalName { get }
    Show on GitHub

  • The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

    Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

    This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

    (C Language Example):

    g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

    It is important to note that you must use canonical parameter names as detail strings for the notify signal.

    Note

    This represents the underlying notify::view-name signal

    Declaration

    Swift

    @discardableResult
@inlinable
func onNotifyViewName(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ShortcutsWindowRef, _ pspec: ParamSpecRef) -> Void) -> Int

    Parameters

    flags

    Flags
    unownedSelf

    Reference to instance of self
    pspec

    the GParamSpec of the property which changed.
    handler

    The signal handler to call Run the given callback whenever the notifyViewName signal is emitted
    Show on GitHub
  • notifyViewNameSignal Extension method

    Typed notify::view-name signal for using the connect(signal:) methods

    Declaration

    Swift

    static var notifyViewNameSignal: ShortcutsWindowSignalName { get }
    Show on GitHub

ShortcutsWindow Class: ShortcutsWindowProtocol extension (methods and fields)

  • window Extension method

    Undocumented

    Declaration

    Swift

    @inlinable
var window: GtkWindow { get }
    Show on GitHub