Class

AdwMessageDialog

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

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, and the result can be obtained by calling adw_message_dialog_choose_finish(), 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 respresenting 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

Hierarchy

hierarchy this AdwMessageDialog implements_0 GtkAccessible this--implements_0 implements_1 GtkBuildable this--implements_1 implements_2 GtkConstraintTarget this--implements_2 implements_3 GtkNative this--implements_3 implements_4 GtkRoot this--implements_4 implements_5 GtkShortcutManager this--implements_5 ancestor_0 GtkWindow ancestor_0--this ancestor_1 GtkWidget ancestor_1--ancestor_0 ancestor_2 GInitiallyUnowned ancestor_2--ancestor_1 ancestor_3 GObject ancestor_3--ancestor_2

Constructors

adw_message_dialog_new

Creates a new AdwMessageDialog.

since: 1.2

Instance methods

adw_message_dialog_add_response

Adds a response with id and label to self.

since: 1.2

adw_message_dialog_add_responses

Adds multiple responses to self.

since: 1.2

adw_message_dialog_choose

This function shows self to the user.

since: 1.3

adw_message_dialog_choose_finish

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

since: 1.3

adw_message_dialog_format_body

Sets the formatted body text of self.

since: 1.2

adw_message_dialog_format_body_markup

Sets the formatted body text of self with Pango markup.

since: 1.2

adw_message_dialog_format_heading

Sets the formatted heading of self.

since: 1.2

adw_message_dialog_format_heading_markup

Sets the formatted heading of self with Pango markup.

since: 1.2

adw_message_dialog_get_body

Gets the body text of self.

since: 1.2

adw_message_dialog_get_body_use_markup

Gets whether the body text of self includes Pango markup.

since: 1.2

adw_message_dialog_get_close_response

Gets the ID of the close response of self.

since: 1.2

adw_message_dialog_get_default_response

Gets the ID of the default response of self.

since: 1.2

adw_message_dialog_get_extra_child

Gets the child widget of self.

since: 1.2

adw_message_dialog_get_heading

Gets the heading of self.

since: 1.2

adw_message_dialog_get_heading_use_markup

Gets whether the heading of self includes Pango markup.

since: 1.2

adw_message_dialog_get_response_appearance

Gets the appearance of response.

since: 1.2

adw_message_dialog_get_response_enabled

Gets whether response is enabled.

since: 1.2

adw_message_dialog_get_response_label

Gets the label of response.

since: 1.2

adw_message_dialog_has_response

Gets whether self has a response with the ID response.

since: 1.2

adw_message_dialog_response

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

since: 1.2

adw_message_dialog_set_body

Sets the body text of self.

since: 1.2

adw_message_dialog_set_body_use_markup

Sets whether the body text of self includes Pango markup.

since: 1.2

adw_message_dialog_set_close_response

Sets the ID of the close response of self.

since: 1.2

adw_message_dialog_set_default_response

Sets the ID of the default response of self.

since: 1.2

adw_message_dialog_set_extra_child

Sets the child widget of self.

since: 1.2

adw_message_dialog_set_heading

Sets the heading of self.

since: 1.2

adw_message_dialog_set_heading_use_markup

Sets whether the heading of self includes Pango markup.

since: 1.2

adw_message_dialog_set_response_appearance

Sets the appearance for response.

since: 1.2

adw_message_dialog_set_response_enabled

Sets whether response is enabled.

since: 1.2

adw_message_dialog_set_response_label

Sets the label of response to label.

since: 1.2

Methods inherited from GtkWindow (55)

Please see GtkWindow for a full list of methods.

Methods inherited from GtkWidget (162)

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 (18)
gtk_accessible_get_accessible_parent

Retrieves the accessible parent for an accessible object.

unstable since: 4.10

gtk_accessible_get_accessible_role

Retrieves the accessible role of an accessible object.

unstable since: 4.0

gtk_accessible_get_at_context

Retrieves the accessible implementation for the given GtkAccessible.

unstable since: 4.10

gtk_accessible_get_bounds

Queries the coordinates and dimensions of this accessible.

unstable since: 4.10

gtk_accessible_get_first_accessible_child

Retrieves the first accessible child of an accessible object.

unstable since: 4.10

gtk_accessible_get_next_accessible_sibling

Retrieves the next accessible sibling of an accessible object.

unstable since: 4.10

gtk_accessible_get_platform_state

Query a platform state, such as focus.

unstable since: 4.10

gtk_accessible_reset_property

Resets the accessible property to its default value.

unstable since: 4.0

gtk_accessible_reset_relation

Resets the accessible relation to its default value.

unstable since: 4.0

gtk_accessible_reset_state

Resets the accessible state to its default value.

unstable since: 4.0

gtk_accessible_set_accessible_parent

Sets the parent and sibling of an accessible object.

unstable since: 4.10

gtk_accessible_update_next_accessible_sibling

Updates the next accessible sibling of self.

unstable since: 4.10

gtk_accessible_update_property

Updates a list of accessible properties.

unstable since: 4.0

gtk_accessible_update_property_value

Updates an array of accessible properties.

unstable since: 4.0

gtk_accessible_update_relation

Updates a list of accessible relations.

unstable since: 4.0

gtk_accessible_update_relation_value

Updates an array of accessible relations.

unstable since: 4.0

gtk_accessible_update_state

Updates a list of accessible states. See the GtkAccessibleState documentation for the value types of accessible states.

unstable since: 4.0

gtk_accessible_update_state_value

Updates an array of accessible states.

unstable since: 4.0

Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id

Gets the ID of the buildable object.

unstable since: 4.0

Methods inherited from GtkNative (5)
gtk_native_get_renderer

Returns the renderer that is used for this GtkNative.

unstable since: 4.0

gtk_native_get_surface

Returns the surface of this GtkNative.

unstable since: 4.0

gtk_native_get_surface_transform

Retrieves the surface transform of self.

unstable since: 4.0

gtk_native_realize

Realizes a GtkNative.

unstable since: 4.0

gtk_native_unrealize

Unrealizes a GtkNative.

unstable since: 4.0

Methods inherited from GtkRoot (3)
gtk_root_get_display

Returns the display that this GtkRoot is on.

unstable since: 4.0

gtk_root_get_focus

Retrieves the current focused widget within the root.

unstable since: 4.0

gtk_root_set_focus

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

unstable since: 4.0

Properties

Adw.MessageDialog:body

The body text of the dialog.

since: 1.2

Adw.MessageDialog:body-use-markup

Whether the body text includes Pango markup.

since: 1.2

Adw.MessageDialog:close-response

The ID of the close response.

since: 1.2

Adw.MessageDialog:default-response

The response ID of the default response.

since: 1.2

Adw.MessageDialog:extra-child

The child widget.

since: 1.2

Adw.MessageDialog:heading

The heading of the dialog.

since: 1.2

Adw.MessageDialog:heading-use-markup

Whether the heading includes Pango markup.

since: 1.2

Properties inherited from GtkWindow (25)
Gtk.Window:application

The GtkApplication associated with the window.

unstable since: 4.0

Gtk.Window:child

The child widget.

unstable since: 4.0

Gtk.Window:decorated

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

unstable since: 4.0

Gtk.Window:default-height

The default height of the window.

unstable since: 4.0

Gtk.Window:default-widget

The default widget.

unstable since: 4.0

Gtk.Window:default-width

The default width of the window.

unstable since: 4.0

Gtk.Window:deletable

Whether the window frame should have a close button.

unstable since: 4.0

Gtk.Window:destroy-with-parent

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

unstable since: 4.0

Gtk.Window:display

The display that will display this window.

unstable since: 4.0

Gtk.Window:focus-visible

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

unstable since: 4.0

Gtk.Window:focus-widget

The focus widget.

unstable since: 4.0

Gtk.Window:fullscreened

Whether the window is fullscreen.

unstable since: 4.0

Gtk.Window:handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

unstable since: 4.2

Gtk.Window:hide-on-close

If this window should be hidden when the users clicks the close button.

unstable since: 4.0

Gtk.Window:icon-name

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

unstable since: 4.0

Gtk.Window:is-active

Whether the toplevel is the currently active window.

unstable since: 4.0

Gtk.Window:maximized

Whether the window is maximized.

unstable since: 4.0

Gtk.Window:mnemonics-visible

Whether mnemonics are currently visible in this window.

unstable since: 4.0

Gtk.Window:modal

If TRUE, the window is modal.

unstable since: 4.0

Gtk.Window:resizable

If TRUE, users can resize the window.

unstable since: 4.0

Gtk.Window:startup-id

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

unstable since: 4.0

Gtk.Window:suspended

Whether the window is suspended.

unstable since: 4.12

Gtk.Window:title

The title of the window.

unstable since: 4.0

Gtk.Window:titlebar

The titlebar widget.

unstable since: 4.6

Gtk.Window:transient-for

The transient parent of the window.

unstable since: 4.0

Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus

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

unstable since: 4.0

Gtk.Widget:can-target

Whether the widget can receive pointer events.

unstable since: 4.0

Gtk.Widget:css-classes

A list of css classes applied to this widget.

unstable since: 4.0

Gtk.Widget:css-name

The name of this widget in the CSS tree.

unstable since: 4.0

Gtk.Widget:cursor

The cursor used by widget.

unstable since: 4.0

Gtk.Widget:focus-on-click

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

unstable since: 4.0

Gtk.Widget:focusable

Whether this widget itself will accept the input focus.

unstable since: 4.0

Gtk.Widget:halign

How to distribute horizontal space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:has-default

Whether the widget is the default widget.

unstable since: 4.0

Gtk.Widget:has-focus

Whether the widget has the input focus.

unstable since: 4.0

Gtk.Widget:has-tooltip

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

unstable since: 4.0

Gtk.Widget:height-request

Override for height request of the widget.

unstable since: 4.0

Gtk.Widget:hexpand

Whether to expand horizontally.

unstable since: 4.0

Gtk.Widget:hexpand-set

Whether to use the hexpand property.

unstable since: 4.0

Gtk.Widget:layout-manager

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

unstable since: 4.0

Gtk.Widget:margin-bottom

Margin on bottom side of widget.

unstable since: 4.0

Gtk.Widget:margin-end

Margin on end of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-start

Margin on start of widget, horizontally.

unstable since: 4.0

Gtk.Widget:margin-top

Margin on top side of widget.

unstable since: 4.0

Gtk.Widget:name

The name of the widget.

unstable since: 4.0

Gtk.Widget:opacity

The requested opacity of the widget.

unstable since: 4.0

Gtk.Widget:overflow

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

unstable since: 4.0

Gtk.Widget:parent

The parent widget of this widget.

unstable since: 4.0

Gtk.Widget:receives-default

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

unstable since: 4.0

Gtk.Widget:root

The GtkRoot widget of the widget tree containing this widget.

unstable since: 4.0

Gtk.Widget:scale-factor

The scale factor of the widget.

unstable since: 4.0

Gtk.Widget:sensitive

Whether the widget responds to input.

unstable since: 4.0

Gtk.Widget:tooltip-markup

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

unstable since: 4.0

Gtk.Widget:tooltip-text

Sets the text of tooltip to be the given string.

unstable since: 4.0

Gtk.Widget:valign

How to distribute vertical space if widget gets extra space.

unstable since: 4.0

Gtk.Widget:vexpand

Whether to expand vertically.

unstable since: 4.0

Gtk.Widget:vexpand-set

Whether to use the vexpand property.

unstable since: 4.0

Gtk.Widget:visible

Whether the widget is visible.

unstable since: 4.0

Gtk.Widget:width-request

Override for width request of the widget.

unstable since: 4.0

Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role

The accessible role of the given GtkAccessible implementation.

unstable since: 4.0

Signals

Adw.MessageDialog::response

This signal is emitted when the dialog is closed.

since: 1.2

Signals inherited from GtkWindow (5)
GtkWindow::activate-default

Emitted when the user activates the default widget of window.

unstable since: 4.0

GtkWindow::activate-focus

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

unstable since: 4.0

GtkWindow::close-request

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

unstable since: 4.0

GtkWindow::enable-debugging

Emitted when the user enables or disables interactive debugging.

unstable since: 4.0

GtkWindow::keys-changed

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

unstable deprecated: 4.10 since: 4.0

Signals inherited from GtkWidget (13)
GtkWidget::destroy

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

unstable since: 4.0

GtkWidget::direction-changed

Emitted when the text direction of a widget changes.

unstable since: 4.0

GtkWidget::hide

Emitted when widget is hidden.

unstable since: 4.0

GtkWidget::keynav-failed

Emitted if keyboard navigation fails.

unstable since: 4.0

GtkWidget::map

Emitted when widget is going to be mapped.

unstable since: 4.0

GtkWidget::mnemonic-activate

Emitted when a widget is activated via a mnemonic.

unstable since: 4.0

GtkWidget::move-focus

Emitted when the focus is moved.

unstable since: 4.0

GtkWidget::query-tooltip

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

unstable since: 4.0

GtkWidget::realize

Emitted when widget is associated with a GdkSurface.

unstable since: 4.0

GtkWidget::show

Emitted when widget is shown.

unstable since: 4.0

GtkWidget::state-flags-changed

Emitted when the widget state changes.

unstable since: 4.0

GtkWidget::unmap

Emitted when widget is going to be unmapped.

unstable since: 4.0

GtkWidget::unrealize

Emitted when the GdkSurface associated with widget is destroyed.

unstable since: 4.0

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.

unstable since: 2.0

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.

since: 1.2