Adw.PreferencesPage¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Widget (181), GObject.Object (37), Gtk.Accessible (15), Gtk.Buildable (1)
Structs:: Gtk.WidgetClass (18), GObject.ObjectClass (5)

class	`new` ()
	`add` (group)
	`get_description` ()
	`get_icon_name` ()
	`get_name` ()
	`get_title` ()
	`get_use_underline` ()
	`remove` (group)
	`scroll_to_top` ()
	`set_description` (description)
	`set_icon_name` (icon_name)
	`set_name` (name)
	`set_title` (title)
	`set_use_underline` (use_underline)

Virtual Methods¶

Inherited:: Gtk.Widget (25), GObject.Object (7), Gtk.Accessible (6), Gtk.Buildable (9)

Properties¶

Inherited:: Gtk.Widget (34), Gtk.Accessible (1)

Name	Type	Flags
`description`	`str`	r/w/en
`icon-name`	`str`	r/w/en
`title`	`str`	r/w/en
`use-underline`	`bool`	r/w/en

Signals¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Fields¶

Inherited:: Gtk.Widget (13), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Widget`	r

Class Details¶

class Adw.PreferencesPage(**kwargs)¶

Bases:: Gtk.Widget
Abstract:: No
Structure:: Adw.PreferencesPageClass

A page from [class`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.

classmethod new()¶

Returns:: the newly created AdwPreferencesPage
Return type:: Gtk.Widget

Creates a new AdwPreferencesPage.

add(group)¶

Parameters:: group (Adw.PreferencesGroup) – the group to add

Adds a preferences group to self.

get_description()¶

Returns:: the description of self.
Return type:: str

Gets the description of self.

New in version 1.4.

get_icon_name()¶

Returns:: the icon name for self
Return type:: str or None

Gets the icon name for self.

get_name()¶

Returns:: the name of self
Return type:: str or None

Gets the name of self.

get_title()¶

Returns:: the title of self.
Return type:: str

Gets the title of self.

get_use_underline()¶

Returns:: whether an embedded underline in the title indicates a mnemonic
Return type:: bool

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

remove(group)¶

Parameters:: group (Adw.PreferencesGroup) – the group to remove

Removes a group from self.

scroll_to_top()¶: Scrolls the scrolled window of self to the top.

New in version 1.3.

set_description(description)¶

Parameters:: description (str) – the description

Sets the description of self.

The description is displayed at the top of the page.

New in version 1.4.

set_icon_name(icon_name)¶

Parameters:: icon_name (str or None) – the icon name

Sets the icon name for self.

set_name(name)¶

Parameters:: name (str or None) – the name

Sets the name of self.

set_title(title)¶

Parameters:: title (str) – the title

Sets the title of self.

set_use_underline(use_underline)¶

Parameters:: use_underline (bool) – TRUE if underlines in the text indicate mnemonics

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

Property Details¶

Adw.PreferencesPage.props.description¶

Name:: description
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

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

New in version 1.4.

Adw.PreferencesPage.props.icon_name¶

Name:: icon-name
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The icon name for this page.

Adw.PreferencesPage.props.title¶

Name:: title
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The title for this page.

Adw.PreferencesPage.props.use_underline¶

Name:: use-underline
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether an embedded underline in the title indicates a mnemonic.