adwaita/org.gtkkn.bindings.adw/Dialog

Dialog

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

An adaptive dialog container.

dialog-floating

dialog-bottom

AdwDialog is similar to a window, but is shown within another window. It can be used with class@Window and class@ApplicationWindow, use method@Dialog.present to show it.

AdwDialog is not resizable. Use the property@Dialog:content-width and property@Dialog:content-height properties to set its size, or set property@Dialog:follows-content-size to TRUE to make the dialog track the content's size as it changes. AdwDialog can never be larger than its parent window.

AdwDialog can be presented as a centered floating window or a bottom sheet. By default it's automatic depending on the available size. property@Dialog:presentation-mode can be used to change that.

AdwDialog can be closed via method@Dialog.close.

When presented as a bottom sheet, AdwDialog can also be closed via swiping it down.

The property@Dialog:can-close can be used to prevent closing. In that case, signal@Dialog::close-attempt gets emitted instead.

Use method@Dialog.force_close to close the dialog even when can-close is set to FALSE.

AdwDialog is transient and doesn't integrate with the window below it, for example it's not possible to collapse it into a bottom bar. See class@BottomSheet for persistent and more tightly integrated bottom sheets.

Header Bar Integration

When placed inside an AdwDialog, class@HeaderBar will display the dialog title instead of window title. It will also adjust the decoration layout to ensure it always has a close button and nothing else. Set property@HeaderBar:show-start-title-buttons and property@HeaderBar:show-end-title-buttons to FALSE to remove it if it's unwanted.

Breakpoints

AdwDialog can be used with class@Breakpoint the same way as class@BreakpointBin. Refer to that widget's documentation for details.

Like AdwBreakpointBin, if breakpoints are used, AdwDialog doesn't have a minimum size, and property@Gtk.Widget:width-request and property@Gtk.Widget:height-request properties must be set manually.

Since

1.5

Inheritors

PreferencesDialog

Constructors

constructor()

Creates a new AdwDialog.

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

Types

object Companion

Properties

adwDialogPointer

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

open var canClose: Boolean

Whether the dialog can be closed.

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

The child widget of the AdwDialog.

open var contentHeight: Int

The height of the dialog's contents.

open var contentWidth: Int

The width of the dialog's contents.

currentBreakpoint

open val currentBreakpoint: Breakpoint?

The current breakpoint.

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

The default widget.

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

The focus widget.

followsContentSize

open var followsContentSize: Boolean

Whether to size content automatically.

gtkAccessiblePointer

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

gtkBuildablePointer

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

gtkConstraintTargetPointer

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

presentationMode

open var presentationMode: DialogPresentationMode

The dialog's presentation mode.

open var title: String

The title of the dialog.

Functions

open fun addBreakpoint(breakpoint: Breakpoint)

Adds @breakpoint to @self.

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.

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

Emitted when the dialog is successfully closed.

open fun forceClose()

Closes @self.

open fun getCanClose(): Boolean

Gets whether @self can be closed.

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.

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.

open fun getTitle(): String

Gets the title of @self.

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

Presents @self within @parent's window.

open fun setCanClose(canClose: Boolean)

Sets whether @self can be closed.

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.

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.

open fun setTitle(title: String)

Sets the title of @self.