adwaita/org.gtkkn.bindings.adw/PreferencesWindow

PreferencesWindow

open class PreferencesWindow(pointer: <Error class: unknown class><<Error class: unknown class>>) : Window

A window to present an application's preferences.

preferences-window

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

CSS nodes

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

Skipped during bindings generation

  • method visible-page: Property TypeInfo of getter and setter do not match

  • method visible-page-name: Property TypeInfo of getter and setter do not match

Constructors

Link copied to clipboard
constructor()

Creates a new AdwPreferencesWindow.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val adwPreferencesWindowPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
val adwWindowPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open var canNavigateBack: Boolean

Whether gestures and shortcuts for closing subpages are enabled.

Link copied to clipboard
open var content: <Error class: unknown class>?

The content widget.

Link copied to clipboard
open val currentBreakpoint: Breakpoint?

The current breakpoint.

Link copied to clipboard
open val dialogs: <Error class: unknown class>

The open dialogs.

Link copied to clipboard
open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkNativePointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkRootPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open override val gtkShortcutManagerPointer: <Error class: unknown class><<Error class: unknown class>>
Link copied to clipboard
open var searchEnabled: Boolean

Whether search is enabled.

Link copied to clipboard
open val visibleDialog: Dialog?

The currently visible dialog

Functions

Link copied to clipboard
open fun add(page: PreferencesPage)

Adds a preferences page to @self.

Link copied to clipboard
open fun addBreakpoint(breakpoint: Breakpoint)

Adds @breakpoint to @self.

Link copied to clipboard
open fun addToast(toast: Toast)

Displays @toast.

Link copied to clipboard
open fun closeSubpage()

Closes the current subpage.

Link copied to clipboard
open fun getCanNavigateBack(): Boolean

Gets whether gestures and shortcuts for closing subpages are enabled.

Link copied to clipboard
open fun getContent(): <Error class: unknown class>?

Gets the content widget of @self.

Link copied to clipboard
open fun getCurrentBreakpoint(): Breakpoint?

Gets the current breakpoint.

Link copied to clipboard
open fun getDialogs(): <Error class: unknown class>

Returns a iface@Gio.ListModel that contains the open dialogs of @self.

Link copied to clipboard
open fun getSearchEnabled(): Boolean

Gets whether search is enabled for @self.

Link copied to clipboard
open fun getVisibleDialog(): Dialog?

Returns the currently visible dialog in @self, if there's one.

Link copied to clipboard
open fun getVisiblePage(): PreferencesPage?

Gets the currently visible page of @self.

Link copied to clipboard
open fun getVisiblePageName(): String?

Gets the name of currently visible page of @self.

Link copied to clipboard
open fun popSubpage(): Boolean

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

Link copied to clipboard
open fun presentSubpage(subpage: <Error class: unknown class>)

Sets @subpage as the window's subpage and opens it.

Link copied to clipboard
open fun pushSubpage(page: NavigationPage)

Pushes @page onto the subpage stack of @self.

Link copied to clipboard
open fun remove(page: PreferencesPage)

Removes a page from @self.

Link copied to clipboard
open fun setCanNavigateBack(canNavigateBack: Boolean)

Sets whether gestures and shortcuts for closing subpages are enabled.

Link copied to clipboard
open fun setContent(content: <Error class: unknown class>? = null)

Sets the content widget of @self.

Link copied to clipboard
open fun setSearchEnabled(searchEnabled: Boolean)

Sets whether search is enabled for @self.

Link copied to clipboard
open fun setVisiblePage(page: PreferencesPage)

Makes @page the visible page of @self.

Link copied to clipboard
open fun setVisiblePageName(name: String)

Makes the page with the given name visible.