Handy.PreferencesRow¶

Subclasses:: Handy.ActionRow, Handy.ExpanderRow

Methods¶

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

class	`new` ()
	`get_title` ()
	`get_use_underline` ()
	`set_title` (title)
	`set_use_underline` (use_underline)

Virtual Methods¶

Inherited:: Gtk.ListBoxRow (1), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.Actionable (4)

Properties¶

Inherited:: Gtk.ListBoxRow (2), Gtk.Container (3), Gtk.Widget (39), Gtk.Actionable (2)

Name	Type	Flags	Short Description
`title`	`str`	r/w/en	The title of the preference
`use-underline`	`bool`	r/w/en	If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key

Style Properties¶

Inherited:: Gtk.Widget (17)

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent_instance	`Gtk.ListBoxRow`	r

Class Details¶

class Handy.PreferencesRow(**kwargs)¶

Bases:: Gtk.ListBoxRow
Abstract:: No
Structure:: Handy.PreferencesRowClass

A [class`Gtk`.ListBoxRow] used to present preferences.

The HdyPreferencesRow widget has a title that [class`PreferencesWindow`] 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.

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

New in version 1.0.

classmethod new()¶

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

Creates a new HdyPreferencesRow.

New in version 1.0.

get_title()¶

Returns:: the title of the preference represented by self
Return type:: str or None

Gets the title of the preference represented by self.

New in version 1.0.

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.

New in version 1.0.

set_title(title)¶

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

Sets the title of the preference represented by self.

New in version 1.0.

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.

New in version 1.0.

Property Details¶

Handy.PreferencesRow.props.title¶

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

The title of the preference represented by this row.

New in version 1.0.

Handy.PreferencesRow.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.

New in version 1.0.