Adw.ShortcutsDialog¶
- Subclasses:
None
Methods¶
- Inherited:
Adw.Dialog (24), Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1)
- Structs:
class |
|
|
Virtual Methods¶
Properties¶
- Inherited:
Signals¶
- Inherited:
Fields¶
- Inherited:
Class Details¶
- class Adw.ShortcutsDialog(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
A dialog that displays application’s keyboard shortcuts.
<picture> <source srcset=”shortcuts-dialog-dark.png” media=”(prefers-color-scheme: dark)”> <img src=”shortcuts-dialog.png” alt=”shortcuts-dialog”> </picture>
Shortcuts are grouped into sections, represented by [class`ShortcutsSection`] objects. Each section has one or more items, represented by [class`ShortcutsItem`] objects.
To add a section to the dialog, use [method`ShortcutsDialog`.add], or add it as a child when using UI files.
Sections without titles can be used to further subdivide each section into groups.
Example of an
AdwShortcutsDialogUI definition:``xml <object class=”AdwShortcutsDialog” id=”shortcuts_dialog”>
- <child>
- <object class=”AdwShortcutsSection”>
<property name=”title” translatable=”yes”>General</property> <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Open Menu</property> <property name=”accelerator”>F10</property>
</object>
</child> <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Quit</property> <property name=”action-name”>app.quit</property>
</object>
</child>
</object>
</child> <child>
- <object class=”AdwShortcutsSection”>
- <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Move Tab Left</property> <property name=”accelerator”><Shift><Ctrl>Page_Up</property> <property name=”direction”>ltr</property>
</object>
</child> <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Move Tab Right</property> <property name=”accelerator”><Shift><Ctrl>Page_Down</property> <property name=”direction”>ltr</property>
</object>
</child> <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Move Tab Right</property> <property name=”accelerator”><Shift><Ctrl>Page_Up</property> <property name=”direction”>rtl</property>
</object>
</child> <child>
- <object class=”AdwShortcutsItem”>
<property name=”title” translatable=”yes”>Move Tab Left</property> <property name=”accelerator”><Shift><Ctrl>Page_Down</property> <property name=”direction”>rtl</property>
</object>
</child>
</object>
</child>
</object> ``
If the
app.quitaction has the <kbd>Ctrl</kbd><kbd>Q</kbd> accelerator associated with it, the result will look as follows:<picture> <source srcset=”shortcuts-dialog-example-dark.png” media=”(prefers-color-scheme: dark)”> <img src=”shortcuts-dialog-example.png” alt=”shortcuts-dialog-example”> </picture>
The recommended way to use
AdwShortcutsDialogis via [class`Application`]’s automatic resource loading.See also: [class`ShortcutLabel`].
New in version 1.8.
- classmethod new()¶
- Returns:
the newly created
AdwShortcutsDialog- Return type:
Creates a new
AdwShortcutsDialog.New in version 1.8.
- add(section)¶
- Parameters:
section (
Adw.ShortcutsSection) – the section to add
Adds section to self.
New in version 1.8.