Class

GtkShortcutsSection

Description [src]

final class Gtk.ShortcutsSection : Gtk.Box
  implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Orientable {
  /* No available fields */
}

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 GtkShortcutsSection:section-name and a GtkShortcutsSection:title that can be shown in the section selector of the GtkShortcutsWindow.

The GtkShortcutsSection: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 GtkShortcutsWindow.

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

If you need to add a group programmatically, use gtk_shortcuts_section_add_group().

Shortcuts and Gestures

Pan gestures allow to navigate between sections.

The following signals have default keybindings:

Hierarchy

hierarchy this GtkShortcutsSection implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkOrientable this--implements_3 ancestor_0 GtkBox ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

Instance methods

gtk_shortcuts_section_add_group

Adds a group to the shortcuts section.

since: 4.14

Methods inherited from GtkBox (13)
gtk_box_append

Adds child as the last child to box.

gtk_box_get_baseline_child

Gets the value set by gtk_box_set_baseline_child().

since: 4.12

gtk_box_get_baseline_position

Gets the value set by gtk_box_set_baseline_position().

gtk_box_get_homogeneous

Returns whether the box is homogeneous (all children are the same size).

gtk_box_get_spacing

Gets the value set by gtk_box_set_spacing().

gtk_box_insert_child_after

Inserts child in the position after sibling in the list of box children.

gtk_box_prepend

Adds child as the first child to box.

gtk_box_remove

Removes a child widget from box.

gtk_box_reorder_child_after

Moves child to the position after sibling in the list of box children.

gtk_box_set_baseline_child

Sets the baseline child of a box.

since: 4.12

gtk_box_set_baseline_position

Sets the baseline position of a box.

gtk_box_set_homogeneous

Sets whether or not all children of box are given equal space in the box.

gtk_box_set_spacing

Sets the number of pixels to place between children of box.

Methods inherited from GtkWidget (162)

Please see GtkWidget for a full list of methods.

Methods inherited from GObject (43)

Please see GObject for a full list of methods.

Methods inherited from GtkAccessible (19)
gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

since: 4.14

gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

gtk_accessible_reset_state

Resets the accessible state to its default value.

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

gtk_accessible_update_property_value

Updates an array of accessible properties.

gtk_accessible_update_relation

Updates a list of accessible relations.

gtk_accessible_update_relation_value

Updates an array of accessible relations.

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

gtk_accessible_update_state_value

Updates an array of accessible states.

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

Methods inherited from GtkOrientable (2)
gtk_orientable_get_orientation

Retrieves the orientation of the orientable.

gtk_orientable_set_orientation

Sets the orientation of the orientable.

Properties

Gtk.ShortcutsSection:max-height

The maximum number of lines to allow per column.

Gtk.ShortcutsSection:section-name

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

Gtk.ShortcutsSection:title

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

Gtk.ShortcutsSection:view-name

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

Properties inherited from GtkBox (4)
Gtk.Box:baseline-child

The child that determines the baseline, in vertical orientation.

since: 4.12

Gtk.Box:baseline-position

The position of the baseline aligned widgets if extra space is available.

Gtk.Box:homogeneous

Whether the children should all be the same size.

Gtk.Box:spacing

The amount of space between children.

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

Gtk.Widget:can-target

Whether the widget can receive pointer events.

Gtk.Widget:css-classes

A list of css classes applied to this widget.

Gtk.Widget:css-name

The name of this widget in the CSS tree.

Gtk.Widget:cursor

The cursor used by widget.

Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

Gtk.Widget:has-default

Whether the widget is the default widget.

Gtk.Widget:has-focus

Whether the widget has the input focus.

Gtk.Widget:has-tooltip

Enables or disables the emission of the GtkWidget::query-tooltip signal on widget.

Gtk.Widget:height-request

Overrides for height request of the widget.

Gtk.Widget:hexpand

Whether to expand horizontally.

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

Gtk.Widget:layout-manager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

Gtk.Widget:margin-top

Margin on top side of widget.

Gtk.Widget:name

The name of the widget.

Gtk.Widget:opacity

The requested opacity of the widget.

Gtk.Widget:overflow

How content outside the widget’s content area is treated.

Gtk.Widget:parent

The parent widget of this widget.

Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

Gtk.Widget:scale-factor

The scale factor of the widget.

Gtk.Widget:sensitive

Whether the widget responds to input.

Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

Gtk.Widget:vexpand

Whether to expand vertically.

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

Gtk.Widget:visible

Whether the widget is visible.

Gtk.Widget:width-request

Overrides for width request of the widget.

Properties inherited from GtkAccessible (1)
GtkAccessible:accessible-role

The accessible role of the given GtkAccessible implementation.

Properties inherited from GtkOrientable (1)
GtkOrientable:orientation

The orientation of the orientable.

Signals

Gtk.ShortcutsSection::change-current-page

Emitted when we change the current page.

Signals inherited from GtkWidget (13)
GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

GtkWidget::hide

Emitted when widget is hidden.

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

GtkWidget::map

Emitted when widget is going to be mapped.

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

GtkWidget::move-focus

Emitted when the focus is moved.

GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

GtkWidget::show

Emitted when widget is shown.

GtkWidget::state-flags-changed

Emitted when the widget state changes.

GtkWidget::unmap

Emitted when widget is going to be unmapped.

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

Signals inherited from GObject (1)
GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Class structure

struct GtkShortcutsSectionClass {
  /* no available fields */
}

No description available.