Gtk.ShortcutsSection

Subclasses:

None

Methods

Inherited:

Gtk.Box (14), Gtk.Widget (183), GObject.Object (37), Gtk.Accessible (17), Gtk.Buildable (1), Gtk.Orientable (2)

Structs:

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

add_group (group)

Virtual Methods

Inherited:

Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties

Inherited:

Gtk.Box (4), Gtk.Widget (35), Gtk.Accessible (1), Gtk.Orientable (1)

Name	Type	Flags	Short Description
max-height	int	r/w/en	deprecated
section-name	str	r/w	deprecated
title	str	r/w	deprecated
view-name	str	r/w/en	deprecated

Signals

Inherited:

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

Name	Short Description
change-current-page	Emitted when we change the current page. deprecated

Fields

Inherited:

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

Class Details

class Gtk.ShortcutsSection(**kwargs)

Bases:

Gtk.Box

Abstract:

No

Structure:

Gtk.ShortcutsSectionClass

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 [property`Gtk`.ShortcutsSection:section-name] and a [property`Gtk`.ShortcutsSection:title] that can be shown in the section selector of the [class`Gtk`.ShortcutsWindow].

The [property`Gtk`.ShortcutsSection: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 [class`Gtk`.ShortcutsWindow].

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

If you need to add a group programmatically, use [method`Gtk`.ShortcutsSection.add_group].

Shortcuts and Gestures

Pan gestures allow to navigate between sections.

The following signals have default keybindings:

• [signal`Gtk`.ShortcutsSection::change-current-page]

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

add_group(group)

Parameters:

group (Gtk.ShortcutsGroup) – the GtkShortcutsGroup to add

Adds a group to the shortcuts section.

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

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

New in version 4.14.

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

Signal Details

Gtk.ShortcutsSection.signals.change_current_page(shortcuts_section, offset)

Signal Name:

change-current-page

Flags:

RUN_LAST, ACTION

Parameters:

• shortcuts_section (Gtk.ShortcutsSection) – The object which received the signal

• offset (int) – the offset

Returns:

whether the page was changed

Return type:

bool

Emitted when we change the current page.

The default bindings for this signal are <kbd>Ctrl</kbd>+<kbd>PgUp</kbd>, <kbd>PgUp</kbd>, <kbd>Ctrl</kbd>+<kbd>PgDn</kbd>, <kbd>PgDn</kbd>.

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

Property Details

Gtk.ShortcutsSection.props.max_height

Name:

max-height

Type:

int

Default Value:

15

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

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

Gtk.ShortcutsSection.props.section_name

Name:

section-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

Setting the [property`Gtk`.ShortcutsWindow: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

Gtk.ShortcutsSection.props.title

Name:

title

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

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

Gtk.ShortcutsSection.props.view_name

Name:

view-name

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE, EXPLICIT_NOTIFY

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

See [property`Gtk`.ShortcutsGroup:view].

Applications are expected to use the [property`Gtk`.ShortcutsWindow:view-name] property for this purpose.

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