ShortcutsSection

Deprecated since version 4.18: This widget will be removed in GTK 5

class ShortcutsSection(**properties: Any)

Superclasses: Box, Widget, InitiallyUnowned, Object

Implemented Interfaces: Accessible, Buildable, ConstraintTarget, Orientable

A GtkShortcutsSection collects all the keyboard shortcuts and gestures for a major application mode.

If your application needs multiple sections, you should give each section a unique section_name and a title that can be shown in the section selector of the ShortcutsWindow.

The max_height property can be used to influence how the groups in the section are distributed over pages and columns.

This widget is only meant to be used with ShortcutsWindow.

The recommended way to construct a GtkShortcutsSection is with Builder, by using the <child> tag to populate a GtkShortcutsSection with one or more ShortcutsGroup instances, which in turn contain one or more ShortcutsShortcut objects.

If you need to add a group programmatically, use add_group.

Shortcuts and Gestures

Pan gestures allow to navigate between sections.

The following signals have default keybindings:

• change_current_page

Methods

class ShortcutsSection

add_group(group: ShortcutsGroup) → None

Adds a group to the shortcuts section.

This is the programmatic equivalent to using Builder and a <child> tag to add the child.

Adding children with the GtkBox API is not appropriate, as GtkShortcutsSection manages its children internally.

Added in version 4.14.

Deprecated since version 4.18: This widget will be removed in GTK 5

Parameters:

group – the GtkShortcutsGroup to add

Properties

class ShortcutsSection

props.max_height: int

The maximum number of lines to allow per column.

This property can be used to influence how the groups in this section are distributed across pages and columns. The default value of 15 should work in most cases.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.section_name: str

A unique name to identify this section among the sections added to the GtkShortcutsWindow.

Setting the section_name property to this string will make this section shown in the GtkShortcutsWindow.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.title: str

The string to show in the section selector of the GtkShortcutsWindow for this section.

If there is only one section, you don’t need to set a title, since the section selector will not be shown in this case.

Deprecated since version 4.18: This widget will be removed in GTK 5

props.view_name: str

A view name to filter the groups in this section by.

See view.

Applications are expected to use the view_name property for this purpose.

Deprecated since version 4.18: This widget will be removed in GTK 5

Signals

class ShortcutsSection.signals

change_current_page(offset: int) → bool

Emitted when we change the current page.

The default bindings for this signal are Ctrl+:kbd:PgUp, PgUp, Ctrl+:kbd:PgDn, PgDn.

Deprecated since version 4.18: This widget will be removed in GTK 5

Parameters:

offset – the offset