:right-sidebar: True

PreferencesGroup
===================================================================

.. currentmodule:: gi.repository.Adw





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


Superclasses: :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`



:Constructors:

::

    PreferencesGroup(**properties)
    new() -> Gtk.Widget



Constructors
------------

.. rst-class:: interim-class

.. class:: PreferencesGroup
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.Widget

      Creates a new ``AdwPreferencesGroup``.














Methods
-------

.. rst-class:: interim-class

.. class:: PreferencesGroup
   :no-index:


   .. method:: add(child: ~gi.repository.Gtk.Widget) -> None

      Adds a child to ``self``.







      :param child: the widget to add





   .. method:: get_description() -> str | None

      Gets the description of ``self``.










   .. method:: get_header_suffix() -> ~gi.repository.Gtk.Widget | None

      Gets the suffix for ``self``'s header.



      .. versionadded:: 1.1








   .. method:: get_title() -> str

      Gets the title of ``self``.










   .. method:: remove(child: ~gi.repository.Gtk.Widget) -> None

      Removes a child from ``self``.







      :param child: the child to remove





   .. method:: set_description(description: str | None = None) -> None

      Sets the description for ``self``.







      :param description: the description





   .. method:: set_header_suffix(suffix: ~gi.repository.Gtk.Widget | None = None) -> None

      Sets the suffix for ``self``'s header.

      Displayed above the list, next to the title and description.

      Suffixes are commonly used to show a button or a spinner for the whole group.



      .. versionadded:: 1.1





      :param suffix: the suffix to set





   .. method:: set_title(title: str) -> None

      Sets the title for ``self``.







      :param title: the title









Properties
----------

.. rst-class:: interim-class

.. class:: PreferencesGroup
   :no-index:
   

   .. attribute:: props.description
      :type: str

      The description for this group of preferences.







   .. attribute:: props.header_suffix
      :type: ~gi.repository.Gtk.Widget

      The header suffix widget.

      Displayed above the list, next to the title and description.

      Suffixes are commonly used to show a button or a spinner for the whole
      group.



      .. versionadded:: 1.1





   .. attribute:: props.title
      :type: str

      The title for this group of preferences.















Fields
------

.. rst-class:: interim-class

.. class:: PreferencesGroup
   :no-index:
   

   .. attribute:: parent_instance