:right-sidebar: True

PreferencesRow
===================================================================

.. currentmodule:: gi.repository.Adw





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


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


Subclasses: :class:`~gi.repository.Adw.ActionRow`, :class:`~gi.repository.Adw.ButtonRow`, :class:`~gi.repository.Adw.EntryRow`, :class:`~gi.repository.Adw.ExpanderRow`


Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.Actionable`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`



A :obj:`~gi.repository.Gtk.ListBoxRow` used to present preferences.

The ``AdwPreferencesRow`` widget has a title that :obj:`~gi.repository.Adw.PreferencesDialog`
will use to let the user look for a preference. It doesn't present the title
in any way and lets you present the preference as you please.

:obj:`~gi.repository.Adw.ActionRow` and its derivatives are convenient to use as preference
rows as they take care of presenting the preference's title while letting you
compose the inputs of the preference around it.


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

.. rst-class:: interim-class

.. class:: PreferencesRow
   :no-index:


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

      Creates a new ``AdwPreferencesRow``\.













Methods
-------

.. rst-class:: interim-class

.. class:: PreferencesRow
   :no-index:


   .. method:: get_title() -> str

      Gets the title of the preference represented by ``self``\.









   .. method:: get_title_selectable() -> bool

      Gets whether the user can copy the title from the label


      .. versionadded:: 1.1








   .. method:: get_use_markup() -> bool

      Gets whether to use Pango markup for the title label.


      .. versionadded:: 1.2








   .. method:: get_use_underline() -> bool

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









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

      Sets the title of the preference represented by ``self``\.

      The title is interpreted as Pango markup unless
      :obj:`~gi.repository.Adw.PreferencesRow.props.use_markup` is set to ``FALSE``\.






      :param title: the title




   .. method:: set_title_selectable(title_selectable: bool) -> None

      Sets whether the user can copy the title from the label

      See also :obj:`~gi.repository.Gtk.Label.props.selectable`\.


      .. versionadded:: 1.1





      :param title_selectable: ``TRUE`` if the user can copy the title from the label




   .. method:: set_use_markup(use_markup: bool) -> None

      Sets whether to use Pango markup for the title label.

      Subclasses may also use it for other labels, such as subtitle.

      See also :obj:`~gi.repository.Pango.parse_markup`\.


      .. versionadded:: 1.2





      :param use_markup: whether to use markup




   .. 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:: PreferencesRow
   :no-index:
   

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

      The type of the None singleton.







   .. attribute:: props.title_selectable
      :type: bool

      The type of the None singleton.



      .. versionadded:: 1.1





   .. attribute:: props.use_markup
      :type: bool

      The type of the None singleton.



      .. versionadded:: 1.2





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

      The type of the None singleton.















Fields
------

.. rst-class:: interim-class

.. class:: PreferencesRow
   :no-index:
   

   .. attribute:: parent_instance