MessageDialog

Description GtkMessageDialog presents a dialog with an image representing the type of message (Error, Question, etc.) alongside 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 gtk_dialog_run(), though you can also pass in the GTK_DIALOG_MODAL flag, gtk_dialog_run() automatically makes the dialog modal and waits for the user to respond to it. gtk_dialog_run() returns when any dialog button is clicked. You might do a non-modal GtkMessageDialog as follows: GtkMessageDialog as GtkBuildable The GtkMessageDialog implementation of the GtkBuildable interface exposes the message area as an internal child with the name "message_area".

class MessageDialog : Dialog {

protected

GtkMessageDialog* gtkMessageDialog;

GtkMessageDialog* getMessageDialogStruct();

void* getStruct();

this(GtkMessageDialog* gtkMessageDialog);

void setStruct(GObject* obj);

this(Window parent, GtkDialogFlags flags, GtkMessageType type, GtkButtonsType buttons, string messageFormat, string message);

this(Window parent, GtkDialogFlags flags, GtkMessageType type, GtkButtonsType buttons, bool markup, string messageFormat, string message);

VBox getMessageArea();

void setMarkup(string str);

void setImage(Widget image);

Widget getImage();

}

Constructors

this this(GtkMessageDialog* gtkMessageDialog): Sets our main struct and passes it to the parent class
this this(Window parent, GtkDialogFlags flags, GtkMessageType type, GtkButtonsType buttons, string messageFormat, string message): Creates a new message dialog, which is a simple dialog with an icon indicating the dialog type (error, warning, etc.) and 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.
this this(Window parent, GtkDialogFlags flags, GtkMessageType type, GtkButtonsType buttons, bool markup, string messageFormat, string message): Creates a new message dialog, which is a simple dialog with an icon indicating the dialog type (error, warning, etc.) and some text which 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.

Members

Functions

getImage Widget getImage(): Gets the dialog's image. Since 2.14
getMessageArea VBox getMessageArea(): Since 2.22
getMessageDialogStruct GtkMessageDialog* getMessageDialogStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setImage void setImage(Widget image): Sets the dialog's image to image. Since 2.10
setMarkup void setMarkup(string str): Sets the text of the message dialog to be str, which is marked up with the Pango text markup language. Since 2.4
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.

Variables

gtkMessageDialog GtkMessageDialog* gtkMessageDialog;: the main Gtk struct

Inherited Members

From Dialog

gtkDialog GtkDialog* gtkDialog;: the main Gtk struct
getDialogStruct GtkDialog* getDialogStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
addButton Widget addButton(StockID stockID, int responseId)
addButtons void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons void addButtons(StockID[] stockIDs, ResponseType[] responses)
getActionArea HButtonBox getActionArea(): Returns the action area of dialog. Since 2.14
getContentArea VBox getContentArea(): Returns the content area of dialog. Since 2.14
connectedSignals int[string] connectedSignals;
onCloseListeners void delegate(Dialog)[] onCloseListeners;: Undocumented in source.
addOnClose void addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags): The ::close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog. The default binding for this signal is the Escape key.
callBackClose void callBackClose(GtkDialog* arg0Struct, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
onResponseListeners void delegate(gint, Dialog)[] onResponseListeners;: Undocumented in source.
addOnResponse void addOnResponse(void delegate(gint, Dialog) dlg, ConnectFlags connectFlags): Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls gtk_dialog_response(). On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT. Otherwise, it depends on which action widget was clicked. See Also GtkVBox Pack widgets vertically. GtkWindow Alter the properties of your dialog box. GtkButton Add them to the action_area to get a response from the user.
callBackResponse void callBackResponse(GtkDialog* dialogStruct, gint responseId, Dialog _dialog): Undocumented in source. Be warned that the author may not have intended to support it.
run int run(): Blocks in a recursive main loop until the dialog either emits the "response" signal, or is destroyed. If the dialog is destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the ::response signal emission. Before entering the recursive main loop, gtk_dialog_run() calls gtk_widget_show() on the dialog for you. Note that you still need to show any children of the dialog yourself. During gtk_dialog_run(), the default behavior of "delete-event" is disabled; if the dialog receives ::delete_event, it will not be destroyed as windows usually are, and gtk_dialog_run() will return GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be modal. You can force gtk_dialog_run() to return at any time by calling gtk_dialog_response() to emit the ::response signal. Destroying the dialog during gtk_dialog_run() is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not. After gtk_dialog_run() returns, you are responsible for hiding or destroying the dialog if you wish to do so.
response void response(int responseId): Emits the "response" signal with the given response ID. Used to indicate that the user has responded to the dialog in some way; typically either you or gtk_dialog_run() will be monitoring the ::response signal and take appropriate action.
addButton Widget addButton(string buttonText, int responseId): Adds a button with the given text (or a stock button, if button_text is a stock ID) and sets things up so that clicking the button will emit the "response" signal with the given response_id. The button is appended to the end of the dialog's action area. The button widget is returned, but usually you don't need it.
addActionWidget void addActionWidget(Widget child, int responseId): Adds an activatable widget to the action area of a GtkDialog, connecting a signal handler that will emit the "response" signal on the dialog when the widget is activated. The widget is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the action_area field of the GtkDialog struct.
getHasSeparator int getHasSeparator(): Warning gtk_dialog_get_has_separator has been deprecated since version 2.22 and should not be used in newly-written code. This function will be removed in GTK+ 3 Accessor for whether the dialog has a separator.
setDefaultResponse void setDefaultResponse(int responseId): Sets the last widget in the dialog's action area with the given response_id as the default widget for the dialog. Pressing "Enter" normally activates the default widget.
setHasSeparator void setHasSeparator(int setting): Warning gtk_dialog_set_has_separator has been deprecated since version 2.22 and should not be used in newly-written code. This function will be removed in GTK+ 3 Sets whether the dialog has a separator above the buttons.
setResponseSensitive void setResponseSensitive(int responseId, int setting): Calls gtk_widget_set_sensitive (widget, setting) for each widget in the dialog's action area with the given response_id. A convenient way to sensitize/desensitize dialog buttons.
getResponseForWidget int getResponseForWidget(Widget widget): Gets the response id of a widget in the action area of a dialog. Since 2.8
getWidgetForResponse Widget getWidgetForResponse(int responseId): Gets the widget button that uses the given response ID in the action area of a dialog. Since 2.20
alternativeDialogButtonOrder int alternativeDialogButtonOrder(Screen screen): Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See gtk_dialog_set_alternative_button_order() for more details about alternative button order. If you need to use this function, you should probably connect to the ::notify:gtk-alternative-button-order signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes. Since 2.6
setAlternativeButtonOrderFromArray void setAlternativeButtonOrderFromArray(int[] newOrder): Sets an alternative button order. If the "gtk-alternative-button-order" setting is set to TRUE, the dialog buttons are reordered according to the order of the response ids in new_order. See gtk_dialog_set_alternative_button_order() for more information. This function is for use by language bindings. Since 2.6