adw.preferences_window

Module for [PreferencesWindow] class

class PreferencesWindow PreferencesWindowGidBuilder PreferencesWindowGidBuilderImpl

Types 3

classPreferencesWindow : adw.window.Window

A window to present an application's preferences.

The [adw.preferences_window.PreferencesWindow] widget presents an application's preferences gathered into pages and groups. The preferences are searchable by the user.

CSS nodes

[adw.preferences_window.PreferencesWindow] has a main CSS node with the name window and the style class .preferences.

Methods

GType _getGType()

GType _gType() @property

PreferencesWindow self()Returns `this`, for use in `with` statements.

PreferencesWindowGidBuilder builder()Get builder for [adw.preferences_window.PreferencesWindow] Returns: New builder object

bool canNavigateBack() @propertyGet `canNavigateBack` property. Returns: Whether gestures and shortcuts for closing subpages are enabled.

void canNavigateBack(bool propval) @propertySet `canNavigateBack` property. Params: propval = Whether gestures and shortcuts for closing subpages are enabled.

bool searchEnabled() @propertyGet `searchEnabled` property. Returns: Whether search is enabled.

void searchEnabled(bool propval) @propertySet `searchEnabled` property. Params: propval = Whether search is enabled.

gtk.widget.Widget visiblePage() @propertyGet `visiblePage` property. Returns: The currently visible page.

void visiblePage(gtk.widget.Widget propval) @propertySet `visiblePage` property. Params: propval = The currently visible page.

string visiblePageName() @propertyGet `visiblePageName` property. Returns: The name of the currently visible page.

void visiblePageName(string propval) @propertySet `visiblePageName` property. Params: propval = The name of the currently visible page.

void add(adw.preferences_page.PreferencesPage page)Adds a preferences page to self.

void addToast(adw.toast.Toast toast)Displays toast.

void closeSubpage()Closes the current subpage.

bool getCanNavigateBack()Gets whether gestures and shortcuts for closing subpages are enabled. Returns: whether gestures and shortcuts are enabled.

bool getSearchEnabled()Gets whether search is enabled for self. Returns: whether search is enabled for self.

adw.preferences_page.PreferencesPage getVisiblePage()Gets the currently visible page of self. Returns: the visible page

string getVisiblePageName()Gets the name of currently visible page of self. Returns: the name of the visible page

bool popSubpage()Pop the visible page from the subpage stack of self. Returns: `TRUE` if a page has been popped

void presentSubpage(gtk.widget.Widget subpage)Sets subpage as the window's subpage and opens it.

void pushSubpage(adw.navigation_page.NavigationPage page)Pushes page onto the subpage stack of self.

void remove(adw.preferences_page.PreferencesPage page)Removes a page from self.

void setCanNavigateBack(bool canNavigateBack)Sets whether gestures and shortcuts for closing subpages are enabled.

void setSearchEnabled(bool searchEnabled)Sets whether search is enabled for self.

void setVisiblePage(adw.preferences_page.PreferencesPage page)Makes page the visible page of self.

void setVisiblePageName(string name)Makes the page with the given name visible.

Constructors

this(void * ptr, Flag!"Take" take)

this()Creates a new [adw.preferenceswindow.PreferencesWindow]. Returns: the newly created [adw.preferenceswindow.PreferencesWindow]

classPreferencesWindowGidBuilderImpl(T) : adw.window.WindowGidBuilderImpl!T

Methods

T canNavigateBack(bool propval)Set `canNavigateBack` property. Params: propval = Whether gestures and shortcuts for closing subpages are enabled.

T searchEnabled(bool propval)Set `searchEnabled` property. Params: propval = Whether search is enabled. Returns: Builder instance for fluent chaining

T visiblePage(gtk.widget.Widget propval)Set `visiblePage` property. Params: propval = The currently visible page. Returns: Builder instance for fluent chaining

T visiblePageName(string propval)Set `visiblePageName` property. Params: propval = The name of the currently visible page.

classPreferencesWindowGidBuilder : PreferencesWindowGidBuilderImpl!PreferencesWindowGidBuilder

Fluent builder for [adw.preferences_window.PreferencesWindow]

Methods

PreferencesWindow build()