Adw.MessageDialog
Description: Reference for Adw.MessageDialog

### Class

# AdwMessageDialog

deprecated: 1.6 since: 1.2

#### Description [src]

    class Adw.MessageDialog : Gtk.Window
      implements Gtk.Accessible, Gtk.Buildable, Gtk.ConstraintTarget, Gtk.Native, Gtk.Root, Gtk.ShortcutManager {
      /* No available fields */
    }

A dialog presenting a message or a question.

Message 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 `AdwMessageDialog::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 `AdwMessageDialog: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, `AdwMessageDialog` is closed automatically.

An example of using a message dialog:

    GtkWidget *dialog;

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

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

    adw_message_dialog_add_responses (ADW_MESSAGE_DIALOG (dialog),
                                      "cancel",  _("_Cancel"),
                                      "replace", _("_Replace"),
                                      NULL);

    adw_message_dialog_set_response_appearance (ADW_MESSAGE_DIALOG (dialog), "replace", ADW_RESPONSE_DESTRUCTIVE);

    adw_message_dialog_set_default_response (ADW_MESSAGE_DIALOG (dialog), "cancel");
    adw_message_dialog_set_close_response (ADW_MESSAGE_DIALOG (dialog), "cancel");

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

    gtk_window_present (GTK_WINDOW (dialog));

## Async API

`AdwMessageDialog` can also be used via the `adw_message_dialog_choose()` method. This API follows the GIO async pattern, for example:

    static void
    dialog_cb (AdwMessageDialog *dialog,
               GAsyncResult     *result,
               MyWindow         *self)
    {
      const char *response = adw_message_dialog_choose_finish (dialog, result);

      // ...
    }

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

      dialog = adw_message_dialog_new (GTK_WINDOW (self), _("Replace File?"), NULL);

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

      adw_message_dialog_add_responses (ADW_MESSAGE_DIALOG (dialog),
                                        "cancel",  _("_Cancel"),
                                        "replace", _("_Replace"),
                                        NULL);

      adw_message_dialog_set_response_appearance (ADW_MESSAGE_DIALOG (dialog), "replace", ADW_RESPONSE_DESTRUCTIVE);

      adw_message_dialog_set_default_response (ADW_MESSAGE_DIALOG (dialog), "cancel");
      adw_message_dialog_set_close_response (ADW_MESSAGE_DIALOG (dialog), "cancel");

      adw_message_dialog_choose (ADW_MESSAGE_DIALOG (dialog), NULL, (GAsyncReadyCallback) dialog_cb, self);
    }

## AdwMessageDialog as GtkBuildable

`AdwMessageDialog` 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 `adw_message_dialog_set_response_enabled()` and `adw_message_dialog_set_response_appearance()` for details.

Example of an `AdwMessageDialog` UI definition:

    <object class="AdwMessageDialog" 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>

## Accessibility

`AdwMessageDialog` uses the `GTK_ACCESSIBLE_ROLE_DIALOG` role.

Available since: 1.2

Deprecated since: 1.6

Use `AdwAlertDialog`.

#### Hierarchy

#### Ancestors

- GtkWindow
- GtkWidget
- GInitiallyUnowned
- GObject

#### Implements

- GtkAccessible
- GtkBuildable
- GtkConstraintTarget
- GtkNative
- GtkRoot
- GtkShortcutManager

#### Constructors

###### adw_message_dialog_new

Creates a new `AdwMessageDialog`.

deprecated: 1.6 since: 1.2

#### Instance methods

###### adw_message_dialog_add_response

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

deprecated: 1.6 since: 1.2

###### adw_message_dialog_add_responses

Adds multiple responses to `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_choose

This function shows `self` to the user.

deprecated: 1.6 since: 1.3

###### adw_message_dialog_choose_finish

Finishes the `adw_message_dialog_choose()` call and returns the response ID.

deprecated: 1.6 since: 1.3

###### adw_message_dialog_format_body

Sets the formatted body text of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_format_body_markup

Sets the formatted body text of `self` with Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_format_heading

Sets the formatted heading of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_format_heading_markup

Sets the formatted heading of `self` with Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_body

Gets the body text of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_body_use_markup

Gets whether the body text of `self` includes Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_close_response

Gets the ID of the close response of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_default_response

Gets the ID of the default response of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_extra_child

Gets the child widget of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_heading

Gets the heading of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_heading_use_markup

Gets whether the heading of `self` includes Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_response_appearance

Gets the appearance of `response`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_response_enabled

Gets whether `response` is enabled.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_get_response_label

Gets the label of `response`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_has_response

Gets whether `self` has a response with the ID `response`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_remove_response

Removes a response from `self`.

deprecated: 1.6 since: 1.5

###### adw_message_dialog_response

Emits the `AdwMessageDialog::response` signal with the given response ID.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_body

Sets the body text of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_body_use_markup

Sets whether the body text of `self` includes Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_close_response

Sets the ID of the close response of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_default_response

Sets the ID of the default response of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_extra_child

Sets the child widget of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_heading

Sets the heading of `self`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_heading_use_markup

Sets whether the heading of `self` includes Pango markup.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_response_appearance

Sets the appearance for `response`.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_response_enabled

Sets whether `response` is enabled.

deprecated: 1.6 since: 1.2

###### adw_message_dialog_set_response_label

Sets the label of `response` to `label`.

deprecated: 1.6 since: 1.2

##### Methods inherited from GtkWindow (57)

Please see GtkWindow for a full list of methods.

##### Methods inherited from GtkWidget (164)

Please see GtkWidget for a full list of methods.

##### Methods inherited from GObject (43)

Please see GObject for a full list of methods.

##### Methods inherited from GtkAccessible (21)

###### gtk_accessible_announce

Requests the user’s screen reader to announce the given message.

###### gtk_accessible_get_accessible_id

Retrieves the accessible identifier for the accessible object.

###### gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

###### gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

###### gtk_accessible_get_at_context

Retrieves the implementation for the given accessible object.

###### gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

###### gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

###### gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

###### gtk_accessible_get_platform_state

Queries a platform state, such as focus.

###### gtk_accessible_reset_property

Resets the accessible property to its default value.

###### gtk_accessible_reset_relation

Resets the accessible relation to its default value.

###### gtk_accessible_reset_state

Resets the accessible state to its default value.

###### gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

###### gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling.

###### gtk_accessible_update_platform_state

Informs ATs that the platform state has changed.

###### gtk_accessible_update_property

Updates a list of accessible properties.

###### gtk_accessible_update_property_value

Updates an array of accessible properties.

###### gtk_accessible_update_relation

Updates a list of accessible relations.

###### gtk_accessible_update_relation_value

Updates an array of accessible relations.

###### gtk_accessible_update_state

Updates a list of accessible states.

###### gtk_accessible_update_state_value

Updates an array of accessible states.

##### Methods inherited from GtkBuildable (1)

###### gtk_buildable_get_buildable_id

Gets the ID of the `buildable` object.

##### Methods inherited from GtkNative (5)

###### gtk_native_get_renderer

Returns the renderer that is used for this `GtkNative`.

###### gtk_native_get_surface

Returns the surface of this `GtkNative`.

###### gtk_native_get_surface_transform

Retrieves the surface transform of `self`.

###### gtk_native_realize

Realizes a `GtkNative`.

###### gtk_native_unrealize

Unrealizes a `GtkNative`.

##### Methods inherited from GtkRoot (3)

###### gtk_root_get_display

Returns the display that this `GtkRoot` is on.

###### gtk_root_get_focus

Retrieves the current focused widget within the root.

###### gtk_root_set_focus

If `focus` is not the current focus widget, and is focusable, sets it as the focus widget for the root.

#### Properties

###### Adw.MessageDialog:body

The body text of the dialog.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:body-use-markup

Whether the body text includes Pango markup.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:close-response

The ID of the close response.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:default-response

The response ID of the default response.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:extra-child

The child widget.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:heading

The heading of the dialog.

deprecated: 1.6 since: 1.2

###### Adw.MessageDialog:heading-use-markup

Whether the heading includes Pango markup.

deprecated: 1.6 since: 1.2

##### Properties inherited from GtkWindow (26)

###### Gtk.Window:application

The `GtkApplication` associated with the window.

###### Gtk.Window:child

The child widget.

###### Gtk.Window:decorated

Whether the window should have a frame (also known as decorations).

###### Gtk.Window:default-height

The default height of the window.

###### Gtk.Window:default-widget

The default widget.

###### Gtk.Window:default-width

The default width of the window.

###### Gtk.Window:deletable

Whether the window frame should have a close button.

###### Gtk.Window:destroy-with-parent

If this window should be destroyed when the parent is destroyed.

###### Gtk.Window:display

The display that will display this window.

###### Gtk.Window:focus-visible

Whether ‘focus rectangles’ are currently visible in this window.

###### Gtk.Window:focus-widget

The focus widget.

###### Gtk.Window:fullscreened

Whether the window is fullscreen.

###### Gtk.Window:gravity

The gravity to use when resizing the window programmatically.

###### Gtk.Window:handle-menubar-accel

Whether the window frame should handle `F10` for activating menubars.

###### Gtk.Window:hide-on-close

If this window should be hidden instead of destroyed when the user clicks the close button.

###### Gtk.Window:icon-name

Specifies the name of the themed icon to use as the window icon.

###### Gtk.Window:is-active

Whether the toplevel is the currently active window.

###### Gtk.Window:maximized

Whether the window is maximized.

###### Gtk.Window:mnemonics-visible

Whether mnemonics are currently visible in this window.

###### Gtk.Window:modal

If true, the window is modal.

###### Gtk.Window:resizable

If true, users can resize the window.

###### Gtk.Window:startup-id

A write-only property for setting window’s startup notification identifier.

###### Gtk.Window:suspended

Whether the window is suspended.

###### Gtk.Window:title

The title of the window.

###### Gtk.Window:titlebar

The titlebar widget.

###### Gtk.Window:transient-for

The transient parent of the window.

##### Properties inherited from GtkWidget (35)

###### Gtk.Widget:can-focus

Whether the widget or any of its descendents can accept the input focus.

###### Gtk.Widget:can-target

Whether the widget can receive pointer events.

###### Gtk.Widget:css-classes

A list of css classes applied to this widget.

###### Gtk.Widget:css-name

The name of this widget in the CSS tree.

###### Gtk.Widget:cursor

The cursor used by `widget`.

###### Gtk.Widget:focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

###### Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

###### Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

###### Gtk.Widget:has-default

Whether the widget is the default widget.

###### Gtk.Widget:has-focus

Whether the widget has the input focus.

###### Gtk.Widget:has-tooltip

Enables or disables the emission of the `GtkWidget::query-tooltip` signal on `widget`.

###### Gtk.Widget:height-request

Overrides for height request of the widget.

###### Gtk.Widget:hexpand

Whether to expand horizontally.

###### Gtk.Widget:hexpand-set

Whether to use the `hexpand` property.

###### Gtk.Widget:layout-manager

The `GtkLayoutManager` instance to use to compute the preferred size of the widget, and allocate its children.

###### Gtk.Widget:limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

###### Gtk.Widget:margin-bottom

Margin on bottom side of widget.

###### Gtk.Widget:margin-end

Margin on end of widget, horizontally.

###### Gtk.Widget:margin-start

Margin on start of widget, horizontally.

###### Gtk.Widget:margin-top

Margin on top side of widget.

###### Gtk.Widget:name

The name of the widget.

###### Gtk.Widget:opacity

The requested opacity of the widget.

###### Gtk.Widget:overflow

How content outside the widget’s content area is treated.

###### Gtk.Widget:parent

The parent widget of this widget.

###### Gtk.Widget:receives-default

Whether the widget will receive the default action when it is focused.

###### Gtk.Widget:root

The `GtkRoot` widget of the widget tree containing this widget.

###### Gtk.Widget:scale-factor

The scale factor of the widget.

###### Gtk.Widget:sensitive

Whether the widget responds to input.

###### Gtk.Widget:tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

###### Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

###### Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

###### Gtk.Widget:vexpand

Whether to expand vertically.

###### Gtk.Widget:vexpand-set

Whether to use the `vexpand` property.

###### Gtk.Widget:visible

Whether the widget is visible.

###### Gtk.Widget:width-request

Overrides for width request of the widget.

##### Properties inherited from GtkAccessible (1)

###### Gtk.Accessible:accessible-role

The accessible role of the given `GtkAccessible` implementation.

#### Signals

###### Adw.MessageDialog::response

This signal is emitted when the dialog is closed.

deprecated: 1.6 since: 1.2

##### Signals inherited from GtkWindow (5)

###### GtkWindow::activate-default

Emitted when the user activates the default widget.

###### GtkWindow::activate-focus

Emitted when the user activates the currently focused widget of `window`.

###### GtkWindow::close-request

Emitted when the user clicks on the close button of the window.

###### GtkWindow::enable-debugging

Emitted when the user enables or disables interactive debugging.

###### GtkWindow::keys-changed

Emitted when the set of accelerators or mnemonics that are associated with the window changes.

##### Signals inherited from GtkWidget (13)

###### GtkWidget::destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

###### GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

###### GtkWidget::hide

Emitted when `widget` is hidden.

###### GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

###### GtkWidget::map

Emitted when `widget` is going to be mapped.

###### GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

###### GtkWidget::move-focus

Emitted when the focus is moved.

###### GtkWidget::query-tooltip

Emitted when the widget’s tooltip is about to be shown.

###### GtkWidget::realize

Emitted when `widget` is associated with a `GdkSurface`.

###### GtkWidget::show

Emitted when `widget` is shown.

###### GtkWidget::state-flags-changed

Emitted when the widget state changes.

###### GtkWidget::unmap

Emitted when `widget` is going to be unmapped.

###### GtkWidget::unrealize

Emitted when the `GdkSurface` associated with `widget` is destroyed.

##### Signals inherited from GObject (1)

###### GObject::notify

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

#### Class structure

    struct AdwMessageDialogClass {
      GtkWindowClass parent_class;
      void (* response) (
        AdwMessageDialog* self,
        const char* response
      );

    }

No description available.

###### Class members

`parent_class: GtkWindowClass`

  No description available.

`response: void (* response) ( AdwMessageDialog* self, const char* response )`

  No description available.

#### Virtual methods

###### Adw.MessageDialogClass.response

Emits the `AdwMessageDialog::response` signal with the given response ID.

deprecated: 1.6 since: 1.2