Gtk.ShortcutAction¶

class — extends GObject.Object

Encodes an action that can be triggered by a keyboard shortcut.

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

All GtkShortcutActions are immutable, you can only specify their properties during construction. If you want to change a action, you have to replace it with a new one. If you need to pass arguments to an action, these are specified by the higher-level GtkShortcut object.

To activate a GtkShortcutAction manually, ShortcutAction.activate can be called.

GTK provides various actions:

MnemonicAction: a shortcut action that calls Widget.mnemonic_activate
CallbackAction: a shortcut action that invokes a given callback
SignalAction: a shortcut action that emits a given signal
ActivateAction: a shortcut action that calls Widget.activate
NamedAction: a shortcut action that calls gtk_widget_activate_action()
NothingAction: a shortcut action that does nothing

Constructors¶

parse_string¶

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

Tries to parse the given string into an action.

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

The accepted strings are:

nothing, for GtkNothingAction
activate, for GtkActivateAction
mnemonic-activate, for GtkMnemonicAction
action(NAME), for a GtkNamedAction for the action named NAME
signal(NAME), for a GtkSignalAction for the signal NAME

Parameters:

string — the string to parse

Methods¶

activate¶

def activate(self, flags: ShortcutActionFlags | int, widget: Widget, args: GLib.Variant | None = ...) -> bool

Activates the action on the widget with the given args.

Note that some actions ignore the passed in flags, widget or args.

Activation of an action can fail for various reasons. If the action is not supported by the widget, if the args don't match the action or if the activation otherwise had no effect, False will be returned.

Parameters:

flags — flags to activate with
widget — Target of the activation
args — arguments to pass

print¶

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

Prints the given action 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

to_string¶

def to_string(self) -> str

Prints the given action into a human-readable string.

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