GI.Adw.Objects.Dialog

An adaptive dialog container.

<picture> <source srcset="dialog-floating-dark.png" media="(prefers-color-scheme: dark)"> <img src="dialog-floating.png" alt="dialog-floating"> </picture> <picture> <source srcset="dialog-bottom-dark.png" media="(prefers-color-scheme: dark)"> <img src="dialog-bottom.png" alt="dialog-bottom"> </picture>

AdwDialog is similar to a window, but is shown within another window. It can be used with [classwindow] and [classapplicationWindow], use [methoddialog.present] to show it.

AdwDialog is not resizable. Use the [propertydialog:content-width] and [propertydialog:content-height] properties to set its size, or set [propertydialog: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. [propertydialog:presentation-mode] can be used to change that.

AdwDialog can be closed via [methoddialog.close].

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

The [propertydialog:can-close] can be used to prevent closing. In that case, signaldialog[closeAttempt] gets emitted instead.

Use [methoddialog.force_close] to close the dialog even when can-close is set to FALSE.

Header Bar Integration

When placed inside an AdwDialog, [classheaderBar] 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 [propertyheaderBar:show-start-title-buttons] and [propertyheaderBar:show-end-title-buttons] to FALSE to remove it if it's unwanted.

Breakpoints

AdwDialog can be used with [classbreakpoint] the same way as [classbreakpointBin]. Refer to that widget's documentation for details.

Like AdwBreakpointBin, if breakpoints are used, AdwDialog doesn't have a minimum size, and Widget:widthRequest and Widget:heightRequest properties must be set manually.

Since: 1.5

Exported types

newtype Dialog

Memory-managed wrapper type.

Constructors

Dialog (ManagedPtr Dialog)

Instances

Eq Dialog

Defined in GI.Adw.Objects.Dialog

Methods

(==) :: Dialog -> Dialog -> Bool

(/=) :: Dialog -> Dialog -> Bool

GObject Dialog

Defined in GI.Adw.Objects.Dialog

ManagedPtrNewtype Dialog

Defined in GI.Adw.Objects.Dialog

Methods

toManagedPtr :: Dialog -> ManagedPtr Dialog

TypedObject Dialog

Defined in GI.Adw.Objects.Dialog

Methods

glibType :: IO GType

HasParentTypes Dialog

Defined in GI.Adw.Objects.Dialog

IsGValue (Maybe Dialog)

Convert Dialog to and from GValue. See toGValue and fromGValue.

Defined in GI.Adw.Objects.Dialog

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Dialog -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Dialog)

type ParentTypes Dialog

Defined in GI.Adw.Objects.Dialog

type ParentTypes Dialog = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Dialog o) => IsDialog o

Type class for types which can be safely cast to Dialog, for instance with toDialog.

Instances

(GObject o, IsDescendantOf Dialog o) => IsDialog o

Defined in GI.Adw.Objects.Dialog

toDialog :: (MonadIO m, IsDialog o) => o -> m Dialog

Cast to Dialog, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addBreakpoint, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, announce, bindProperty, bindPropertyFull, childFocus, close, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, disposeTemplate, dragCheckThreshold, errorBell, forceClose, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, present, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateNextAccessibleSibling, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleParent, getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAtContext, getBaseline, getBounds, getBuildableId, getCanClose, getCanFocus, getCanTarget, getChild, getChildVisible, getClipboard, getColor, getContentHeight, getContentWidth, getCssClasses, getCssName, getCurrentBreakpoint, getCursor, getData, getDefaultWidget, getDirection, getDisplay, getFirstAccessibleChild, getFirstChild, getFocus, getFocusChild, getFocusOnClick, getFocusable, getFollowsContentSize, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextAccessibleSibling, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPlatformState, getPreferredSize, getPresentationMode, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTitle, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAccessibleParent, setCanClose, setCanFocus, setCanTarget, setChild, setChildVisible, setContentHeight, setContentWidth, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDefaultWidget, setDirection, setFocus, setFocusChild, setFocusOnClick, setFocusable, setFollowsContentSize, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setPresentationMode, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTitle, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

addBreakpoint

dialogAddBreakpoint

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsBreakpoint b)

=> a

self: a dialog

-> b

breakpoint: the breakpoint to add

-> m ()

Adds breakpoint to self.

Since: 1.5

close

dialogClose

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Bool

Returns: whether self was successfully closed

Attempts to close self.

If the [propertydialog:can-close] property is set to FALSE, the signaldialog[closeAttempt] signal is emitted.

See also: [methoddialog.force_close].

Since: 1.5

forceClose

dialogForceClose

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m ()

Closes self.

Unlike [methoddialog.close], it succeeds even if [propertydialog:can-close] is set to FALSE.

Since: 1.5

getCanClose

dialogGetCanClose

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Bool

Returns: whether the dialog can be closed

Gets whether self can be closed.

Since: 1.5

getChild

dialogGetChild

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m (Maybe Widget)

Returns: the child widget of self

Gets the child widget of self.

Since: 1.5

getContentHeight

dialogGetContentHeight

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Int32

Returns: the content height

Gets the height of the dialog's contents.

Since: 1.5

getContentWidth

dialogGetContentWidth

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Int32

Returns: the content width

Gets the width of the dialog's contents.

Since: 1.5

getCurrentBreakpoint

dialogGetCurrentBreakpoint

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m (Maybe Breakpoint)

Returns: the current breakpoint

Gets the current breakpoint.

Since: 1.5

getDefaultWidget

dialogGetDefaultWidget

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m (Maybe Widget)

Returns: the default widget

Gets the default widget for self.

Since: 1.5

getFocus

dialogGetFocus

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m (Maybe Widget)

Returns: the focus widget

Gets the focus widget for self.

Since: 1.5

getFollowsContentSize

dialogGetFollowsContentSize

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Bool

Returns: whether to size content automatically

Gets whether to size content of self automatically.

Since: 1.5

getPresentationMode

dialogGetPresentationMode

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m DialogPresentationMode

Returns: the presentation mode

Gets presentation mode for self.

Since: 1.5

getTitle

dialogGetTitle

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> m Text

Returns: the title

Gets the title of self.

Since: 1.5

new

dialogNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Dialog

Returns: the new created AdwDialog

Creates a new AdwDialog.

Since: 1.5

present

dialogPresent

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

self: a dialog

-> Maybe b

parent: a widget within the toplevel

-> m ()

Presents self within parent's window.

If self is already shown, raises it to the top instead.

If the window is an [classwindow] or [classapplicationWindow], the dialog will be shown within it. Otherwise, it will be a separate window.

Since: 1.5

setCanClose

dialogSetCanClose

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> Bool

canClose: whether to allow closing

-> m ()

Sets whether self can be closed.

If set to FALSE, the close button, shortcuts and [methoddialog.close] will result in signaldialog[closeAttempt] being emitted instead, and bottom sheet close swipe will be disabled. [methoddialog.force_close] still works.

Since: 1.5

setChild

dialogSetChild

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

self: a dialog

-> Maybe b

child: the child widget

-> m ()

Sets the child widget of self.

Since: 1.5

setContentHeight

dialogSetContentHeight

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> Int32

contentHeight: the content height

-> m ()

Sets the height of the dialog's contents.

Set it to -1 to reset it to the content's natural height.

See also: Window:defaultHeight

Since: 1.5

setContentWidth

dialogSetContentWidth

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> Int32

contentWidth: the content width

-> m ()

Sets the width of the dialog's contents.

Set it to -1 to reset it to the content's natural width.

See also: Window:defaultWidth

Since: 1.5

setDefaultWidget

dialogSetDefaultWidget

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

self: a dialog

-> Maybe b

defaultWidget: the default widget

-> m ()

Sets the default widget for self.

It's activated when the user presses Enter.

Since: 1.5

setFocus

dialogSetFocus

Arguments

:: (HasCallStack, MonadIO m, IsDialog a, IsWidget b)

=> a

self: a dialog

-> Maybe b

focus: the focus widget

-> m ()

Sets the focus widget for self.

If focus is not the current focus widget, and is focusable, sets it as the focus widget for the dialog.

If focus is NULL, unsets the focus widget for this dialog. To set the focus to a particular widget in the dialog, it is usually more convenient to use widgetGrabFocus instead of this function.

Since: 1.5

setFollowsContentSize

dialogSetFollowsContentSize

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> Bool

followsContentSize: whether to size content automatically

-> m ()

Sets whether to size content of self automatically.

If set to TRUE, always use the content's natural size instead of [propertydialog:content-width] and [propertydialog:content-height]. If the content resizes, the dialog will immediately resize as well.

See also: Window:resizable

Since: 1.5

setPresentationMode

dialogSetPresentationMode

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> DialogPresentationMode

presentationMode: the new presentation mode

-> m ()

Sets presentation mode for self.

When set to ADW_DIALOG_AUTO, the dialog appears as a bottom sheet when the following condition is met: max-width: 450px or max-height: 360px, and as a floating window otherwise.

Set it to ADW_DIALOG_FLOATING or ADW_DIALOG_BOTTOM_SHEET to always present it a floating window or a bottom sheet respectively, regardless of available size.

Presentation mode does nothing for dialogs presented as a window.

Since: 1.5

setTitle

dialogSetTitle

Arguments

:: (HasCallStack, MonadIO m, IsDialog a)

=> a

self: a dialog

-> Text

title: the new title

-> m ()

Sets the title of self.

Since: 1.5

Properties

canClose

Whether the dialog can be closed.

If set to FALSE, the close button, shortcuts and [methoddialog.close] will result in signaldialog[closeAttempt] being emitted instead, and bottom sheet close swipe will be disabled. [methoddialog.force_close] still works.

Since: 1.5

constructDialogCanClose :: (IsDialog o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “can-close” property. This is rarely needed directly, but it is used by new.

getDialogCanClose :: (MonadIO m, IsDialog o) => o -> m Bool

Get the value of the “can-close” property. When overloading is enabled, this is equivalent to

get dialog #canClose

setDialogCanClose :: (MonadIO m, IsDialog o) => o -> Bool -> m ()

Set the value of the “can-close” property. When overloading is enabled, this is equivalent to

set dialog [ #canClose := value ]

child

The child widget of the AdwDialog.

Since: 1.5

clearDialogChild :: (MonadIO m, IsDialog o) => o -> m ()

Set the value of the “child” property to Nothing. When overloading is enabled, this is equivalent to

clear #child

constructDialogChild :: (IsDialog o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “child” property. This is rarely needed directly, but it is used by new.

getDialogChild :: (MonadIO m, IsDialog o) => o -> m (Maybe Widget)

Get the value of the “child” property. When overloading is enabled, this is equivalent to

get dialog #child

setDialogChild :: (MonadIO m, IsDialog o, IsWidget a) => o -> a -> m ()

Set the value of the “child” property. When overloading is enabled, this is equivalent to

set dialog [ #child := value ]

contentHeight

The height of the dialog's contents.

Set it to -1 to reset it to the content's natural height.

See also: Window:defaultHeight

Since: 1.5

constructDialogContentHeight :: (IsDialog o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “content-height” property. This is rarely needed directly, but it is used by new.

getDialogContentHeight :: (MonadIO m, IsDialog o) => o -> m Int32

Get the value of the “content-height” property. When overloading is enabled, this is equivalent to

get dialog #contentHeight

setDialogContentHeight :: (MonadIO m, IsDialog o) => o -> Int32 -> m ()

Set the value of the “content-height” property. When overloading is enabled, this is equivalent to

set dialog [ #contentHeight := value ]

contentWidth

The width of the dialog's contents.

Set it to -1 to reset it to the content's natural width.

See also: Window:defaultWidth

Since: 1.5

constructDialogContentWidth :: (IsDialog o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “content-width” property. This is rarely needed directly, but it is used by new.

getDialogContentWidth :: (MonadIO m, IsDialog o) => o -> m Int32

Get the value of the “content-width” property. When overloading is enabled, this is equivalent to

get dialog #contentWidth

setDialogContentWidth :: (MonadIO m, IsDialog o) => o -> Int32 -> m ()

Set the value of the “content-width” property. When overloading is enabled, this is equivalent to

set dialog [ #contentWidth := value ]

currentBreakpoint

The current breakpoint.

Since: 1.5

getDialogCurrentBreakpoint :: (MonadIO m, IsDialog o) => o -> m (Maybe Breakpoint)

Get the value of the “current-breakpoint” property. When overloading is enabled, this is equivalent to

get dialog #currentBreakpoint

defaultWidget

The default widget.

It's activated when the user presses Enter.

Since: 1.5

clearDialogDefaultWidget :: (MonadIO m, IsDialog o) => o -> m ()

Set the value of the “default-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #defaultWidget

constructDialogDefaultWidget :: (IsDialog o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “default-widget” property. This is rarely needed directly, but it is used by new.

getDialogDefaultWidget :: (MonadIO m, IsDialog o) => o -> m (Maybe Widget)

Get the value of the “default-widget” property. When overloading is enabled, this is equivalent to

get dialog #defaultWidget

setDialogDefaultWidget :: (MonadIO m, IsDialog o, IsWidget a) => o -> a -> m ()

Set the value of the “default-widget” property. When overloading is enabled, this is equivalent to

set dialog [ #defaultWidget := value ]

focusWidget

The focus widget.

Since: 1.5

clearDialogFocusWidget :: (MonadIO m, IsDialog o) => o -> m ()

Set the value of the “focus-widget” property to Nothing. When overloading is enabled, this is equivalent to

clear #focusWidget

constructDialogFocusWidget :: (IsDialog o, MonadIO m, IsWidget a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “focus-widget” property. This is rarely needed directly, but it is used by new.

getDialogFocusWidget :: (MonadIO m, IsDialog o) => o -> m (Maybe Widget)

Get the value of the “focus-widget” property. When overloading is enabled, this is equivalent to

get dialog #focusWidget

setDialogFocusWidget :: (MonadIO m, IsDialog o, IsWidget a) => o -> a -> m ()

Set the value of the “focus-widget” property. When overloading is enabled, this is equivalent to

set dialog [ #focusWidget := value ]

followsContentSize

Whether to size content automatically.

If set to TRUE, always use the content's natural size instead of [propertydialog:content-width] and [propertydialog:content-height]. If the content resizes, the dialog will immediately resize as well.

See also: Window:resizable

Since: 1.5

constructDialogFollowsContentSize :: (IsDialog o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “follows-content-size” property. This is rarely needed directly, but it is used by new.

getDialogFollowsContentSize :: (MonadIO m, IsDialog o) => o -> m Bool

Get the value of the “follows-content-size” property. When overloading is enabled, this is equivalent to

get dialog #followsContentSize

setDialogFollowsContentSize :: (MonadIO m, IsDialog o) => o -> Bool -> m ()

Set the value of the “follows-content-size” property. When overloading is enabled, this is equivalent to

set dialog [ #followsContentSize := value ]

presentationMode

The dialog's presentation mode.

When set to ADW_DIALOG_AUTO, the dialog appears as a bottom sheet when the following condition is met: max-width: 450px or max-height: 360px, and as a floating window otherwise.

Set it to ADW_DIALOG_FLOATING or ADW_DIALOG_BOTTOM_SHEET to always present it a floating window or a bottom sheet respectively, regardless of available size.

Presentation mode does nothing for dialogs presented as a window.

Since: 1.5

constructDialogPresentationMode :: (IsDialog o, MonadIO m) => DialogPresentationMode -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “presentation-mode” property. This is rarely needed directly, but it is used by new.

getDialogPresentationMode :: (MonadIO m, IsDialog o) => o -> m DialogPresentationMode

Get the value of the “presentation-mode” property. When overloading is enabled, this is equivalent to

get dialog #presentationMode

setDialogPresentationMode :: (MonadIO m, IsDialog o) => o -> DialogPresentationMode -> m ()

Set the value of the “presentation-mode” property. When overloading is enabled, this is equivalent to

set dialog [ #presentationMode := value ]

title

The title of the dialog.

Since: 1.5

constructDialogTitle :: (IsDialog o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “title” property. This is rarely needed directly, but it is used by new.

getDialogTitle :: (MonadIO m, IsDialog o) => o -> m Text

Get the value of the “title” property. When overloading is enabled, this is equivalent to

get dialog #title

setDialogTitle :: (MonadIO m, IsDialog o) => o -> Text -> m ()

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set dialog [ #title := value ]

Signals

closeAttempt

type DialogCloseAttemptCallback = IO ()

Emitted when the close button or shortcut is used, or [methoddialog.close] is called while [propertydialog:can-close] is set to FALSE.

Since: 1.5

afterDialogCloseAttempt :: (IsDialog a, MonadIO m) => a -> ((?self :: a) => DialogCloseAttemptCallback) -> m SignalHandlerId

Connect a signal handler for the closeAttempt signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialog #closeAttempt callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDialogCloseAttempt :: (IsDialog a, MonadIO m) => a -> ((?self :: a) => DialogCloseAttemptCallback) -> m SignalHandlerId

Connect a signal handler for the closeAttempt signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialog #closeAttempt callback

closed

type DialogClosedCallback = IO ()

Emitted when the dialog is successfully closed.

Since: 1.5

afterDialogClosed :: (IsDialog a, MonadIO m) => a -> ((?self :: a) => DialogClosedCallback) -> m SignalHandlerId

Connect a signal handler for the closed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after dialog #closed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDialogClosed :: (IsDialog a, MonadIO m) => a -> ((?self :: a) => DialogClosedCallback) -> m SignalHandlerId

Connect a signal handler for the closed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on dialog #closed callback