A gtk.shortcuts_window.ShortcutsWindow shows information about the keyboard shortcuts and gestures of an application.
The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.
Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.
The recommended way to construct a gtk.shortcuts_window.ShortcutsWindow is with gtk.builder.Builder, by using the <child> tag to populate a gtk.shortcuts_window.ShortcutsWindow with one or more gtk.shortcuts_section.ShortcutsSection objects, which contain one or more gtk.shortcuts_group.ShortcutsGroup instances, which, in turn, contain gtk.shortcuts_shortcut.ShortcutsShortcut instances.
If you need to add a section programmatically, use gtk.shortcuts_window.ShortcutsWindow.addSection instead of gtk.window.Window.setChild, as the shortcuts window manages its children directly.
This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.
The .ui file for this example can be found here.
This example shows a gtk.shortcuts_window.ShortcutsWindow that has been configured to show only the shortcuts relevant to the "stopwatch" view.
This example shows a gtk.shortcuts_window.ShortcutsWindow with two sections, "Editor Shortcuts" and "Terminal Shortcuts".
gtk.shortcuts_window.ShortcutsWindow has a single CSS node with the name window and style class .shortcuts.
A gtk.shortcuts_window.ShortcutsWindow shows information about the keyboard shortcuts and gestures of an application.
The shortcuts can be grouped, and you can have multiple sections in this window, corresponding to the major modes of your application.
Additionally, the shortcuts can be filtered by the current view, to avoid showing information that is not relevant in the current application context.
The recommended way to construct a gtk.shortcuts_window.ShortcutsWindow is with gtk.builder.Builder, by using the <child> tag to populate a gtk.shortcuts_window.ShortcutsWindow with one or more gtk.shortcuts_section.ShortcutsSection objects, which contain one or more gtk.shortcuts_group.ShortcutsGroup instances, which, in turn, contain gtk.shortcuts_shortcut.ShortcutsShortcut instances.
If you need to add a section programmatically, use gtk.shortcuts_window.ShortcutsWindow.addSection instead of gtk.window.Window.setChild, as the shortcuts window manages its children directly.
A simple example:
This example has as single section. As you can see, the shortcut groups are arranged in columns, and spread across several pages if there are too many to find on a single page.
The .ui file for this example can be found here.
An example with multiple views:
This example shows a gtk.shortcuts_window.ShortcutsWindow that has been configured to show only the shortcuts relevant to the "stopwatch" view.
The .ui file for this example can be found here.
An example with multiple sections:
This example shows a gtk.shortcuts_window.ShortcutsWindow with two sections, "Editor Shortcuts" and "Terminal Shortcuts".
The .ui file for this example can be found here.
CSS nodes
gtk.shortcuts_window.ShortcutsWindow has a single CSS node with the name window and style class .shortcuts.