PreferencesPage
-
class PreferencesPage(**properties: Any)
Superclasses: Widget, InitiallyUnowned, Object
Implemented Interfaces: Accessible, Buildable, ConstraintTarget
A page from PreferencesDialog.
The AdwPreferencesPage widget gathers preferences groups into a single page
of a preferences window.
CSS nodes
AdwPreferencesPage has a single CSS node with name preferencespage.
Accessibility
AdwPreferencesPage uses the GTK_ACCESSIBLE_ROLE_GROUP role.
Constructors
-
class PreferencesPage
-
classmethod new() → Widget
Creates a new AdwPreferencesPage.
Methods
-
class PreferencesPage
-
add(group: PreferencesGroup) → None
Adds a preferences group to self.
- Parameters:
group – the group to add
-
get_description() → str
Gets the description of self.
-
get_icon_name() → str | None
Gets the icon name for self.
-
get_name() → str | None
Gets the name of self.
-
get_title() → str
Gets the title of self.
-
get_use_underline() → bool
Gets whether an embedded underline in the title indicates a mnemonic.
-
remove(group: PreferencesGroup) → None
Removes a group from self.
- Parameters:
group – the group to remove
-
scroll_to_top() → None
Scrolls the scrolled window of self to the top.
-
set_description(description: str) → None
Sets the description of self.
The description is displayed at the top of the page.
- Parameters:
description – the description
-
set_icon_name(icon_name: str | None = None) → None
Sets the icon name for self.
- Parameters:
icon_name – the icon name
-
set_name(name: str | None = None) → None
Sets the name of self.
- Parameters:
name – the name
-
set_title(title: str) → None
Sets the title of self.
- Parameters:
title – the title
-
set_use_underline(use_underline: bool) → None
Sets whether an embedded underline in the title indicates a mnemonic.
- Parameters:
use_underline – TRUE if underlines in the text indicate mnemonics
Properties
-
class PreferencesPage
-
props.description: str
The description to be displayed at the top of the page.
-
props.icon_name: str
The icon name for this page.
-
props.name: str
The name of this page.
-
props.title: str
The title for this page.
-
props.use_underline: bool
Whether an embedded underline in the title indicates a mnemonic.
Fields
-
class PreferencesPage
-
parent_instance