Struct gtk4::MessageDialog

#[repr(transparent)]
pub struct MessageDialog { /* private fields */ }

Use AlertDialog instead MessageDialog presents a dialog with some message text.

It’s simply a convenience widget; you could construct the equivalent of MessageDialog from Dialog without too much effort, but MessageDialog saves typing.

The easiest way to do a modal message dialog is to use the DialogFlags::MODAL flag, which will call GtkWindowExt::set_modal() internally. The dialog will prevent interaction with the parent window until it’s hidden or destroyed. You can use the response signal to know when the user dismissed the dialog.

An example for using a modal dialog: ⚠️ The following code is in c ⚠️

GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT | GTK_DIALOG_MODAL;
dialog = gtk_message_dialog_new (parent_window,
                                 flags,
                                 GTK_MESSAGE_ERROR,
                                 GTK_BUTTONS_CLOSE,
                                 "Error reading “%s”: %s",
                                 filename,
                                 g_strerror (errno));
// Destroy the dialog when the user responds to it
// (e.g. clicks a button)

g_signal_connect (dialog, "response",
                  G_CALLBACK (gtk_window_destroy),
                  NULL);

You might do a non-modal MessageDialog simply by omitting the DialogFlags::MODAL flag:

⚠️ The following code is in c ⚠️

GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
dialog = gtk_message_dialog_new (parent_window,
                                 flags,
                                 GTK_MESSAGE_ERROR,
                                 GTK_BUTTONS_CLOSE,
                                 "Error reading “%s”: %s",
                                 filename,
                                 g_strerror (errno));

// Destroy the dialog when the user responds to it
// (e.g. clicks a button)
g_signal_connect (dialog, "response",
                  G_CALLBACK (gtk_window_destroy),
                  NULL);

GtkMessageDialog as GtkBuildable

The MessageDialog implementation of the Buildable interface exposes the message area as an internal child with the name “message_area”.

Properties

buttons

Writeable | Construct Only

message-area

The Box that corresponds to the message area of this dialog.

See MessageDialog::message_area() for a detailed description of this area.

Readable

message-type

The type of the message.

Readable | Writeable | Construct

secondary-text

The secondary text of the message dialog.

Readable | Writeable

secondary-use-markup

true if the secondary text of the dialog includes Pango markup.

See parse_markup().

Readable | Writeable

text

The primary text of the message dialog.

If the dialog has a secondary text, this will appear as the title.

Readable | Writeable

use-markup

true if the primary text of the dialog includes Pango markup.

See parse_markup().

Readable | Writeable

Dialog

use-header-bar

true if the dialog uses a headerbar for action buttons instead of the action-area.

For technical reasons, this property is declared as an integer property, but you should only set it to true or false.

Creating a dialog with headerbar

Builtin Dialog subclasses such as ColorChooserDialog set this property according to platform conventions (using the gtk-dialogs-use-header setting).

Here is how you can achieve the same:

⚠️ The following code is in c ⚠️

g_object_get (settings, "gtk-dialogs-use-header", &header, NULL);
dialog = g_object_new (GTK_TYPE_DIALOG, header, TRUE, NULL);

Readable | Writeable | Construct Only

Window

application

The Application associated with the window.

The application will be kept alive for at least as long as it has any windows associated with it (see g_application_hold() for a way to keep it alive without windows).

Normally, the connection between the application and the window will remain until the window is destroyed, but you can explicitly remove it by setting the :application property to None.

Readable | Writeable

child

The child widget.

Readable | Writeable

decorated

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

Readable | Writeable

default-height

The default height of the window.

Readable | Writeable

default-widget

The default widget.

Readable | Writeable

default-width

The default width of the window.

Readable | Writeable

deletable

Whether the window frame should have a close button.

Readable | Writeable

destroy-with-parent

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

Readable | Writeable

display

The display that will display this window.

Readable | Writeable

focus-visible

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

This property is maintained by GTK based on user input and should not be set by applications.

Readable | Writeable

focus-widget

The focus widget.

Readable | Writeable

fullscreened

Whether the window is fullscreen.

Setting this property is the equivalent of calling GtkWindowExt::fullscreen() or GtkWindowExt::unfullscreen(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

handle-menubar-accel

Whether the window frame should handle F10 for activating menubars.

Readable | Writeable

hide-on-close

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

Readable | Writeable

icon-name

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

See IconTheme for more details.

Readable | Writeable

is-active

Whether the toplevel is the currently active window.

Readable

maximized

Whether the window is maximized.

Setting this property is the equivalent of calling GtkWindowExt::maximize() or GtkWindowExt::unmaximize(); either operation is asynchronous, which means you will need to connect to the ::notify signal in order to know whether the operation was successful.

Readable | Writeable | Construct

mnemonics-visible

Whether mnemonics are currently visible in this window.

This property is maintained by GTK based on user input, and should not be set by applications.

Readable | Writeable

modal

If true, the window is modal.

Readable | Writeable

resizable

If true, users can resize the window.

Readable | Writeable

startup-id

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

Writeable

title

The title of the window.

Readable | Writeable

titlebar

The titlebar widget.

Readable | Writeable

transient-for

The transient parent of the window.

Readable | Writeable | Construct

Widget

can-focus

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

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

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

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

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

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

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

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

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

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

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

DialogExt, GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, DialogExtManual, WidgetExtManual, AccessibleExtManual

Implementations

impl MessageDialog

pub fn builder() -> MessageDialogBuilder

Creates a new builder-pattern struct instance to construct MessageDialog objects.

This method returns an instance of MessageDialogBuilder which can be used to create MessageDialog objects.

pub fn message_area(&self) -> Widget

Returns the message area of the dialog.

This is the box where the dialog’s primary and secondary labels are packed. You can add your own extra content to that box and it will appear below those labels. See DialogExt::content_area() for the corresponding function in the parent Dialog.

Deprecated since 4.10

Use AlertDialog instead

Returns

A Box corresponding to the “message area” in the @self

pub fn set_markup(&self, str: &str)

Sets the text of the message dialog.

Deprecated since 4.10

Use AlertDialog instead

str

string with Pango markup

pub fn message_type(&self) -> MessageType

The type of the message.

pub fn set_message_type(&self, message_type: MessageType)

The type of the message.

pub fn secondary_text(&self) -> Option<GString>

The secondary text of the message dialog.

pub fn set_secondary_text(&self, secondary_text: Option<&str>)

The secondary text of the message dialog.

pub fn is_secondary_use_markup(&self) -> bool

true if the secondary text of the dialog includes Pango markup.

See parse_markup().

pub fn set_secondary_use_markup(&self, secondary_use_markup: bool)

true if the secondary text of the dialog includes Pango markup.

See parse_markup().

pub fn text(&self) -> Option<GString>

The primary text of the message dialog.

If the dialog has a secondary text, this will appear as the title.

pub fn set_text(&self, text: Option<&str>)

The primary text of the message dialog.

If the dialog has a secondary text, this will appear as the title.

pub fn uses_markup(&self) -> bool

true if the primary text of the dialog includes Pango markup.

See parse_markup().

pub fn set_use_markup(&self, use_markup: bool)

true if the primary text of the dialog includes Pango markup.

See parse_markup().

pub fn connect_message_area_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_message_type_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_secondary_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_secondary_use_markup_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_text_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_use_markup_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl MessageDialog

pub fn new( parent: Option<&impl IsA<Window>>, flags: DialogFlags, type_: MessageType, buttons: ButtonsType, message: impl IntoGStr ) -> Self

Creates a new message dialog.

This is a simple dialog with some text the user may want to see. When the user clicks a button a “response” signal is emitted with response IDs from ResponseType. See Dialog for more details.

Deprecated since 4.10

Use AlertDialog instead

parent

transient parent

flags

flags

type_

type of message

buttons

set of buttons to use

message_format

printf()-style format string

Returns

a new MessageDialog

pub fn with_markup( parent: Option<&impl IsA<Window>>, flags: DialogFlags, type_: MessageType, buttons: ButtonsType, message: impl IntoOptionalGStr ) -> Self

Creates a new message dialog.

This is a simple dialog with some text that is marked up with Pango markup. When the user clicks a button a “response” signal is emitted with response IDs from ResponseType. See Dialog for more details.

Special XML characters in the printf() arguments passed to this function will automatically be escaped as necessary. (See g_markup_printf_escaped() for how this is implemented.) Usually this is what you want, but if you have an existing Pango markup string that you want to use literally as the label, then you need to use set_markup() instead, since you can’t pass the markup string either as the format (it might contain “%” characters) or as a string argument.

⚠️ The following code is in c ⚠️

GtkWidget *dialog;
GtkDialogFlags flags = GTK_DIALOG_DESTROY_WITH_PARENT;
dialog = gtk_message_dialog_new (parent_window,
                                 flags,
                                 GTK_MESSAGE_ERROR,
                                 GTK_BUTTONS_CLOSE,
                                 NULL);
gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
                               markup);

Deprecated since 4.10

Use AlertDialog instead

parent

transient parent

flags

flags

type_

type of message

buttons

set of buttons to use

message_format

printf()-style format string

Returns

a new MessageDialog

pub fn format_secondary_markup(&self, message: impl IntoOptionalGStr)

Sets the secondary text of the message dialog.

The @message_format is assumed to contain Pango markup.

Due to an oversight, this function does not escape special XML characters like with_markup() does. Thus, if the arguments may contain special XML characters, you should use g_markup_printf_escaped() to escape it.

⚠️ The following code is in c ⚠️

char *msg;

msg = g_markup_printf_escaped (message_format, ...);
gtk_message_dialog_format_secondary_markup (message_dialog,
                                            "%s", msg);
g_free (msg);

Deprecated since 4.10

Use AlertDialog instead

message_format

printf()-style string with Pango markup

pub fn format_secondary_text(&self, message: impl IntoOptionalGStr)

Sets the secondary text of the message dialog.

Deprecated since 4.10

Use AlertDialog instead

message_format

printf()-style format string

Trait Implementations

impl Clone for MessageDialog

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MessageDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MessageDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for MessageDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for MessageDialog

type ParamSpec = ParamSpecObject

type SetValue = MessageDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MessageDialog>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MessageDialog

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MessageDialog

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for MessageDialog

type Parent = Dialog

impl<OT: ObjectType> PartialEq<OT> for MessageDialog

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for MessageDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MessageDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MessageDialog

impl IsA<Accessible> for MessageDialog

impl IsA<Buildable> for MessageDialog

impl IsA<ConstraintTarget> for MessageDialog

impl IsA<Dialog> for MessageDialog

impl IsA<Native> for MessageDialog

impl IsA<Root> for MessageDialog

impl IsA<ShortcutManager> for MessageDialog

impl IsA<Widget> for MessageDialog

impl IsA<Window> for MessageDialog