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

<object class="GtkDialog" id="dialog1">
  <child internal-child="vbox">"
    <object class="GtkVBox">
      <child internal-child="action_area">
        <object class="GtkHButtonBox">
          <child>
            <object class="GtkButton" id="button_cancel"/>
          </child>
          <child>
            <object class="GtkButton" id="button_ok"/>
          </child>
        </object>
      </child>
    </object>
  </child>
  <action-widgets>
    <action-widget response="3">button_ok</action-widget>
    <action-widget response="-5">button_cancel</action-widget>
  </action-widgets>
</object>

GtkDialog

typedef struct {
  GtkWidget *vbox;
  GtkWidget *action_area;
} GtkDialog;

vbox is a GtkVBox - the main part of the dialog box.

action_area is a GtkHButtonBox packed below the dividing GtkHSeparator in the dialog. It is treated exactly the same as any other GtkHButtonBox.

enum GtkDialogFlags

typedef enum
{
  GTK_DIALOG_MODAL               = 1 << 0, /* call gtk_window_set_modal (win, TRUE) */
  GTK_DIALOG_DESTROY_WITH_PARENT = 1 << 1, /* call gtk_window_set_destroy_with_parent () */
  GTK_DIALOG_NO_SEPARATOR        = 1 << 2  /* no separator bar above buttons */
} GtkDialogFlags;

Flags used to influence dialog construction.

enum GtkResponseType

typedef enum
{
  /* GTK returns this if a response widget has no response_id,
   * or if the dialog gets programmatically hidden or destroyed.
   */
  GTK_RESPONSE_NONE = -1,

  /* GTK won't return these unless you pass them in
   * as the response for an action widget. They are
   * for your convenience.
   */
  GTK_RESPONSE_REJECT = -2,
  GTK_RESPONSE_ACCEPT = -3,

  /* If the dialog is deleted. */
  GTK_RESPONSE_DELETE_EVENT = -4,

  /* These are returned from GTK dialogs, and you can also use them
   * yourself if you like.
   */
  GTK_RESPONSE_OK     = -5,
  GTK_RESPONSE_CANCEL = -6,
  GTK_RESPONSE_CLOSE  = -7,
  GTK_RESPONSE_YES    = -8,
  GTK_RESPONSE_NO     = -9,
  GTK_RESPONSE_APPLY  = -10,
  GTK_RESPONSE_HELP   = -11
} GtkResponseType;

Predefined values for use as response ids in gtk_dialog_add_button(). All predefined values are negative, GTK+ leaves positive values for application-defined response ids.

gtk_dialog_new ()

GtkWidget*          gtk_dialog_new                      (void);

Creates a new dialog box. Widgets should not be packed into this GtkWindow directly, but into the vbox and action_area, as described above.

gtk_dialog_new_with_buttons ()

GtkWidget*          gtk_dialog_new_with_buttons         (const gchar *title,
                                                         GtkWindow *parent,
                                                         GtkDialogFlags flags,
                                                         const gchar *first_button_text,
                                                         ...);

Creates a new GtkDialog with title title (or NULL for the default title; see gtk_window_set_title()) and transient parent parent (or NULL for none; see gtk_window_set_transient_for()). The flags argument can be used to make the dialog modal (GTK_DIALOG_MODAL) and/or to have it destroyed along with its transient parent (GTK_DIALOG_DESTROY_WITH_PARENT). After flags, button text/response ID pairs should be listed, with a NULL pointer ending the list. Button text can be either a stock ID such as GTK_STOCK_OK, or some arbitrary text. A response ID can be any positive number, or one of the values in the GtkResponseType enumeration. If the user clicks one of these dialog buttons, GtkDialog will emit the "response" signal with the corresponding response ID. If a GtkDialog receives the "delete-event" signal, it will emit ::response with a response ID of GTK_RESPONSE_DELETE_EVENT. However, destroying a dialog does not emit the ::response signal; so be careful relying on ::response when using the GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right, so the first button in the list will be the leftmost button in the dialog.

Here's a simple example:

 GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
                                                  main_app_window,
                                                  GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
                                                  GTK_STOCK_OK,
                                                  GTK_RESPONSE_ACCEPT,
                                                  GTK_STOCK_CANCEL,
                                                  GTK_RESPONSE_REJECT,
                                                  NULL);

gtk_dialog_run ()

gint                gtk_dialog_run                      (GtkDialog *dialog);

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.

Typical usage of this function might be:

  gint result = gtk_dialog_run (GTK_DIALOG (dialog));
  switch (result)
    {
      case GTK_RESPONSE_ACCEPT:
         do_application_specific_something ();
         break;
      default:
         do_nothing_since_dialog_was_cancelled ();
         break;
    }
  gtk_widget_destroy (dialog);

Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a gtk_dialog_run() call.

gtk_dialog_response ()

void                gtk_dialog_response                 (GtkDialog *dialog,
                                                         gint response_id);

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.

gtk_dialog_add_button ()

GtkWidget*          gtk_dialog_add_button               (GtkDialog *dialog,
                                                         const gchar *button_text,
                                                         gint response_id);

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.

gtk_dialog_add_buttons ()

void                gtk_dialog_add_buttons              (GtkDialog *dialog,
                                                         const gchar *first_button_text,
                                                         ...);

Adds more buttons, same as calling gtk_dialog_add_button() repeatedly. The variable argument list should be NULL-terminated as with gtk_dialog_new_with_buttons(). Each button must have both text and response ID.

gtk_dialog_add_action_widget ()

void                gtk_dialog_add_action_widget        (GtkDialog *dialog,
                                                         GtkWidget *child,
                                                         gint response_id);

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.

gtk_dialog_get_has_separator ()

gboolean            gtk_dialog_get_has_separator        (GtkDialog *dialog);

Accessor for whether the dialog has a separator.

gtk_dialog_set_default_response ()

void                gtk_dialog_set_default_response     (GtkDialog *dialog,
                                                         gint response_id);

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.

gtk_dialog_set_has_separator ()

void                gtk_dialog_set_has_separator        (GtkDialog *dialog,
                                                         gboolean setting);

Sets whether the dialog has a separator above the buttons. TRUE by default.

gtk_dialog_set_response_sensitive ()

void                gtk_dialog_set_response_sensitive   (GtkDialog *dialog,
                                                         gint response_id,
                                                         gboolean 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.

gtk_dialog_get_response_for_widget ()

gint                gtk_dialog_get_response_for_widget  (GtkDialog *dialog,
                                                         GtkWidget *widget);

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

Since 2.8

gtk_alternative_dialog_button_order ()

gboolean            gtk_alternative_dialog_button_order (GdkScreen *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

gtk_dialog_set_alternative_button_order ()

void                gtk_dialog_set_alternative_button_order
                                                        (GtkDialog *dialog,
                                                         gint first_response_id,
                                                         ...);

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 passed to this function.

By default, GTK+ dialogs use the button order advocated by the Gnome Human Interface Guidelines with the affirmative button at the far right, and the cancel button left of it. But the builtin GTK+ dialogs and GtkMessageDialogs do provide an alternative button order, which is more suitable on some platforms, e.g. Windows.

Use this function after adding all the buttons to your dialog, as the following example shows:

cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
                                       GTK_STOCK_CANCEL,
                                       GTK_RESPONSE_CANCEL);
 
ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
                                   GTK_STOCK_OK,
                                   GTK_RESPONSE_OK);
  
gtk_widget_grab_default (ok_button);
  
help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
                                     GTK_STOCK_HELP,
                                     GTK_RESPONSE_HELP);
 
gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
                                         GTK_RESPONSE_OK,
                                         GTK_RESPONSE_CANCEL,
                                         GTK_RESPONSE_HELP,
                                         -1);

Since 2.6

gtk_dialog_set_alternative_button_order_from_array ()

void                gtk_dialog_set_alternative_button_order_from_array
                                                        (GtkDialog *dialog,
                                                         gint n_params,
                                                         gint *new_order);

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

The "has-separator" property

  "has-separator"            gboolean              : Read / Write

The dialog has a separator bar above its buttons.

Default value: TRUE

The "action-area-border" style property

  "action-area-border"       gint                  : Read

Width of border around the button area at the bottom of the dialog.

Allowed values: >= 0

Default value: 5

The "button-spacing" style property

  "button-spacing"           gint                  : Read

Spacing between buttons.

Allowed values: >= 0

Default value: 6

The "content-area-border" style property

  "content-area-border"      gint                  : Read

Width of border around the main dialog area.

Allowed values: >= 0

Default value: 2

The "close" signal

void                user_function                      (GtkDialog *dialog,
                                                        gpointer   user_data)      : Run Last / Action

The "response" signal

void                user_function                      (GtkDialog *dialog,
                                                        gint       arg1,
                                                        gpointer   user_data)      : Run Last

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_NONE. Otherwise, it depends on which action widget was clicked.