ShortcutAction

class ShortcutAction(**properties: Any)

Superclasses: Object

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

Constructors:

ShortcutAction(**properties)
parse_string(string:str) -> Gtk.ShortcutAction or None

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.