GtkMessageDialog

GtkMessageDialog — A convenient message window

Properties

GtkButtonsType buttons Write / Construct Only
GtkWidget * message-area Read
GtkMessageType message-type Read / Write / Construct
gchar * secondary-text Read / Write
gboolean secondary-use-markup Read / Write
gchar * text Read / Write
gboolean use-markup Read / Write

Types and Values

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── GtkWidget
            ╰── GtkWindow
                ╰── GtkDialog
                    ╰── GtkMessageDialog

Implemented Interfaces

GtkMessageDialog implements AtkImplementorIface, GtkBuildable, GtkConstraintTarget, GtkNative, GtkShortcutManager and GtkRoot.

Includes

#include <gtk/gtk.h>

Description

GtkMessageDialog presents a dialog with some message text. It’s simply a convenience widget; you could construct the equivalent of GtkMessageDialog from GtkDialog without too much effort, but GtkMessageDialog saves typing.

The easiest way to do a modal message dialog is to use the GTK_DIALOG_MODAL flag, which will call gtk_window_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:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 GtkMessageDialog simply by omitting the GTK_DIALOG_MODAL flag:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 GtkMessageDialog implementation of the GtkBuildable interface exposes the message area as an internal child with the name “message_area”.

Functions

gtk_message_dialog_new ()

GtkWidget *
gtk_message_dialog_new (GtkWindow *parent,
                        GtkDialogFlags flags,
                        GtkMessageType type,
                        GtkButtonsType buttons,
                        const gchar *message_format,
                        ...);

Creates a new message dialog, which 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 GtkResponseType. See GtkDialog for more details.

Parameters

parent

transient parent, or NULL for none.

[allow-none]

flags

flags

 

type

type of message

 

buttons

set of buttons to use

 

message_format

printf()-style format string, or NULL.

[allow-none]

...

arguments for message_format

 

Returns

a new GtkMessageDialog.

[transfer none]


gtk_message_dialog_new_with_markup ()

GtkWidget *
gtk_message_dialog_new_with_markup (GtkWindow *parent,
                                    GtkDialogFlags flags,
                                    GtkMessageType type,
                                    GtkButtonsType buttons,
                                    const gchar *message_format,
                                    ...);

Creates a new message dialog, which is a simple dialog with some text that is marked up with the Pango text markup language. When the user clicks a button a “response” signal is emitted with response IDs from GtkResponseType. See GtkDialog 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 gtk_message_dialog_set_markup() instead, since you can’t pass the markup string either as the format (it might contain “%” characters) or as a string argument.

1
2
3
4
5
6
7
8
9
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);

Parameters

parent

transient parent, or NULL for none.

[allow-none]

flags

flags

 

type

type of message

 

buttons

set of buttons to use

 

message_format

printf()-style format string, or NULL.

[allow-none]

...

arguments for message_format

 

Returns

a new GtkMessageDialog


gtk_message_dialog_set_markup ()

void
gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
                               const gchar *str);

Sets the text of the message dialog to be str , which is marked up with the Pango text markup language.

Parameters

message_dialog

a GtkMessageDialog

 

str

markup string (see Pango markup format)

 

gtk_message_dialog_format_secondary_text ()

void
gtk_message_dialog_format_secondary_text
                               (GtkMessageDialog *message_dialog,
                                const gchar *message_format,
                                ...);

Sets the secondary text of the message dialog to be message_format (with printf()-style).

Parameters

message_dialog

a GtkMessageDialog

 

message_format

printf()-style format string, or NULL.

[allow-none]

...

arguments for message_format

 

gtk_message_dialog_format_secondary_markup ()

void
gtk_message_dialog_format_secondary_markup
                               (GtkMessageDialog *message_dialog,
                                const gchar *message_format,
                                ...);

Sets the secondary text of the message dialog to be message_format (with printf()-style), which is marked up with the Pango text markup language.

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

1
2
3
4
5
6
gchar *msg;

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

Parameters

message_dialog

a GtkMessageDialog

 

message_format

printf()-style markup string (see Pango markup format), or NULL

 

...

arguments for message_format

 

gtk_message_dialog_get_message_area ()

GtkWidget *
gtk_message_dialog_get_message_area (GtkMessageDialog *message_dialog);

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 gtk_dialog_get_content_area() for the corresponding function in the parent GtkDialog.

Parameters

message_dialog

a GtkMessageDialog

 

Returns

A GtkBox corresponding to the “message area” in the message_dialog .

[transfer none]

Types and Values

struct GtkMessageDialog

struct GtkMessageDialog;

enum GtkMessageType

The type of message being displayed in the dialog.

Members

GTK_MESSAGE_INFO

Informational message

 

GTK_MESSAGE_WARNING

Non-fatal warning message

 

GTK_MESSAGE_QUESTION

Question requiring a choice

 

GTK_MESSAGE_ERROR

Fatal error message

 

GTK_MESSAGE_OTHER

None of the above

 

enum GtkButtonsType

Prebuilt sets of buttons for the dialog. If none of these choices are appropriate, simply use GTK_BUTTONS_NONE then call gtk_dialog_add_buttons().

Members

GTK_BUTTONS_NONE

no buttons at all

 

GTK_BUTTONS_OK

an OK button

 

GTK_BUTTONS_CLOSE

a Close button

 

GTK_BUTTONS_CANCEL

a Cancel button

 

GTK_BUTTONS_YES_NO

Yes and No buttons

 

GTK_BUTTONS_OK_CANCEL

OK and Cancel buttons

 

Property Details

The “buttons” property

  “buttons”                  GtkButtonsType

The buttons shown in the message dialog.

Owner: GtkMessageDialog

Flags: Write / Construct Only

Default value: GTK_BUTTONS_NONE


The “message-area” property

  “message-area”             GtkWidget *

The GtkBox that corresponds to the message area of this dialog. See gtk_message_dialog_get_message_area() for a detailed description of this area.

Owner: GtkMessageDialog

Flags: Read


The “message-type” property

  “message-type”             GtkMessageType

The type of the message.

Owner: GtkMessageDialog

Flags: Read / Write / Construct

Default value: GTK_MESSAGE_INFO


The “secondary-text” property

  “secondary-text”           gchar *

The secondary text of the message dialog.

Owner: GtkMessageDialog

Flags: Read / Write

Default value: NULL


The “secondary-use-markup” property

  “secondary-use-markup”     gboolean

TRUE if the secondary text of the dialog includes Pango markup. See pango_parse_markup().

Owner: GtkMessageDialog

Flags: Read / Write

Default value: FALSE


The “text” property

  “text”                     gchar *

The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title.

Owner: GtkMessageDialog

Flags: Read / Write

Default value: ""


The “use-markup” property

  “use-markup”               gboolean

TRUE if the primary text of the dialog includes Pango markup. See pango_parse_markup().

Owner: GtkMessageDialog

Flags: Read / Write

Default value: FALSE

See Also

GtkDialog