Skip to content

Gtk.ShortcutTrigger

class — extends GObject.Object

Tracks how a GtkShortcut can be activated.

To find out if a GtkShortcutTrigger triggers, you can call ShortcutTrigger.trigger on a GdkEvent.

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

All GtkShortcutTriggers are immutable, you can only specify their properties during construction. If you want to change a trigger, you have to replace it with a new one.

Constructors

parse_string

@classmethod
def parse_string(cls, string: str) -> ShortcutTrigger | None

Tries to parse the given string into a trigger.

On success, the parsed trigger is returned. When parsing failed, None is returned.

The accepted strings are:

  • never, for GtkNeverTrigger
  • a string parsed by accelerator_parse, for a GtkKeyvalTrigger, e.g. <Control>C
  • underscore, followed by a single character, for GtkMnemonicTrigger, e.g. _l
  • two valid trigger strings, separated by a | character, for a GtkAlternativeTrigger: <Control>q|<Control>w

Note that you will have to escape the < and > characters when specifying triggers in XML files, such as GtkBuilder ui files. Use &lt; instead of < and &gt; instead of >.

Parameters:

  • string — the string to parse

Methods

compare

def compare(self, trigger2: ShortcutTrigger) -> int

The types of trigger1 and trigger2 are gconstpointer only to allow use of this function as a GCompareFunc.

They must each be a GtkShortcutTrigger.

Parameters:

  • trigger2 — a GtkShortcutTrigger

equal

def equal(self, trigger2: ShortcutTrigger) -> bool

Checks if trigger1 and trigger2 trigger under the same conditions.

The types of one and two are gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

Parameters:

  • trigger2 — a GtkShortcutTrigger

hash

def hash(self) -> int

Generates a hash value for a GtkShortcutTrigger.

The output of this function is guaranteed to be the same for a given value only per-process. It may change between different processor architectures or even different versions of GTK. Do not use this function as a basis for building protocols or file formats.

The types of trigger is gconstpointer only to allow use of this function with GHashTable. They must each be a GtkShortcutTrigger.

print

def print(self, string: GLib.String) -> None

Prints the given trigger into a string for the developer. This is meant for debugging and logging.

The form of the representation may change at any time and is not guaranteed to stay identical.

Parameters:

  • string — a GString to print into

print_label

def print_label(self, display: Gdk.Display, string: GLib.String) -> bool

Prints the given trigger into a string.

This function is returning a translated string for presentation to end users for example in menu items or in help texts.

The display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names.

The form of the representation may change at any time and is not guaranteed to stay identical.

Parameters:

  • display — GdkDisplay to print for
  • string — a GString to print into

to_label

def to_label(self, display: Gdk.Display) -> str

Gets textual representation for the given trigger.

This function is returning a translated string for presentation to end users for example in menu items or in help texts.

The display in use may influence the resulting string in various forms, such as resolving hardware keycodes or by causing display-specific modifier names.

The form of the representation may change at any time and is not guaranteed to stay identical.

Parameters:

  • display — GdkDisplay to print for

to_string

def to_string(self) -> str

Prints the given trigger into a human-readable string.

This is a small wrapper around ShortcutTrigger.print to help when debugging.

trigger

def trigger(self, event: Gdk.Event, enable_mnemonics: bool) -> Gdk.KeyMatch

Checks if the given event triggers self.

Parameters:

  • event — the event to check
  • enable_mnemonics — True if mnemonics should trigger. Usually the value of this property is determined by checking that the passed in event is a Key event and has the right modifiers set.