Dialog

Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user’s part.

GTK+ treats a dialog as a window split vertically. The top section is a GtkVBox, and is where widgets such as a GtkLabel or a GtkEntry should be packed. The bottom area is known as the “action area”. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply.

GtkDialog boxes are created with a call to gtk_dialog_new() or gtk_dialog_new_with_buttons(). gtk_dialog_new_with_buttons() is recommended; it allows you to set the dialog title, some convenient flags, and add simple buttons.

If “dialog” is a newly created dialog, the two primary areas of the window can be accessed through gtk_dialog_get_content_area() and gtk_dialog_get_action_area(), as can be seen from the example below.

A “modal” dialog (that is, one which freezes the rest of the application from user input), can be created by calling gtk_window_set_modal() on the dialog. Use the GTK_WINDOW() macro to cast the widget returned from gtk_dialog_new() into a GtkWindow When using gtk_dialog_new_with_buttons() you can also pass the GTK_DIALOG_MODAL flag to make a dialog modal.

If you add buttons to GtkDialog using gtk_dialog_new_with_buttons(), gtk_dialog_add_button(), gtk_dialog_add_buttons(), or gtk_dialog_add_action_widget(), clicking the button will emit a signal called response with a response ID that you specified. GTK+ will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the GtkResponseType enumeration (these all have values less than zero). If a dialog receives a delete event, the response signal will be emitted with a response ID of GTK_RESPONSE_DELETE_EVENT

If you want to block waiting for a dialog to return before returning control flow to your code, you can call gtk_dialog_run(). This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.

For the simple dialog in the following example, in reality you’d probably use GtkMessageDialog to save yourself some effort. But you’d need to create the dialog contents manually if you had more than a simple message in the dialog.

An example for simple GtkDialog usage:

1 
2 // Function to open a dialog box with a message
3 void
4 quick_message (GtkWindow *parent, gchar *message)
5 {
6 GtkWidget *dialog, *label, *content_area;
7 GtkDialogFlags flags;
8 
9 // Create the widgets
10 flags = GTK_DIALOG_DESTROY_WITH_PARENT;
11 dialog = gtk_dialog_new_with_buttons ("Message",
12 parent,
13 flags,
14 _("_OK"),
15 GTK_RESPONSE_NONE,
16 NULL);
17 content_area = gtk_dialog_get_content_area (GTK_DIALOG (dialog));
18 label = gtk_label_new (message);
19 
20 // Ensure that the dialog box is destroyed when the user responds
21 
22 g_signal_connect_swapped (dialog,
23 "response",
24 G_CALLBACK (gtk_widget_destroy),
25 dialog);
26 
27 // Add the label, and show everything we’ve added
28 
29 gtk_container_add (GTK_CONTAINER (content_area), label);
30 gtk_widget_show_all (dialog);
31 }

GtkDialog as GtkBuildable

The GtkDialog implementation of the GtkBuildable interface exposes the vbox and action_area as internal children with the names “vbox” and “action_area”.

GtkDialog supports a custom <action-widgets> element, which can contain multiple <action-widget> elements. The “response” attribute specifies a numeric response, and the content of the element is the id of widget (which should be a child of the dialogs action_area). To mark a response as default, set the “default“ attribute of the <action-widget> element to true.

GtkDialog supports adding action widgets by specifying “action“ as the “type“ attribute of a <child> element. The widget will be added either to the action area or the headerbar of the dialog, depending on the “use-header-bar“ property. The response id has to be associated with the action widget using the <action-widgets> element.

An example of a GtkDialog UI definition fragment: |[ <object class="GtkDialog" id="dialog1"> <child type="action"> <object class="GtkButton" id="button_cancel"/> </child> <child type="action"> <object class="GtkButton" id="button_ok"> <property name="can-default">True</property> </object> </child> <action-widgets> <action-widget response="cancel">button_cancel</action-widget> <action-widget response="ok" default="true">button_ok</action-widget> </action-widgets> </object>

Constructors

this
this(GtkDialog* gtkDialog, bool ownedRef = false)

Sets our main struct and passes it to the parent class.

this
this(string title, Window parent, GtkDialogFlags flags, string[] buttonsText, ResponseType[] responses)
this(string title, Window parent, GtkDialogFlags flags, StockID[] stockIDs, ResponseType[] responses)

Both title and parent can be null.

this
this()

Creates a new dialog box.

Members

Functions

addActionWidget
void addActionWidget(Widget child, int responseId)

Adds an activatable widget to the action area of a gtk.Dialog, 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 gtk.Dialog struct.

addButton
Button addButton(StockID stockID, int responseId)
addButton
Widget addButton(string buttonText, int responseId)

Adds a button with the given text 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.

addButtons
void addButtons(string[] buttonsText, ResponseType[] responses)
addButtons
void addButtons(StockID[] stockIDs, ResponseType[] responses)
addOnClose
gulong addOnClose(void delegate(Dialog) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

The ::close signal is a [keybinding signal]GtkBindingSignal which gets emitted when the user uses a keybinding to close the dialog.

addOnResponse
gulong addOnResponse(void delegate(int, Dialog) dlg, ConnectFlags connectFlags = cast(ConnectFlags)0)

Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls Dialog.response. On a delete event, the response ID is GTK_RESPONSE_DELETE_EVENT Otherwise, it depends on which action widget was clicked.

getActionArea
HButtonBox getActionArea()

Returns the action area of dialog.

getContentArea
VBox getContentArea()

Returns the content area of dialog.

getDialogStruct
GtkDialog* getDialogStruct(bool transferOwnership = false)

Get the main Gtk struct

getHeaderBar
Widget getHeaderBar()

Returns the header bar of dialog. Note that the headerbar is only used by the dialog if the use-header-bar property is TRUE.

getResponseForWidget
int getResponseForWidget(Widget widget)

Gets the response id of a widget in the action area of a dialog.

getStruct
void* getStruct()

the main Gtk struct as a void*

getWidgetForResponse
Widget getWidgetForResponse(int responseId)

Gets the widget button that uses the given response ID in the action area of a dialog.

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 Dialog.run will be monitoring the ::response signal and take appropriate action.

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 Dialog.run, Dialog.run returns GTK_RESPONSE_NONE Otherwise, it returns the response ID from the ::response signal emission.

setAlternativeButtonOrder
void setAlternativeButtonOrder(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.

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.

setResponseSensitive
void setResponseSensitive(int responseId, bool 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.

Static functions

alternativeDialogButtonOrder
bool alternativeDialogButtonOrder(Screen screen)

Returns TRUE if dialogs are expected to use an alternative button order on the screen screen. See Dialog.setAlternativeButtonOrder for more details about alternative button order.

getType
GType getType()

Variables

gtkDialog
GtkDialog* gtkDialog;

the main Gtk struct