Adw.PreferencesDialog – libadwaita-1

Description:

[ CCode ( type_id = "adw_preferences_dialog_get_type ()" ) ]
[ Version ( since = "1.5" ) ]
public class PreferencesDialog : Dialog, Accessible, Buildable, ConstraintTarget, ShortcutManager

A dialog showing application's preferences.

The `AdwPreferencesDialog` widget presents an application's preferences gathered into pages and groups. The preferences are searchable by the user.

Actions

`AdwPrefencesDialog` defines the `navigation.pop` action, it doesn't take any parameters and pops the current subpage from the navigation stack, equivalent to calling [method@PreferencesDialog.pop_subpage].

CSS nodes

`AdwPreferencesDialog` has a main CSS node with the name `dialog` and the style class `.preferences`.

Namespace: Adw

Content:

Properties:

public bool search_enabled { get; set; }

Whether search is enabled.

public Widget visible_page { get; set; }

The currently visible page.

public string visible_page_name { get; set; }

The name of the currently visible page.

Creation methods:

public PreferencesDialog ()

Creates a new `AdwPreferencesDialog`.

Methods:

public void add (PreferencesPage page)

Adds a preferences page to this.

public void add_toast (owned Toast toast)

Displays toast.

public bool get_search_enabled ()

Gets whether search is enabled for this .

public unowned PreferencesPage? get_visible_page ()

Gets the currently visible page of this .

public unowned string? get_visible_page_name ()

Gets the name of currently visible page of this.

public bool pop_subpage ()

Pop the visible page from the subpage stack of this.

public void push_subpage (NavigationPage page)

Pushes page onto the subpage stack of this.

public void remove (PreferencesPage page)

Removes a page from this.

public void set_search_enabled (bool search_enabled)

Sets whether search is enabled for this .

public void set_visible_page (PreferencesPage page)

Makes page the visible page of this.

public void set_visible_page_name (string name)

Makes the page with the given name visible.

Inherited Members:

All known members inherited from interface Gtk.ShortcutManager

add_controller

remove_controller

PreferencesDialog

Object Hierarchy: