:right-sidebar: True

PreferencesPage
===================================================================

.. currentmodule:: gi.repository.Adw





.. class:: PreferencesPage(**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:

::

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



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

.. rst-class:: interim-class

.. class:: PreferencesPage
   :no-index:


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

      Creates a new ``AdwPreferencesPage``.














Methods
-------

.. rst-class:: interim-class

.. class:: PreferencesPage
   :no-index:


   .. method:: add(group: ~gi.repository.Adw.PreferencesGroup) -> None

      Adds a preferences group to ``self``.







      :param group: the group to add





   .. method:: get_description() -> str

      Gets the description of ``self``.



      .. versionadded:: 1.4








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

      Gets the icon name for ``self``.










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

      Gets the name of ``self``.










   .. method:: get_title() -> str

      Gets the title of ``self``.










   .. method:: get_use_underline() -> bool

      Gets whether an embedded underline in the title indicates a mnemonic.










   .. method:: remove(group: ~gi.repository.Adw.PreferencesGroup) -> None

      Removes a group from ``self``.







      :param group: the group to remove





   .. method:: scroll_to_top() -> None

      Scrolls the scrolled window of ``self`` to the top.



      .. versionadded:: 1.3








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

      Sets the description of ``self``.

      The description is displayed at the top of the page.



      .. versionadded:: 1.4





      :param description: the description





   .. method:: set_icon_name(icon_name: str | None = None) -> None

      Sets the icon name for ``self``.







      :param icon_name: the icon name





   .. method:: set_name(name: str | None = None) -> None

      Sets the name of ``self``.







      :param name: the name





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

      Sets the title of ``self``.







      :param title: the title





   .. method:: set_use_underline(use_underline: bool) -> None

      Sets whether an embedded underline in the title indicates a mnemonic.







      :param use_underline: ``TRUE`` if underlines in the text indicate mnemonics









Properties
----------

.. rst-class:: interim-class

.. class:: PreferencesPage
   :no-index:
   

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

      The description to be displayed at the top of the page.



      .. versionadded:: 1.4





   .. attribute:: props.icon_name
      :type: str

      The icon name for this page.







   .. attribute:: props.name
      :type: str

      The name of this page.







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

      The title for this page.







   .. attribute:: props.use_underline
      :type: bool

      Whether an embedded underline in the title indicates a mnemonic.















Fields
------

.. rst-class:: interim-class

.. class:: PreferencesPage
   :no-index:
   

   .. attribute:: parent_instance