Package org.gnome.adw

Class Dialog

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.gnome.gtk.Widget

org.gnome.adw.Dialog

All Implemented Interfaces:

Proxy, Accessible, Buildable, ConstraintTarget

Direct Known Subclasses:

AboutDialog, AlertDialog, PreferencesDialog

@Generated("io.github.jwharm.JavaGI")
public class Dialog
extends Widget
implements Accessible, Buildable, ConstraintTarget

An adaptive dialog container.

AdwDialog is similar to a window, but is shown within another window. It can be used with Window and ApplicationWindow, use present(org.gnome.gtk.Widget) to show it.

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

AdwDialog can be closed via close().

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

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

Use forceClose() 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 BottomSheet for persistent and more tightly integrated bottom sheets.

Header Bar Integration
When placed inside an AdwDialog, 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 HeaderBar:show-start-title-buttons and HeaderBar:show-end-title-buttons to FALSE to remove it if it's unwanted.

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Dialog.Builder<B extends Dialog.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Dialog.CloseAttemptCallback	Functional interface declaration of the CloseAttemptCallback callback.
static interface	Dialog.ClosedCallback	Functional interface declaration of the ClosedCallback callback.
static class	Dialog.DialogClass

Nested classes/interfaces inherited from class org.gnome.gtk.Widget

Widget.DestroyCallback, Widget.DirectionChangedCallback, Widget.HideCallback, Widget.KeynavFailedCallback, Widget.MapCallback, Widget.MnemonicActivateCallback, Widget.MoveFocusCallback, Widget.QueryTooltipCallback, Widget.RealizeCallback, Widget.ShowCallback, Widget.StateFlagsChangedCallback, Widget.UnmapCallback, Widget.UnrealizeCallback, Widget.WidgetClass, Widget.WidgetImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gtk.Accessible

Accessible.AccessibleImpl, Accessible.AccessibleInterface

Nested classes/interfaces inherited from interface org.gnome.gtk.Buildable

Buildable.BuildableIface, Buildable.BuildableImpl

Nested classes/interfaces inherited from interface org.gnome.gtk.ConstraintTarget

ConstraintTarget.ConstraintTargetImpl, ConstraintTarget.ConstraintTargetInterface

Constructor Summary

Constructors

Constructor	Description
Dialog()	Creates a new AdwDialog.
Dialog(MemorySegment address)	Create a Dialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addBreakpoint(Breakpoint breakpoint)	Adds breakpoint to this Dialog.
protected Dialog	asParent()	Returns this instance as if it were its parent type.
static Dialog.Builder<? extends Dialog.Builder>	builder()	A Dialog.Builder object constructs a Dialog with the specified properties.
boolean	close()	Attempts to close this Dialog.
protected void	closeAttempt()
protected void	closed()
void	emitCloseAttempt()	Emits the "close-attempt" signal.
void	emitClosed()	Emits the "closed" signal.
void	forceClose()	Closes this Dialog.
boolean	getCanClose()	Gets whether this Dialog can be closed.
Widget	getChild()	Gets the child widget of this Dialog.
int	getContentHeight()	Gets the height of the dialog's contents.
int	getContentWidth()	Gets the width of the dialog's contents.
Breakpoint	getCurrentBreakpoint()	Gets the current breakpoint.
Widget	getDefaultWidget()	Gets the default widget for this Dialog.
Widget	getFocus()	Gets the focus widget for this Dialog.
boolean	getFollowsContentSize()	Gets whether to size content of this Dialog automatically.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
DialogPresentationMode	getPresentationMode()	Gets presentation mode for this Dialog.
String	getTitle()	Gets the title of this Dialog.
static Type	getType()	Get the GType of the Dialog class
SignalConnection<Dialog.CloseAttemptCallback>	onCloseAttempt(Dialog.CloseAttemptCallback handler)	Emitted when the close button or shortcut is used, or close() is called while Dialog:can-close is set to FALSE.
SignalConnection<Dialog.ClosedCallback>	onClosed(Dialog.ClosedCallback handler)	Emitted when the dialog is successfully closed.
void	present(@Nullable Widget parent)	Presents this Dialog within parent's window.
void	setCanClose(boolean canClose)	Sets whether this Dialog can be closed.
void	setChild(@Nullable Widget child)	Sets the child widget of this Dialog.
void	setContentHeight(int contentHeight)	Sets the height of the dialog's contents.
void	setContentWidth(int contentWidth)	Sets the width of the dialog's contents.
void	setDefaultWidget(@Nullable Widget defaultWidget)	Sets the default widget for this Dialog.
void	setFocus(@Nullable Widget focus)	Sets the focus widget for this Dialog.
void	setFollowsContentSize(boolean followsContentSize)	Sets whether to size content of this Dialog automatically.
void	setPresentationMode(DialogPresentationMode presentationMode)	Sets presentation mode for this Dialog.
void	setTitle(String title)	Sets the title of this Dialog.

Methods inherited from class org.gnome.gtk.Widget

actionSetEnabled, activateActionIfExists, activateDefault, activateWidget, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, childFocus, computeBounds, computeExpand, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, cssChanged, directionChanged, disposeTemplate, dragCheckThreshold, emitDestroy, emitDirectionChanged, emitHide, emitKeynavFailed, emitMap, emitMnemonicActivate, emitMoveFocus, emitQueryTooltip, emitRealize, emitShow, emitStateFlagsChanged, emitUnmap, emitUnrealize, errorBell, focus, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBaseline, getCanFocus, getCanTarget, getChildVisible, getClipboard, getColor, getCssClasses, getCssName, getCursor, getDefaultDirection, getDirection, getDisplay, getFirstChild, getFocusable, getFocusChild, getFocusOnClick, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, moveFocus, observeChildren, observeControllers, onDestroy, onDirectionChanged, onHide, onKeynavFailed, onMap, onMnemonicActivate, onMoveFocus, onQueryTooltip, onRealize, onShow, onStateFlagsChanged, onUnmap, onUnrealize, pick, pick, queryTooltip, queueAllocate, queueDraw, queueResize, realize, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, root, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setDefaultDirection, setDirection, setFocusable, setFocusChild, setFocusOnClick, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible, shouldLayout, show, sizeAllocate, sizeAllocate, snapshot, snapshotChild, stateFlagsChanged, systemSettingChanged, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unroot, unsetStateFlags, unsetStateFlags

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.gnome.gtk.Accessible

announce, getAccessibleParent, getAccessibleRole, getAtContext, getBounds, getFirstAccessibleChild, getNextAccessibleSibling, getPlatformState, resetProperty, resetRelation, resetState, setAccessibleParent, updateNextAccessibleSibling, updateProperty, updateRelation, updateState

Methods inherited from interface org.gnome.gtk.Buildable

getBuildableId

Methods inherited from interface io.github.jwharm.javagi.base.Proxy

handle

Constructor Details

Dialog

public Dialog(MemorySegment address)

Create a Dialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Dialog

public Dialog()

Creates a new AdwDialog.

Method Details

getType

public static Type getType()

Get the GType of the Dialog class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Dialog asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class Widget

addBreakpoint

public void addBreakpoint(Breakpoint breakpoint)

Adds breakpoint to this Dialog.

Parameters:

breakpoint - the breakpoint to add

close

public boolean close()

Attempts to close this Dialog.

If the Dialog:can-close property is set to FALSE, the Dialog::close-attempt signal is emitted.

See also: forceClose().

Returns:

whether this Dialog was successfully closed

forceClose

public void forceClose()

Closes this Dialog.

Unlike close(), it succeeds even if Dialog:can-close is set to FALSE.

getCanClose

public boolean getCanClose()

Gets whether this Dialog can be closed.

Returns:

whether the dialog can be closed

getChild

public Widget getChild()

Gets the child widget of this Dialog.

Returns:

the child widget of this Dialog

getContentHeight

public int getContentHeight()

Gets the height of the dialog's contents.

Returns:

the content height

getContentWidth

public int getContentWidth()

Gets the width of the dialog's contents.

Returns:

the content width

getCurrentBreakpoint

public Breakpoint getCurrentBreakpoint()

Gets the current breakpoint.

Returns:

the current breakpoint

getDefaultWidget

public Widget getDefaultWidget()

Gets the default widget for this Dialog.

Returns:

the default widget

getFocus

public Widget getFocus()

Gets the focus widget for this Dialog.

Returns:

the focus widget

getFollowsContentSize

public boolean getFollowsContentSize()

Gets whether to size content of this Dialog automatically.

Returns:

whether to size content automatically

getPresentationMode

public DialogPresentationMode getPresentationMode()

Gets presentation mode for this Dialog.

Returns:

the presentation mode

getTitle

public String getTitle()

Gets the title of this Dialog.

Returns:

the title

present

public void present(@Nullable
 @Nullable Widget parent)

Presents this Dialog within parent's window.

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

If the window is an Window or ApplicationWindow, the dialog will be shown within it. Otherwise, it will be a separate window.

Parameters:

parent - a widget within the toplevel

setCanClose

public void setCanClose(boolean canClose)

Sets whether this Dialog can be closed.

If set to FALSE, the close button, shortcuts and close() will result in Dialog::close-attempt being emitted instead, and bottom sheet close swipe will be disabled. forceClose() still works.

Parameters:

canClose - whether to allow closing

setChild

public void setChild(@Nullable
 @Nullable Widget child)

Sets the child widget of this Dialog.

Parameters:

child - the child widget

setContentHeight

public void setContentHeight(int contentHeight)

Sets the height of the dialog's contents.

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

See also: Gtk.Window:default-height

Parameters:

contentHeight - the content height

setContentWidth

public void setContentWidth(int contentWidth)

Sets the width of the dialog's contents.

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

See also: Gtk.Window:default-width

Parameters:

contentWidth - the content width

setDefaultWidget

public void setDefaultWidget(@Nullable
 @Nullable Widget defaultWidget)

Sets the default widget for this Dialog.

It's activated when the user presses Enter.

Parameters:

defaultWidget - the default widget

setFocus

public void setFocus(@Nullable
 @Nullable Widget focus)

Sets the focus widget for this Dialog.

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 Widget.grabFocus() instead of this function.

Parameters:

focus - the focus widget

setFollowsContentSize

public void setFollowsContentSize(boolean followsContentSize)

Sets whether to size content of this Dialog automatically.

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

See also: Gtk.Window:resizable

Parameters:

followsContentSize - whether to size content automatically

setPresentationMode

public void setPresentationMode(DialogPresentationMode presentationMode)

Sets presentation mode for this Dialog.

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.

Parameters:

presentationMode - the new presentation mode

setTitle

public void setTitle(String title)

Sets the title of this Dialog.

Parameters:

title - the new title

closeAttempt

protected void closeAttempt()

closed

protected void closed()

onCloseAttempt

public SignalConnection<Dialog.CloseAttemptCallback> onCloseAttempt(Dialog.CloseAttemptCallback handler)

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

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Dialog.CloseAttemptCallback.run()

emitCloseAttempt

public void emitCloseAttempt()

Emits the "close-attempt" signal. See onCloseAttempt(org.gnome.adw.Dialog.CloseAttemptCallback).

onClosed

public SignalConnection<Dialog.ClosedCallback> onClosed(Dialog.ClosedCallback handler)

Emitted when the dialog is successfully closed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Dialog.ClosedCallback.run()

emitClosed

public void emitClosed()

Emits the "closed" signal. See onClosed(org.gnome.adw.Dialog.ClosedCallback).

builder

public static Dialog.Builder<? extends Dialog.Builder> builder()

A Dialog.Builder object constructs a Dialog with the specified properties. Use the various set...() methods to set properties, and finish construction with Dialog.Builder.build().