Handy.PreferencesGroup¶

Subclasses:: None

Methods¶

Inherited:: Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` ()
	`get_description` ()
	`get_title` ()
	`get_use_markup` ()
	`set_description` (description)
	`set_title` (title)
	`set_use_markup` (use_markup)

Virtual Methods¶

Inherited:: Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10)

Properties¶

Inherited:: Gtk.Container (3), Gtk.Widget (39)

Name	Type	Flags	Short Description
`description`	`str`	r/w	Description
`title`	`str`	r/w	Title
`use-markup`	`bool`	r/w	Whether to use markup for the title and description

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Fields¶

Inherited:: Gtk.Container (4), Gtk.Widget (69), GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Gtk.Bin`	r

Class Details¶

class Handy.PreferencesGroup(**kwargs)¶

Bases:: Gtk.Bin
Abstract:: No
Structure:: Handy.PreferencesGroupClass

A group of preference rows.

A HdyPreferencesGroup represents a group or tightly related preferences, which in turn are represented by [class`PreferencesRow`].

To summarize the role of the preferences it gathers, a group can have both a title and a description. The title will be used by [class`PreferencesWindow`] to let the user look for a preference.

CSS nodes

HdyPreferencesGroup has a single CSS node with name preferencesgroup.

New in version 1.0.

classmethod new()¶

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

Creates a new HdyPreferencesGroup.

New in version 1.0.

get_description()¶

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

New in version 1.0.

get_title()¶

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

Gets the title of self.

New in version 1.0.

get_use_markup()¶

Returns:: whether self uses markup for its labels
Return type:: bool

Gets whether self uses markup for the title and description.

New in version 1.4.

set_description(description)¶

Parameters:: description (str) – the description

Sets the description for self.

New in version 1.0.

set_title(title)¶

Parameters:: title (str) – the title

Sets the title for self.

New in version 1.0.

set_use_markup(use_markup)¶

Parameters:: use_markup (bool) – whether to use markup

Sets whether self uses markup for the title and description.

New in version 1.4.

Property Details¶

Handy.PreferencesGroup.props.description¶

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

The description for this group of preferences.

New in version 1.0.

Handy.PreferencesGroup.props.title¶

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

The title for this group of preferences.

New in version 1.0.

Handy.PreferencesGroup.props.use_markup¶

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

Whether to use markup for the title and description.

New in version 1.4.