Adw.AlertDialog – libadwaita-1 Reference Manual

Packages

libadwaita-1

Adw

AlertDialog

AlertDialog

Object Hierarchy:

Object hierarchy for AlertDialog

Description:

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

A dialog presenting a message or a question.

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

Alert dialogs have a heading, a body, an optional child widget, and one or multiple responses, each presented as a button.

Each response has a unique string ID, and a button label. Additionally, each response can be enabled or disabled, and can have a suggested or destructive appearance.

When one of the responses is activated, or the dialog is closed, the [signal@AlertDialog:AdwAlertDialog:response] signal will be emitted. This signal is detailed, and the detail, as well as the `response` parameter will be set to the ID of the activated response, or to the value of the [property@AlertDialog:close-response] property if the dialog had been closed without activating any of the responses.

Response buttons can be presented horizontally or vertically depending on available space.

When a response is activated, `AdwAlertDialog` is closed automatically.

An example of using an alert dialog:

```c AdwDialog *dialog;

dialog = adw_alert_dialog_new (_("Replace File?"), NULL);

adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog), _("A file named “s” already exists. Do you want to replace it?"), filename);

adw_alert_dialog_add_responses (ADW_ALERT_DIALOG (dialog), "cancel", _("_Cancel"), "replace", _("_Replace"), NULL);

adw_alert_dialog_set_response_appearance (ADW_ALERT_DIALOG (dialog), "replace", ADW_RESPONSE_DESTRUCTIVE);

adw_alert_dialog_set_default_response (ADW_ALERT_DIALOG (dialog), "cancel"); adw_alert_dialog_set_close_response (ADW_ALERT_DIALOG ( dialog), "cancel");

g_signal_connect (dialog, "response", G_CALLBACK (response_cb), self);

adw_dialog_present (dialog, parent); ```

Async API

`AdwAlertDialog` can also be used via the [method@AlertDialog.choose] method. This API follows the GIO async pattern, for example:

```c static void dialog_cb (AdwAlertDialog *dialog, GAsyncResult *result, MyWindow *self) { const char *response = adw_alert_dialog_choose_finish (dialog, result);

// ... }

static void show_dialog (MyWindow *self) { AdwDialog *dialog;

dialog = adw_alert_dialog_new (_("Replace File?"), NULL);

adw_alert_dialog_format_body (ADW_ALERT_DIALOG (dialog), _("A file named “s” already exists. Do you want to replace it?"), filename);

adw_alert_dialog_add_responses (ADW_ALERT_DIALOG (dialog), "cancel", _("_Cancel"), "replace", _("_Replace"), NULL);

adw_alert_dialog_set_response_appearance (ADW_ALERT_DIALOG (dialog), "replace", ADW_RESPONSE_DESTRUCTIVE);

adw_alert_dialog_set_default_response (ADW_ALERT_DIALOG (dialog), "cancel"); adw_alert_dialog_set_close_response (ADW_ALERT_DIALOG ( dialog), "cancel");

adw_alert_dialog_choose (ADW_ALERT_DIALOG (dialog), GTK_WIDGET (self), NULL, (GAsyncReadyCallback) dialog_cb, self); } ```

AdwAlertDialog as GtkBuildable

`AdwAlertDialog` supports adding responses in UI definitions by via the `<responses>` element that may contain multiple `< response>` elements, each representing a response.

Each of the `<response>` elements must have the `id` attribute specifying the response ID. The contents of the element are used as the response label.

Response labels can be translated with the usual `translatable`, `context` and `comments` attributes.

The `<response>` elements can also have `enabled` and/or `appearance` attributes. See [method@AlertDialog.set_response_enabled] and [method@AlertDialog.set_response_appearance] for details.

Example of an `AdwAlertDialog` UI definition:

```xml <object class="AdwAlertDialog" id="dialog"> <property name="heading" translatable="yes">Save Changes?</property > <property name="body" translatable="yes">Open documents contain unsaved changes. Changes which are not saved will be permanently lost.</property> <property name="default-response">save</property> <property name="close-response"> cancel</property> <signal name="response" handler="response_cb"/> <responses> <response id="cancel" translatable="yes">_Cancel</response> <response id="discard" translatable="yes" appearance="destructive">_Discard< /response> <response id="save" translatable="yes" appearance="suggested" enabled="false">_Save</response> </responses > </object> ```

Namespace: Adw

Package: libadwaita-1

Content:

Properties:

public string body { get; set; }
The body text of the dialog.
public bool body_use_markup { get; set; }
Whether the body text includes Pango markup.
public string close_response { get; set; }
The ID of the close response.
public string default_response { get; set; }
The response ID of the default response.
public Widget extra_child { get; set; }
The child widget.
public string heading { get; set; }
The heading of the dialog.
public bool heading_use_markup { get; set; }
Whether the heading includes Pango markup.
public bool prefer_wide_layout { get; set; }
Whether to prefer horizontal button layout.

Creation methods:

public AlertDialog (string? heading, string? body)
Creates a new `AdwAlertDialog`.

Methods:

public void add_response (string id, string label)
Adds a response with id and label to this.
public void add_responses (...)
Adds multiple responses to this.
public async unowned string choose (Widget? parent, Cancellable? cancellable)
This function shows this to the user.
public void format_body (string format, ...)
Sets the formatted body text of this .
public void format_body_markup (string format, ...)
Sets the formatted body text of this with Pango markup.
public void format_heading (string format, ...)
Sets the formatted heading of this.
public void format_heading_markup (string format, ...)
Sets the formatted heading of this with Pango markup.
public unowned string get_body ()
Gets the body text of this.
public bool get_body_use_markup ()
Gets whether the body text of this includes Pango markup.
public unowned string get_close_response ()
Gets the ID of the close response of this .
public unowned string? get_default_response ()
Gets the ID of the default response of this .
public unowned Widget? get_extra_child ()
Gets the child widget of this.
public unowned string? get_heading ()
Gets the heading of this.
public bool get_heading_use_markup ()
Gets whether the heading of this includes Pango markup.
public bool get_prefer_wide_layout ()
Gets whether this prefers horizontal button layout.
public ResponseAppearance get_response_appearance (string response)
Gets the appearance of response.
public bool get_response_enabled (string response)
Gets whether response is enabled.
public unowned string get_response_label (string response)
Gets the label of response.
public bool has_response (string response)
Gets whether this has a response with the ID response.
public void remove_response (string id)
Removes a response from this.
public void set_body (string body)
Sets the body text of this.
public void set_body_use_markup (bool use_markup)
Sets whether the body text of this includes Pango markup.
public void set_close_response (string response)
Sets the ID of the close response of this .
public void set_default_response (string? response)
Sets the ID of the default response of this .
public void set_extra_child (Widget? child)
Sets the child widget of this.
public void set_heading (string? heading)
Sets the heading of this.
public void set_heading_use_markup (bool use_markup)
Sets whether the heading of this includes Pango markup.
public void set_prefer_wide_layout (bool prefer_wide_layout)
Whether to prefer horizontal button layout.
public void set_response_appearance (string response, ResponseAppearance appearance)
Sets the appearance for response.
public void set_response_enabled (string response, bool enabled)
Sets whether response is enabled.
public void set_response_label (string response, string label)
Sets the label of response to label.

Signals:

public virtual signal void response (string response)
This signal is emitted when the dialog is closed.

Inherited Members:

All known members inherited from class Adw.Dialog

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