ShortcutController

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_shortcut_controller_get_type ()" ) ]
public sealed class ShortcutController : EventController, ListModel, Buildable

Manages keyboard shortcuts and their activation.

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

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

`GtkShortcutController` implements [iface@Gio.ListModel] for querying the shortcuts that have been added to it.

GtkShortcutController as GtkBuildable

`GtkShortcutController`s can be created in [class@Gtk.Builder] ui files, to set up shortcuts in the same place as the widgets.

An example of a UI definition fragment with `GtkShortcutController`: ```xml <object class='GtkButton'> <child> <object class='GtkShortcutController'> <property name='scope'>managed</property> <child> <object class='GtkShortcut'> <property name='trigger'><Control>k</property> <property name='action'>activate</property> </object > </child> </object> </child> </object> ```

This example creates a [class@Gtk.ActivateAction] for triggering the `activate` signal of the [class@Gtk.Button]. See [ ctor@Gtk.ShortcutAction.parse_string] for the syntax for other kinds of [class@Gtk.ShortcutAction]. See [ctor@Gtk.ShortcutTrigger.parse_string] to learn more about the syntax for triggers.

Namespace: Gtk

Package: gtk4

Content:

Properties:

public Type item_type { get; }
The type of items.
public ModifierType mnemonic_modifiers { get; set; }
The modifiers that need to be pressed to allow mnemonics activation.
public ListModel model { construct; }
A list model to take shortcuts from.
public uint n_items { get; }
The number of items.
public ShortcutScope scope { get; set; }
What scope the shortcuts will be handled in.

Creation methods:

public ShortcutController ()
Creates a new shortcut controller.
public ShortcutController.for_model (ListModel model)
Creates a new shortcut controller that takes its shortcuts from the given list model.

Methods:

public void add_shortcut (owned Shortcut shortcut)
Adds shortcut to the list of shortcuts handled by this.
public ModifierType get_mnemonics_modifiers ()
Gets the mnemonics modifiers for when this controller activates its shortcuts.
public ShortcutScope get_scope ()
Gets the scope for when this controller activates its shortcuts.
public void remove_shortcut (Shortcut shortcut)
Removes shortcut from the list of shortcuts handled by this.
public void set_mnemonics_modifiers (ModifierType modifiers)
Sets the controller to use the given modifier for mnemonics.
public void set_scope (ShortcutScope scope)
Sets the controller to have the given scope.

Inherited Members:

All known members inherited from class Gtk.EventController

All known members inherited from class GLib.Object

All known members inherited from interface GLib.ListModel

items_changed

All known members inherited from interface Gtk.Buildable