Handy.PreferencesWindow¶

Subclasses:: None

Methods¶

Inherited:: Handy.Window (1), Gtk.Window (119), 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` ()
	`close_subpage` ()
	`get_can_swipe_back` ()
	`get_search_enabled` ()
	`present_subpage` (subpage)
	`set_can_swipe_back` (can_swipe_back)
	`set_search_enabled` (search_enabled)

Virtual Methods¶

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

Properties¶

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

Name	Type	Flags	Short Description
`can-swipe-back`	`bool`	r/w/en	Whether or not swipe gesture can be used to switch from a subpage to the preferences
`search-enabled`	`bool`	r/w/en	Whether search is enabled

Style Properties¶

Inherited:: Gtk.Window (2), Gtk.Widget (17)

Signals¶

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

Fields¶

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

Name	Type	Access	Description
parent_instance	`Handy.Window`	r

Class Details¶

class Handy.PreferencesWindow(*args, **kwargs)¶

Bases:: Handy.Window
Abstract:: No
Structure:: Handy.PreferencesWindowClass

A window to present an application’s preferences.

The HdyPreferencesWindow widget presents an application’s preferences gathered into pages and groups. The preferences are searchable by the user.

CSS nodes

HdyPreferencesWindow has a main CSS node with the name window and the style class .preferences.

Added in version 1.0.

classmethod new()¶

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

Creates a new HdyPreferencesWindow.

Added in version 1.0.

close_subpage()¶

Closes the current subpage.

If there is no presented subpage, this does nothing.

Added in version 1.0.

get_can_swipe_back()¶

Returns:: TRUE if back swipe is enabled
Return type:: bool

Gets whether swipe gestures allow switching from a subpage to the preferences.

Added in version 1.0.

get_search_enabled()¶

Returns:: whether search is enabled for self
Return type:: bool

Gets whether search is enabled for self.

Added in version 1.0.

present_subpage(subpage)¶

Parameters:: subpage (Gtk.Widget) – the subpage

Sets subpage as the window’s subpage and opens it.

The transition can be cancelled by the user, in which case visible child will change back to the previously visible child.

Added in version 1.0.

set_can_swipe_back(can_swipe_back)¶

Parameters:: can_swipe_back (bool) – the new value

Sets whether swipe gestures allow switching from a subpage to the preferences.

Added in version 1.0.

set_search_enabled(search_enabled)¶

Parameters:: search_enabled (bool) – TRUE to enable search, FALSE to disable it

Sets whether search is enabled for self.

Added in version 1.0.

Property Details¶

Handy.PreferencesWindow.props.can_swipe_back¶

Name:: can-swipe-back
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether the window allows closing the subpage via a swipe gesture.

Added in version 1.0.

Handy.PreferencesWindow.props.search_enabled¶

Name:: search-enabled
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

Whether search is enabled.

Added in version 1.0.