Adw.Dialog – libadwaita-1 Reference Manual

Packages

libadwaita-1

Adw

Dialog

Dialog

Object Hierarchy:

Object hierarchy for Dialog

Description:

[ CCode ( type_id = "adw_dialog_get_type ()" ) ]
[ Version ( since = "1.5" ) ]
public class Dialog : Widget, Accessible, Buildable, ConstraintTarget, ShortcutManager

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 [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:AdwDialog: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.

All known sub-classes:

ShortcutsDialog

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public bool can_close { get; set; }
Whether the dialog can be closed.
public Widget child { get; set; }
The child widget of the `AdwDialog`.
public int content_height { get; set; }
The height of the dialog's contents.
public int content_width { get; set; }
The width of the dialog's contents.
public Breakpoint current_breakpoint { get; }
The current breakpoint.
public Widget default_widget { get; set; }
The default widget.
public Widget focus_widget { owned get; set; }
The focus widget.
public bool follows_content_size { get; set; }
Whether to size content automatically.
public DialogPresentationMode presentation_mode { get; set; }
The dialog's presentation mode.
public string title { get; set; }
The title of the dialog.

Creation methods:

public Dialog ()
Creates a new `AdwDialog`.

Methods:

public void add_breakpoint (owned Breakpoint breakpoint)
Adds breakpoint to this .
public bool close ()
Attempts to close this.
public void force_close ()
Closes this.
public bool get_can_close ()
Gets whether this can be closed.
public unowned Widget? get_child ()
Gets the child widget of this.
public int get_content_height ()
Gets the height of the dialog's contents.
public int get_content_width ()
Gets the width of the dialog's contents.
public unowned Breakpoint? get_current_breakpoint ()
Gets the current breakpoint.
public unowned Widget? get_default_widget ()
Gets the default widget for this.
public unowned Widget? get_focus ()
Gets the focus widget for this.
public bool get_follows_content_size ()
Gets whether to size content of this automatically.
public DialogPresentationMode get_presentation_mode ()
Gets presentation mode for this.
public unowned string get_title ()
Gets the title of this.
public void present (Widget? parent)
Presents this within parent's window.
public void set_can_close (bool can_close)
Sets whether this can be closed.
public void set_child (Widget? child)
Sets the child widget of this.
public void set_content_height (int content_height)
Sets the height of the dialog's contents.
public void set_content_width (int content_width)
Sets the width of the dialog's contents.
public void set_default_widget (Widget? default_widget)
Sets the default widget for this.
public void set_focus (Widget? focus)
Sets the focus widget for this.
public void set_follows_content_size (bool follows_content_size)
Sets whether to size content of this automatically.
public void set_presentation_mode (DialogPresentationMode presentation_mode)
Sets presentation mode for this.
public void set_title (string title)
Sets the title of this.

Signals:

public virtual signal void close_attempt ()
Emitted when the close button or shortcut is used, or [method@Dialog.
public virtual signal void closed ()
Emitted when the dialog is successfully closed.

Inherited Members:

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

All known members inherited from interface Gtk.Accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.ShortcutManager

add_controller

remove_controller

Generated by valadoc