CtkMessageDialog: CTK+ 3 Reference Manual

CtkMessageDialog

CtkMessageDialog — A convenient message window

Functions

CtkWidget *	ctk_message_dialog_new ()
CtkWidget *	ctk_message_dialog_new_with_markup ()
void	ctk_message_dialog_set_markup ()
void	ctk_message_dialog_set_image ()
CtkWidget *	ctk_message_dialog_get_image ()
void	ctk_message_dialog_format_secondary_text ()
void	ctk_message_dialog_format_secondary_markup ()
CtkWidget *	ctk_message_dialog_get_message_area ()

Properties

CtkButtonsType	buttons	Write / Construct Only
CtkWidget *	image	Read / Write
CtkWidget *	message-area	Read
CtkMessageType	message-type	Read / Write / Construct
char *	secondary-text	Read / Write
gboolean	secondary-use-markup	Read / Write
char *	text	Read / Write
gboolean	use-markup	Read / Write

Types and Values

struct	CtkMessageDialog
enum	CtkMessageType
enum	CtkButtonsType

Object Hierarchy

    GObject
    ╰── GInitiallyUnowned
        ╰── CtkWidget
            ╰── CtkContainer
                ╰── CtkBin
                    ╰── CtkWindow
                        ╰── CtkDialog
                            ╰── CtkMessageDialog

Implemented Interfaces

CtkMessageDialog implements AtkImplementorIface and CtkBuildable.

Includes

#include <ctk/ctk.h>

Description

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

One difference from CtkDialog is that CtkMessageDialog sets the “skip-taskbar-hint” property to TRUE, so that the dialog is hidden from the taskbar by default.

The easiest way to do a modal message dialog is to use ctk_dialog_run(), though you can also pass in the CTK_DIALOG_MODAL flag, ctk_dialog_run() automatically makes the dialog modal and waits for the user to respond to it. ctk_dialog_run() returns when any dialog button is clicked.

An example for using a modal dialog:

CtkDialogFlags flags = CTK_DIALOG_DESTROY_WITH_PARENT;
dialog = ctk_message_dialog_new (parent_window,
                                 flags,
                                 CTK_MESSAGE_ERROR,
                                 CTK_BUTTONS_CLOSE,
                                 "Error reading “%s”: %s",
                                 filename,
                                 g_strerror (errno));
ctk_dialog_run (CTK_DIALOG (dialog));
ctk_widget_destroy (dialog);

You might do a non-modal CtkMessageDialog as follows:

An example for a non-modal dialog:

CtkDialogFlags flags = CTK_DIALOG_DESTROY_WITH_PARENT;
dialog = ctk_message_dialog_new (parent_window,
                                 flags,
                                 CTK_MESSAGE_ERROR,
                                 CTK_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_swapped (dialog, "response",
                          G_CALLBACK (ctk_widget_destroy),
                          dialog);

CtkMessageDialog as CtkBuildable

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

Functions

ctk_message_dialog_new ()

CtkWidget *
ctk_message_dialog_new (CtkWindow *parent,
                        CtkDialogFlags flags,
                        CtkMessageType type,
                        CtkButtonsType 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 CtkResponseType. See CtkDialog 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 CtkMessageDialog.

[transfer none]

ctk_message_dialog_new_with_markup ()

CtkWidget *
ctk_message_dialog_new_with_markup (CtkWindow *parent,
                                    CtkDialogFlags flags,
                                    CtkMessageType type,
                                    CtkButtonsType 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 CtkResponseType. See CtkDialog 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 ctk_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.

CtkWidget *dialog;
CtkDialogFlags flags = CTK_DIALOG_DESTROY_WITH_PARENT;
dialog = ctk_message_dialog_new (parent_window,
                                 flags,
                                 CTK_MESSAGE_ERROR,
                                 CTK_BUTTONS_CLOSE,
                                 NULL);
ctk_message_dialog_set_markup (CTK_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 CtkMessageDialog

Since: 2.4

ctk_message_dialog_set_markup ()

void
ctk_message_dialog_set_markup (CtkMessageDialog *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 CtkMessageDialog
str	markup string (see Pango markup format)

Since: 2.4

ctk_message_dialog_set_image ()

void
ctk_message_dialog_set_image (CtkMessageDialog *dialog,
                              CtkWidget *image);

Sets the dialog’s image to image .

Parameters

dialog	a CtkMessageDialog
image	the image

Since: 2.10

ctk_message_dialog_get_image ()

CtkWidget *
ctk_message_dialog_get_image (CtkMessageDialog *dialog);

Gets the dialog’s image.

Parameters

dialog

a CtkMessageDialog

Returns

the dialog’s image.

[transfer none]

Since: 2.14

ctk_message_dialog_format_secondary_text ()

void
ctk_message_dialog_format_secondary_text
                               (CtkMessageDialog *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 CtkMessageDialog
message_format	printf()-style format string, or `NULL`.	[allow-none]
...	arguments for `message_format`

Since: 2.6

ctk_message_dialog_format_secondary_markup ()

void
ctk_message_dialog_format_secondary_markup
                               (CtkMessageDialog *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 ctk_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.

gchar *msg;

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

Parameters

message_dialog	a CtkMessageDialog
message_format	printf()-style markup string (see Pango markup format), or `NULL`
...	arguments for `message_format`

Since: 2.6

ctk_message_dialog_get_message_area ()

CtkWidget *
ctk_message_dialog_get_message_area (CtkMessageDialog *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 ctk_dialog_get_content_area() for the corresponding function in the parent CtkDialog.

Parameters

message_dialog

a CtkMessageDialog

Returns

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

[transfer none]

Since: 2.22

Types and Values

struct CtkMessageDialog

struct CtkMessageDialog;

enum CtkMessageType

The type of message being displayed in the dialog.

Members

CTK_MESSAGE_INFO	Informational message
CTK_MESSAGE_WARNING	Non-fatal warning message
CTK_MESSAGE_QUESTION	Question requiring a choice
CTK_MESSAGE_ERROR	Fatal error message
CTK_MESSAGE_OTHER	None of the above

enum CtkButtonsType

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

Please note that CTK_BUTTONS_OK, CTK_BUTTONS_YES_NO and CTK_BUTTONS_OK_CANCEL are discouraged by the GNOME Human Interface Guidelines.

Members

CTK_BUTTONS_NONE	no buttons at all
CTK_BUTTONS_OK	an OK button
CTK_BUTTONS_CLOSE	a Close button
CTK_BUTTONS_CANCEL	a Cancel button
CTK_BUTTONS_YES_NO	Yes and No buttons
CTK_BUTTONS_OK_CANCEL	OK and Cancel buttons

Property Details

The `“buttons”` property

  “buttons”                  CtkButtonsType

The buttons shown in the message dialog.

Owner: CtkMessageDialog

Flags: Write / Construct Only

Default value: CTK_BUTTONS_NONE

The `“image”` property

  “image”                    CtkWidget *

The image for this dialog.

Owner: CtkMessageDialog

Flags: Read / Write

Since: 2.10

The `“message-area”` property

  “message-area”             CtkWidget *

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

Owner: CtkMessageDialog

Flags: Read

Since: 2.22

The `“message-type”` property

  “message-type”             CtkMessageType

The type of the message.

Owner: CtkMessageDialog

Flags: Read / Write / Construct

Default value: CTK_MESSAGE_INFO

The `“secondary-text”` property

  “secondary-text”           char *

The secondary text of the message dialog.

Owner: CtkMessageDialog

Flags: Read / Write

Default value: NULL

Since: 2.10

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

Flags: Read / Write

Default value: FALSE

Since: 2.10

The `“text”` property

  “text”                     char *

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

Owner: CtkMessageDialog

Flags: Read / Write

Default value: ""

Since: 2.10

The `“use-markup”` property

  “use-markup”               gboolean

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

Owner: CtkMessageDialog

Flags: Read / Write

Default value: FALSE

Since: 2.10