Adw.PreferencesDialog
Description: Reference for Adw.PreferencesDialog

### Class

# AdwPreferencesDialog

#### Description [src]

    class Adw.PreferencesDialog : Adw.Dialog {
      parent_instance: AdwDialog
    }

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 `adw_preferences_dialog_pop_subpage()`.

## CSS nodes

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

Available since: | 1.5

#### Ancestors

- AdwDialog
- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkShortcutManager

#### Constructors

###### adw_preferences_dialog_new

Creates a new `AdwPreferencesDialog`.

Available since: 1.5

#### Instance methods

###### adw_preferences_dialog_add

Adds a preferences page to `self`.

Available since: 1.5

###### adw_preferences_dialog_add_toast

Displays `toast`.

Available since: 1.5

###### adw_preferences_dialog_get_search_enabled

Gets whether search is enabled for `self`.

Available since: 1.5

###### adw_preferences_dialog_get_visible_page

Gets the currently visible page of `self`.

Available since: 1.5

###### adw_preferences_dialog_get_visible_page_name

Gets the name of currently visible page of `self`.

Available since: 1.5

###### adw_preferences_dialog_pop_subpage

Pop the visible page from the subpage stack of `self`.

Available since: 1.5

###### adw_preferences_dialog_push_subpage

Pushes `page` onto the subpage stack of `self`.

Available since: 1.5

###### adw_preferences_dialog_remove

Removes a page from `self`.

Available since: 1.5

###### adw_preferences_dialog_set_search_enabled

Sets whether search is enabled for `self`.

Available since: 1.5

###### adw_preferences_dialog_set_visible_page

Makes `page` the visible page of `self`.

Available since: 1.5

###### adw_preferences_dialog_set_visible_page_name

Makes the page with the given name visible.

Available since: 1.5

##### Methods inherited from AdwDialog (23)

###### adw_dialog_add_breakpoint

Adds `breakpoint` to `self`.

Available since: 1.5

###### adw_dialog_close

Attempts to close `self`.

Available since: 1.5

###### adw_dialog_force_close

Closes `self`.

Available since: 1.5

###### adw_dialog_get_can_close

Gets whether `self` can be closed.

Available since: 1.5

###### adw_dialog_get_child

Gets the child widget of `self`.

Available since: 1.5

###### adw_dialog_get_content_height

Gets the height of the dialog’s contents.

Available since: 1.5

###### adw_dialog_get_content_width

Gets the width of the dialog’s contents.

Available since: 1.5

###### adw_dialog_get_current_breakpoint

Gets the current breakpoint.

Available since: 1.5

###### adw_dialog_get_default_widget

Gets the default widget for `self`.

Available since: 1.5

###### adw_dialog_get_focus

Gets the focus widget for `self`.

Available since: 1.5

###### adw_dialog_get_follows_content_size

Gets whether to size content of `self` automatically.

Available since: 1.5

###### adw_dialog_get_presentation_mode

Gets presentation mode for `self`.

Available since: 1.5

###### adw_dialog_get_title

Gets the title of `self`.

Available since: 1.5

###### adw_dialog_present

Presents `self` within `parent`‘s window.

Available since: 1.5

###### adw_dialog_set_can_close

Sets whether `self` can be closed.

Available since: 1.5

###### adw_dialog_set_child

Sets the child widget of `self`.

Available since: 1.5

###### adw_dialog_set_content_height

Sets the height of the dialog’s contents.

Available since: 1.5

###### adw_dialog_set_content_width

Sets the width of the dialog’s contents.

Available since: 1.5

###### adw_dialog_set_default_widget

Sets the default widget for `self`.

Available since: 1.5

###### adw_dialog_set_focus

Sets the focus widget for `self`.

Available since: 1.5

###### adw_dialog_set_follows_content_size

Sets whether to size content of `self` automatically.

Available since: 1.5

###### adw_dialog_set_presentation_mode

Sets presentation mode for `self`.

Available since: 1.5

###### adw_dialog_set_title

Sets the title of `self`.

Available since: 1.5

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (20)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

Available since: 4.14

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

Available since: 4.10

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

Available since: 4.10

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

Available since: 4.10

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

Available since: 4.10

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

Available since: 4.10

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

Available since: 4.10

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

Available since: 4.10

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

Available since: 4.10

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

Available since: 4.18

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

#### Properties

###### Adw.PreferencesDialog:search-enabled

Whether search is enabled.

Available since: 1.5

###### Adw.PreferencesDialog:visible-page

The currently visible page.

Available since: 1.5

###### Adw.PreferencesDialog:visible-page-name

The name of the currently visible page.

Available since: 1.5

##### Properties inherited from AdwDialog (10)

###### Adw.Dialog:can-close

Whether the dialog can be closed.

Available since: 1.5

###### Adw.Dialog:child

The child widget of the `AdwDialog`.

Available since: 1.5

###### Adw.Dialog:content-height

The height of the dialog’s contents.

Available since: 1.5

###### Adw.Dialog:content-width

The width of the dialog’s contents.

Available since: 1.5

###### Adw.Dialog:current-breakpoint

The current breakpoint.

Available since: 1.5

###### Adw.Dialog:default-widget

The default widget.

Available since: 1.5

###### Adw.Dialog:focus-widget

The focus widget.

Available since: 1.5

###### Adw.Dialog:follows-content-size

Whether to size content automatically.

Available since: 1.5

###### Adw.Dialog:presentation-mode

The dialog’s presentation mode.

Available since: 1.5

###### Adw.Dialog:title

The title of the dialog.

Available since: 1.5

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Available since: 4.18

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

##### Signals inherited from AdwDialog (2)

###### Adw.Dialog::close-attempt

Emitted when the close button or shortcut is used, or `adw_dialog_close()` is called while `AdwDialog:can-close` is set to `FALSE`.

Available since: 1.5

###### Adw.Dialog::closed

Emitted when the dialog is successfully closed.

Available since: 1.5

##### Signals inherited from GtkWidget (13)

###### Gtk.Widget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### Gtk.Widget::direction-changed

Emitted when the text direction of a widget changes.

###### Gtk.Widget::hide

Emitted when `widget` is hidden.

###### Gtk.Widget::keynav-failed

Emitted if keyboard navigation fails.

###### Gtk.Widget::map

Emitted when `widget` is going to be mapped.

###### Gtk.Widget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### Gtk.Widget::move-focus

Emitted when the focus is moved.

###### Gtk.Widget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### Gtk.Widget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### Gtk.Widget::show

Emitted when `widget` is shown.

###### Gtk.Widget::state-flags-changed

Emitted when the widget state changes.

###### Gtk.Widget::unmap

Emitted when `widget` is going to be unmapped.

###### Gtk.Widget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject.Object::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AdwPreferencesDialogClass {
      AdwDialogClass parent_class;

    }

###### Class members

`parent_class` |
    AdwDialogClass
| The parent class.