class Adw::AlertDialog

• Adw::AlertDialog
• Adw::Dialog
• Gtk::Widget
• GObject::InitiallyUnowned
• GObject::Object
• Reference
• Object

Overview

A dialog presenting a message or a question.

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 AlertDialog::#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, Adw::AlertDialog is closed automatically.

An example of using an alert dialog:

WARNING ⚠️ The following code is in c ⚠️

Adw::Dialog *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

Adw::AlertDialog can also be used via the AlertDialog::choose method. This API follows the GIO async pattern, for example:

WARNING ⚠️ The following code is in c ⚠️

static void
dialog_cb (Adw::AlertDialog *dialog,
           GAsyncResult   *result,
           MyWindow       *self)
{
  const char *response = adw_alert_dialog_choose_finish (dialog, result);

  // ...
}

static void
show_dialog (MyWindow *self)
{
  Adw::Dialog *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);
}

Adw::AlertDialog as Gtk::Buildable

Adw::AlertDialog 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 AlertDialog#response_enabled= and AlertDialog#response_appearance= for details.

Example of an Adw::AlertDialog UI definition:

WARNING ⚠️ The following code is in xml ⚠️

<object class="Adw::AlertDialog" 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>

Included Modules

• Gtk::Accessible
• Gtk::Buildable
• Gtk::ConstraintTarget
• Gtk::ShortcutManager

Defined in:

Constructors

• .new(heading : String | Nil, body : String | Nil) : self

  Creates a new Adw::AlertDialog.

• .new

  Initialize a new AlertDialog.

• .new(*, accessible_role : Gtk::AccessibleRole | Nil = nil, body : String | Nil = nil, body_use_markup : Bool | Nil = nil, can_close : Bool | Nil = nil, can_focus : Bool | Nil = nil, can_target : Bool | Nil = nil, child : Gtk::Widget | Nil = nil, close_response : String | Nil = nil, content_height : Int32 | Nil = nil, content_width : Int32 | Nil = nil, css_classes : Enumerable(String) | Nil = nil, css_name : String | Nil = nil, current_breakpoint : Adw::Breakpoint | Nil = nil, cursor : Gdk::Cursor | Nil = nil, default_response : String | Nil = nil, default_widget : Gtk::Widget | Nil = nil, extra_child : Gtk::Widget | Nil = nil, focus_on_click : Bool | Nil = nil, focus_widget : Gtk::Widget | Nil = nil, focusable : Bool | Nil = nil, follows_content_size : Bool | Nil = nil, halign : Gtk::Align | Nil = nil, has_default : Bool | Nil = nil, has_focus : Bool | Nil = nil, has_tooltip : Bool | Nil = nil, heading : String | Nil = nil, heading_use_markup : Bool | Nil = nil, height_request : Int32 | Nil = nil, hexpand : Bool | Nil = nil, hexpand_set : Bool | Nil = nil, layout_manager : Gtk::LayoutManager | Nil = nil, limit_events : Bool | Nil = nil, margin_bottom : Int32 | Nil = nil, margin_end : Int32 | Nil = nil, margin_start : Int32 | Nil = nil, margin_top : Int32 | Nil = nil, name : String | Nil = nil, opacity : Float64 | Nil = nil, overflow : Gtk::Overflow | Nil = nil, parent : Gtk::Widget | Nil = nil, prefer_wide_layout : Bool | Nil = nil, presentation_mode : Adw::DialogPresentationMode | Nil = nil, receives_default : Bool | Nil = nil, root : Gtk::Root | Nil = nil, scale_factor : Int32 | Nil = nil, sensitive : Bool | Nil = nil, title : String | Nil = nil, tooltip_markup : String | Nil = nil, tooltip_text : String | Nil = nil, valign : Gtk::Align | Nil = nil, vexpand : Bool | Nil = nil, vexpand_set : Bool | Nil = nil, visible : Bool | Nil = nil, width_request : Int32 | Nil = nil)

Class Method Summary

• .g_type : UInt64

  Returns the type id (GType) registered in GLib type system.

Instance Method Summary

• #==(other : self)

  Returns true if this reference is the same as other.

• #add_response(id : String, label : String) : Nil

  Adds a response with id and label to self.

• #body : String

  Gets the body text of self.

• #body=(body : String) : Nil

  Sets the body text of self.

• #body=(value : Nil) : Nil

  Set #body property to nil.

• #body? : String | Nil

  Same as #body, but can return nil.

• #body_use_markup : Bool

  Gets whether the body text of self includes Pango markup.

• #body_use_markup=(use_markup : Bool) : Nil

  Sets whether the body text of self includes Pango markup.

• #body_use_markup? : Bool
• #choose(parent : Gtk::Widget | Nil, cancellable : Gio::Cancellable | Nil, &callback : Gio::AsyncReadyCallback) : Nil

  This function shows self to the user.

• #choose_finish(result : Gio::AsyncResult) : String

  Finishes the AlertDialog::choose call and returns the response ID.

• #close_response : String

  Gets the ID of the close response of self.

• #close_response=(response : String) : Nil

  Sets the ID of the close response of self.

• #close_response=(value : Nil) : Nil

  Set #close_response property to nil.

• #close_response? : String | Nil

  Same as #close_response, but can return nil.

• #default_response : String | Nil

  Gets the ID of the default response of self.

• #default_response=(value : String) : String
• #default_response=(value : Nil) : Nil

  Set #default_response property to nil.

• #default_response=(response : String | Nil) : Nil

  Sets the ID of the default response of self.

• #default_response? : String | Nil

  Same as #default_response, but can return nil.

• #extra_child : Gtk::Widget | Nil

  Gets the child widget of self.

• #extra_child=(child : Gtk::Widget | Nil) : Nil

  Sets the child widget of self.

• #has_response(response : String) : Bool

  Gets whether self has a response with the ID response.

• #hash(hasher)

  See Object#hash(hasher)

• #heading : String | Nil

  Gets the heading of self.

• #heading=(value : String) : String
• #heading=(value : Nil) : Nil

  Set #heading property to nil.

• #heading=(heading : String | Nil) : Nil

  Sets the heading of self.

• #heading? : String | Nil

  Same as #heading, but can return nil.

• #heading_use_markup : Bool

  Gets whether the heading of self includes Pango markup.

• #heading_use_markup=(use_markup : Bool) : Nil

  Sets whether the heading of self includes Pango markup.

• #heading_use_markup? : Bool
• #prefer_wide_layout : Bool

  Gets whether self prefers wide layout.

• #prefer_wide_layout=(prefer_wide_layout : Bool) : Nil

  Sets whether self prefers wide layout.

• #prefer_wide_layout? : Bool
• #remove_response(id : String) : Nil

  Removes a response from self.

• #response_appearance(response : String) : Adw::ResponseAppearance

  Gets the appearance of response.

• #response_enabled(response : String) : Bool

  Gets whether response is enabled.

• #response_label(response : String) : String

  Gets the label of response.

• #response_signal
• #set_response_appearance(response : String, appearance : Adw::ResponseAppearance) : Nil

  Sets the appearance for response.

• #set_response_enabled(response : String, enabled : Bool) : Nil

  Sets whether response is enabled.

• #set_response_label(response : String, label : String) : Nil

  Sets the label of response to label.

Constructor Detail

Adw::Dialog *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);

Class Method Detail

Instance Method Detail

def set_response_appearance(response : String, appearance : Adw::ResponseAppearance) : Nil #

Sets the appearance for response.

Use ADW_RESPONSE_SUGGESTED to mark important responses such as the affirmative action, like the Save button in the example.

Use ADW_RESPONSE_DESTRUCTIVE to draw attention to the potentially damaging consequences of using response. This appearance acts as a warning to the user. The Discard button in the example is using this appearance.

The default appearance is ADW_RESPONSE_DEFAULT.

Negative responses like Cancel or Close should use the default appearance.