PreferencesRow

class PreferencesRow(**properties: Any)

Superclasses: ListBoxRow, Widget, InitiallyUnowned, Object

Subclasses: ActionRow, EntryRow, ExpanderRow

Implemented Interfaces: Accessible, Actionable, Buildable, ConstraintTarget

A ListBoxRow used to present preferences.

The AdwPreferencesRow widget has a title that 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.

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

class PreferencesRow
classmethod new() Widget

Creates a new AdwPreferencesRow.

Methods

class PreferencesRow
get_title() str

Gets the title of the preference represented by self.

get_title_selectable() bool

Gets whether the user can copy the title from the label

Added in version 1.1.

get_use_markup() bool

Gets whether to use Pango markup for the title label.

Added in version 1.2.

get_use_underline() bool

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

set_title(title: str) None

Sets the title of the preference represented by self.

The title is interpreted as Pango markup unless use_markup is set to FALSE.

Parameters:

title – the title

set_title_selectable(title_selectable: bool) None

Sets whether the user can copy the title from the label

See also selectable.

Added in version 1.1.

Parameters:

title_selectableTRUE if the user can copy the title from the label

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 parse_markup.

Added in version 1.2.

Parameters:

use_markup – whether to use markup

set_use_underline(use_underline: bool) None

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

Parameters:

use_underlineTRUE if underlines in the text indicate mnemonics

Properties

class PreferencesRow
props.title: str

The title of the preference represented by this row.

The title is interpreted as Pango markup unless use_markup is set to FALSE.

props.title_selectable: bool

Whether the user can copy the title from the label.

See also selectable.

Added in version 1.1.

props.use_markup: bool

Whether to use Pango markup for the title label.

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

See also parse_markup.

Added in version 1.2.

props.use_underline: bool

Whether an embedded underline in the title indicates a mnemonic.

Fields

class PreferencesRow
parent_instance