ShortcutsShortcut

Deprecated since version 4.18: This widget will be removed in GTK 5

class ShortcutsShortcut(**properties: Any)

Superclasses: Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget

A GtkShortcutsShortcut represents a single keyboard shortcut or gesture with a short text.

This widget is only meant to be used with GtkShortcutsWindow.

Properties

class ShortcutsShortcut

props.accel_size_group: SizeGroup

The size group for the accelerator portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.accelerator: str

The accelerator(s) represented by this object.

This property is used if shortcut_type is set to ACCELERATOR.

The syntax of this property is (an extension of) the syntax understood by accelerator_parse. Multiple accelerators can be specified by separating them with a space, but keep in mind that the available width is limited.

It is also possible to specify ranges of shortcuts, using ... between the keys. Sequences of keys can be specified using a + or & between the keys.

Examples:

• A single shortcut: <ctl><alt>delete

• Two alternative shortcuts: <shift>a Home

• A range of shortcuts: <alt>1...<alt>9

• Several keys pressed together: Control_L&Control_R

• A sequence of shortcuts or keys: <ctl>c+<ctl>x

Use “+” instead of “&” when the keys may (or have to be) pressed sequentially (e.g use “t+t” for ‘press the t key twice’).

Note that <, > and & need to be escaped as <, &gt; and &amp; when used in .ui files.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.action_name: str

A detailed action name.

If this is set for a shortcut of type ACCELERATOR, then GTK will use the accelerators that are associated with the action via set_accels_for_action, and setting accelerator is not necessary.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.direction: TextDirection

The text direction for which this shortcut is active.

If the shortcut is used regardless of the text direction, set this property to NONE.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.icon: Icon

An icon to represent the shortcut or gesture.

This property is used if shortcut_type is set to GESTURE.

For the other predefined gesture types, GTK provides an icon on its own.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.icon_set: bool

True if an icon has been set.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.shortcut_type: ShortcutType

The type of shortcut that is represented.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.subtitle: str

The subtitle for the shortcut or gesture.

This is typically used for gestures and should be a short, one-line text that describes the gesture itself. For the predefined gesture types, GTK provides a subtitle on its own.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.subtitle_set: bool

True if a subtitle has been set.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.title: str

The textual description for the shortcut or gesture represented by this object.

This should be a short string that can fit in a single line.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.title_size_group: SizeGroup

The size group for the textual portion of this shortcut.

This is used internally by GTK, and must not be modified by applications.

Deprecated since version 4.18: This widget will be removed in GTK 5