Variable: AdwShortcutsDialog

const AdwShortcutsDialog: "AdwShortcutsDialog"

Defined in: generated/jsx.ts:19342

A dialog that displays application's keyboard shortcuts.

shortcuts-dialog

Shortcuts are grouped into sections, represented by ShortcutsSection objects. Each section has one or more items, represented by ShortcutsItem objects.

To add a section to the dialog, use 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 AdwShortcutsDialog UI definition:

<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">&lt;Shift&gt;&lt;Ctrl&gt;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">&lt;Shift&gt;&lt;Ctrl&gt;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">&lt;Shift&gt;&lt;Ctrl&gt;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">&lt;Shift&gt;&lt;Ctrl&gt;Page_Down</property>
          <property name="direction">rtl</property>
        </object>
      </child>
    </object>
  </child>
</object>

If the app.quit action has the Ctrl``Q accelerator associated with it, the result will look as follows:

shortcuts-dialog-example

The recommended way to use AdwShortcutsDialog is via Application's automatic resource loading.