ShortcutController

Object Hierarchy:

Description:

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

ShortcutController is an event controller that manages shortcuts.

Most common shortcuts are using this controller implicitly, e.g. by adding a mnemonic underline to a Label, or by installing a key binding using add_binding, or by adding accelerators to global actions using set_accels_for_action.

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

ShortcutController implements ListModel 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:

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

This example creates a ActivateAction for triggering the `activate` signal of the GtkButton. See parse_string for the syntax for other kinds of ShortcutAction. See parse_string to learn more about the syntax for triggers.

Namespace: Gtk

Package: gtk4

Content:

Properties:

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 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 have the given mnemonics_modifiers.
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