Struct gtk4::MessageDialog

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

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 signal::Dialog::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”.

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.

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.

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: &str ) -> 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.

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: Option<&str> ) -> 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);

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: Option<&str>)

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

message_format

printf()-style string with Pango markup

pub fn format_secondary_text(&self, message: Option<&str>)

Sets the secondary text of the message dialog.

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