:right-sidebar: True

ShortcutsSection
===================================================================

.. currentmodule:: gi.repository.Gtk





.. class:: ShortcutsSection(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.Gtk.Box`, :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.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 :obj:`~gi.repository.Gtk.ShortcutsSection.props.section_name` and
a :obj:`~gi.repository.Gtk.ShortcutsSection.props.title` that can be shown in the
section selector of the :obj:`~gi.repository.Gtk.ShortcutsWindow`.

The :obj:`~gi.repository.Gtk.ShortcutsSection.props.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 :obj:`~gi.repository.Gtk.ShortcutsWindow`.

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

If you need to add a group programmatically, use
:obj:`~gi.repository.Gtk.ShortcutsSection.add_group`.





Methods
-------

.. rst-class:: interim-class

.. class:: ShortcutsSection
   :no-index:


   .. method:: add_group(group: ~gi.repository.Gtk.ShortcutsGroup) -> None

      Adds a group to the shortcuts section.

      This is the programmatic equivalent to using :obj:`~gi.repository.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.



      .. versionadded:: 4.14





      :param group: the ``GtkShortcutsGroup`` to add









Properties
----------

.. rst-class:: interim-class

.. class:: ShortcutsSection
   :no-index:
   

   .. attribute:: props.max_height
      :type: 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.







   .. attribute:: props.section_name
      :type: str

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

      Setting the :obj:`~gi.repository.Gtk.ShortcutsWindow.props.section_name` property
      to this string will make this section shown in the ``GtkShortcutsWindow``.







   .. attribute:: props.title
      :type: 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.







   .. attribute:: props.view_name
      :type: str

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

      See :obj:`~gi.repository.Gtk.ShortcutsGroup.props.view`.

      Applications are expected to use the
      :obj:`~gi.repository.Gtk.ShortcutsWindow.props.view_name` property
      for this purpose.











Signals
-------

.. rst-class:: interim-class

.. class:: ShortcutsSection.signals
   :no-index:
   

   .. method:: change_current_page(object: int) -> bool

      






      :param object: