Gtk.ShortcutsWindow

Example

Subclasses:

None

Methods

Inherited:

Gtk.Window (62), Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (16), Gtk.Buildable (1), Gtk.Native (6), Gtk.Root (3)

Structs:

Gtk.WidgetClass (18), GObject.ObjectClass (5)

add_section (section)

Virtual Methods

Inherited:

Gtk.Window (5), Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9), Gtk.ShortcutManager (2)

Properties

Inherited:

Gtk.Window (25), Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags	Short Description
section-name	str	r/w
view-name	str	r/w

Signals

Inherited:

Gtk.Window (5), Gtk.Widget (13), GObject.Object (1)

Name	Short Description
close	Emitted when the user uses a keybinding to close the window.
search	Emitted when the user uses a keybinding to start a search.

Fields

Inherited:

Gtk.Window (5), Gtk.Widget (13), GObject.Object (1)

Class Details

class Gtk.ShortcutsWindow(*args, **kwargs)

Bases:

Gtk.Window

Abstract:

No

A GtkShortcutsWindow 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 GtkShortcutsWindow is with [class`Gtk`.Builder], by using the <child> tag to populate a GtkShortcutsWindow with one or more [class`Gtk`.ShortcutsSection] objects, which contain one or more [class`Gtk`.ShortcutsGroup] instances, which, in turn, contain [class`Gtk`.ShortcutsShortcut] instances.

If you need to add a section programmatically, use [method`Gtk`.ShortcutsWindow.add_section] instead of [method`Gtk`.Window.set_child], 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 GtkShortcutsWindow 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 GtkShortcutsWindow with two sections, “Editor Shortcuts” and “Terminal Shortcuts”.

The .ui file for this example can be found here.

Shortcuts and Gestures

The following signals have default keybindings:

• [signal`Gtk`.ShortcutsWindow::close]

• [signal`Gtk`.ShortcutsWindow::search]

CSS nodes

GtkShortcutsWindow has a single CSS node with the name window and style class .shortcuts.

add_section(section)

Parameters:

section (Gtk.ShortcutsSection) – the GtkShortcutsSection to add

Adds a section to the shortcuts window.

This is the programmatic equivalent to using [class`Gtk`.Builder] and a <child> tag to add the child.

Using [method`Gtk`.Window.set_child] is not appropriate as the shortcuts window manages its children internally.

New in version 4.14.

Signal Details

Gtk.ShortcutsWindow.signals.close(shortcuts_window)

Signal Name:

close

Flags:

RUN_LAST, ACTION

Parameters:

shortcuts_window (Gtk.ShortcutsWindow) – The object which received the signal

Emitted when the user uses a keybinding to close the window.

This is a keybinding signal.

The default binding for this signal is the <kbd>Escape</kbd> key.

Gtk.ShortcutsWindow.signals.search(shortcuts_window)

Signal Name:

search

Flags:

RUN_LAST, ACTION

Parameters:

shortcuts_window (Gtk.ShortcutsWindow) – The object which received the signal

Emitted when the user uses a keybinding to start a search.

This is a keybinding signal.

The default binding for this signal is <kbd>Control</kbd>+<kbd>F</kbd>.

Property Details

Gtk.ShortcutsWindow.props.section_name

Name:

section-name

Type:

str

Default Value:

'internal-search'

Flags:

READABLE, WRITABLE

The name of the section to show.

This should be the section-name of one of the GtkShortcutsSection objects that are in this shortcuts window.

Gtk.ShortcutsWindow.props.view_name

Name:

view-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The view name by which to filter the contents.

This should correspond to the [property`Gtk`.ShortcutsGroup:view] property of some of the [class`Gtk`.ShortcutsGroup] objects that are inside this shortcuts window.

Set this to None to show all groups.