adwaita/org.gtkkn.bindings.adw/PreferencesDialog

PreferencesDialog

open class PreferencesDialog(pointer: <Error class: unknown class><<Error class: unknown class>>) : Dialog

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.

CSS nodes

AdwPreferencesDialog has a main CSS node with the name dialog 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

Since

1.5

Constructors

PreferencesDialog

constructor()

Creates a new AdwPreferencesDialog.

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

Types

Companion

object Companion

Properties

adwDialogPointer

val adwDialogPointer: <Error class: unknown class><<Error class: unknown class>>

adwPreferencesDialogPointer

val adwPreferencesDialogPointer: <Error class: unknown class><<Error class: unknown class>>

canClose

open var canClose: Boolean

Whether the dialog can be closed.

child

open var child: <Error class: unknown class>?

The child widget of the AdwDialog.

contentHeight

open var contentHeight: Int

The height of the dialog's contents.

contentWidth

open var contentWidth: Int

The width of the dialog's contents.

currentBreakpoint

open val currentBreakpoint: Breakpoint?

The current breakpoint.

defaultWidget

open var defaultWidget: <Error class: unknown class>?

The default widget.

focusWidget

open var focusWidget: <Error class: unknown class>?

The focus widget.

followsContentSize

open var followsContentSize: Boolean

Whether to size content automatically.

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

presentationMode

open var presentationMode: DialogPresentationMode

The dialog's presentation mode.

searchEnabled

open var searchEnabled: Boolean

Whether search is enabled.

title

open var title: String

The title of the dialog.

Functions

add

open fun add(page: PreferencesPage)

Adds a preferences page to @self.

addBreakpoint

open fun addBreakpoint(breakpoint: Breakpoint)

Adds @breakpoint to @self.

addToast

open fun addToast(toast: Toast)

Displays @toast.

open fun close(): Boolean

Attempts to close @self.

connectCloseAttempt

fun connectCloseAttempt(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the close button or shortcut is used, or method@Dialog.close is called while property@Dialog:can-close is set to FALSE.

connectClosed

fun connectClosed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

Emitted when the dialog is successfully closed.

forceClose

open fun forceClose()

Closes @self.

getCanClose

open fun getCanClose(): Boolean

Gets whether @self can be closed.

getChild

open fun getChild(): <Error class: unknown class>?

Gets the child widget of @self.

getContentHeight

open fun getContentHeight(): Int

Gets the height of the dialog's contents.

getContentWidth

open fun getContentWidth(): Int

Gets the width of the dialog's contents.

getCurrentBreakpoint

open fun getCurrentBreakpoint(): Breakpoint?

Gets the current breakpoint.

getDefaultWidget

open fun getDefaultWidget(): <Error class: unknown class>?

Gets the default widget for @self.

getFocus

open fun getFocus(): <Error class: unknown class>?

Gets the focus widget for @self.

getFollowsContentSize

open fun getFollowsContentSize(): Boolean

Gets whether to size content of @self automatically.

getPresentationMode

open fun getPresentationMode(): DialogPresentationMode

Gets presentation mode for @self.

getSearchEnabled

open fun getSearchEnabled(): Boolean

Gets whether search is enabled for @self.

getTitle

open fun getTitle(): String

Gets the title of @self.

getVisiblePage

open fun getVisiblePage(): PreferencesPage?

Gets the currently visible page of @self.

getVisiblePageName

open fun getVisiblePageName(): String?

Gets the name of currently visible page of @self.

popSubpage

open fun popSubpage(): Boolean

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

present

open fun present(parent: <Error class: unknown class>? = null)

Presents @self within @parent's window.

pushSubpage

open fun pushSubpage(page: NavigationPage)

Pushes @page onto the subpage stack of @self.

remove

open fun remove(page: PreferencesPage)

Removes a page from @self.

setCanClose

open fun setCanClose(canClose: Boolean)

Sets whether @self can be closed.

setChild

open fun setChild(child: <Error class: unknown class>? = null)

Sets the child widget of @self.

setContentHeight

open fun setContentHeight(contentHeight: Int)

Sets the height of the dialog's contents.

setContentWidth

open fun setContentWidth(contentWidth: Int)

Sets the width of the dialog's contents.

setDefaultWidget

open fun setDefaultWidget(defaultWidget: <Error class: unknown class>? = null)

Sets the default widget for @self.

setFocus

open fun setFocus(focus: <Error class: unknown class>? = null)

Sets the focus widget for @self.

setFollowsContentSize

open fun setFollowsContentSize(followsContentSize: Boolean)

Sets whether to size content of @self automatically.

setPresentationMode

open fun setPresentationMode(presentationMode: DialogPresentationMode)

Sets presentation mode for @self.

setSearchEnabled

open fun setSearchEnabled(searchEnabled: Boolean)

Sets whether search is enabled for @self.

setTitle

open fun setTitle(title: String)

Sets the title of @self.

setVisiblePage

open fun setVisiblePage(page: PreferencesPage)

Makes @page the visible page of @self.

setVisiblePageName

open fun setVisiblePageName(name: String)

Makes the page with the given name visible.