ShortcutAction

class ShortcutAction(**properties: Any)

Superclasses: Object

Subclasses: ActivateAction, CallbackAction, MnemonicAction, NamedAction, NothingAction, SignalAction

GtkShortcutAction 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, activate can be called.

GTK provides various actions:

• MnemonicAction: a shortcut action that calls

  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

  activate()

• NamedAction: a shortcut action that calls

  activate_action()

• NothingAction: a shortcut action that does nothing

Constructors

class ShortcutAction

classmethod parse_string(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

class ShortcutAction

activate(flags: ShortcutActionFlags, widget: Widget, args: Variant | None = 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_(string: String) → None

Parameters:

string

to_string() → str

Prints the given action into a human-readable string.

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