Skip to main content

Type Alias: GtkShortcutsShortcutProps

GtkShortcutsShortcutProps = WidgetProps & object

Defined in: generated/jsx.ts:8370

Props for the GtkShortcutsShortcut widget.

Type Declaration

NameTypeDescriptionDefined in
accelerator?stringThe accelerator(s) represented by this object. This property is used if ShortcutsShortcut.shortcut-type is set to %GTK_SHORTCUT_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 &lt;, &gt; and &amp; when used in .ui files.generated/jsx.ts:8406
accelSizeGroup?Gtk.SizeGroupThe size group for the accelerator portion of this shortcut. This is used internally by GTK, and must not be modified by applications.generated/jsx.ts:8376
actionName?stringA detailed action name. If this is set for a shortcut of type %GTK_SHORTCUT_ACCELERATOR, then GTK will use the accelerators that are associated with the action via Application.set_accels_for_action, and setting ShortcutsShortcut.accelerator is not necessary.generated/jsx.ts:8415
direction?Gtk.TextDirectionThe text direction for which this shortcut is active. If the shortcut is used regardless of the text direction, set this property to %GTK_TEXT_DIR_NONE.generated/jsx.ts:8422
icon?Gio.IconAn icon to represent the shortcut or gesture. This property is used if ShortcutsShortcut.shortcut-type is set to %GTK_SHORTCUT_GESTURE. For the other predefined gesture types, GTK provides an icon on its own.generated/jsx.ts:8431
iconSet?boolean%TRUE if an icon has been set.generated/jsx.ts:8433
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:8464
ref?Ref<Gtk.ShortcutsShortcut>-generated/jsx.ts:8481
shortcutType?Gtk.ShortcutTypeThe type of shortcut that is represented.generated/jsx.ts:8435
subtitle?stringThe 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.generated/jsx.ts:8443
subtitleSet?boolean%TRUE if a subtitle has been set.generated/jsx.ts:8445
title?stringThe textual description for the shortcut or gesture represented by this object. This should be a short string that can fit in a single line.generated/jsx.ts:8452
titleSizeGroup?Gtk.SizeGroupThe size group for the textual portion of this shortcut. This is used internally by GTK, and must not be modified by applications.generated/jsx.ts:8458