adwaita/org.gtkkn.bindings.adw/AlertDialog

AlertDialog

open class AlertDialog(pointer: <Error class: unknown class><<Error class: unknown class>>) : Dialog

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 signal@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, AdwAlertDialog is closed automatically.

An example of using an alert dialog:

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:

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:

<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>

Since

1.5

Constructors

AlertDialog

constructor(heading: String? = null, body: String? = null)

Creates a new AdwAlertDialog.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

adwAlertDialogPointer

val adwAlertDialogPointer: <Error class: unknown class><<Error class: unknown class>>

adwDialogPointer

val adwDialogPointer: <Error class: unknown class><<Error class: unknown class>>

body

open var body: String

The body text of the dialog.

bodyUseMarkup

open var bodyUseMarkup: Boolean

Whether the body text includes Pango markup.

canClose

open var canClose: Boolean

Whether the dialog can be closed.

child

open var child: <Error class: unknown class>?

The child widget of the AdwDialog.

closeResponse

open var closeResponse: String

The ID of the close response.

contentHeight

open var contentHeight: Int

The height of the dialog's contents.

contentWidth

open var contentWidth: Int

The width of the dialog's contents.

currentBreakpoint

open val currentBreakpoint: Breakpoint?

The current breakpoint.

defaultResponse

open var defaultResponse: String?

The response ID of the default response.

defaultWidget

open var defaultWidget: <Error class: unknown class>?

The default widget.

extraChild

open var extraChild: <Error class: unknown class>?

The child widget.

focusWidget

open var focusWidget: <Error class: unknown class>?

The focus widget.

followsContentSize

open var followsContentSize: Boolean

Whether to size content automatically.

gtkAccessiblePointer

open override val gtkAccessiblePointer: <Error class: unknown class><<Error class: unknown class>>

gtkBuildablePointer

open override val gtkBuildablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkConstraintTargetPointer

open override val gtkConstraintTargetPointer: <Error class: unknown class><<Error class: unknown class>>

heading

open var heading: String?

The heading of the dialog.

headingUseMarkup

open var headingUseMarkup: Boolean

Whether the heading includes Pango markup.

preferWideLayout

open var preferWideLayout: Boolean

Whether to prefer wide layout.

presentationMode

open var presentationMode: DialogPresentationMode

The dialog's presentation mode.

title

open var title: String

The title of the dialog.

Functions

addBreakpoint

open fun addBreakpoint(breakpoint: Breakpoint)

Adds @breakpoint to @self.

addResponse

open fun addResponse(id: String, label: String)

Adds a response with @id and @label to @self.

choose

open fun choose(parent: <Error class: unknown class>? = null, cancellable: <Error class: unknown class>? = null, callback: <Error class: unknown class>)

This function shows @self to the user.

chooseFinish