1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkbutton.h"
33 #include "gtkdialog.h"
36 #include "gtkmarshalers.h"
40 #include "gtkbindings.h"
41 #include "gtkprivate.h"
42 #include "gtkbuildable.h"
45 struct _GtkDialogPrivate
48 GtkWidget *action_area;
51 typedef struct _ResponseData ResponseData;
58 static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
59 const gchar *first_button_text,
62 static gboolean gtk_dialog_delete_event_handler (GtkWidget *widget,
65 static void gtk_dialog_style_updated (GtkWidget *widget);
66 static void gtk_dialog_map (GtkWidget *widget);
68 static void gtk_dialog_close (GtkDialog *dialog);
70 static ResponseData * get_response_data (GtkWidget *widget,
73 static void gtk_dialog_buildable_interface_init (GtkBuildableIface *iface);
74 static GObject * gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
76 const gchar *childname);
77 static gboolean gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
81 GMarkupParser *parser,
83 static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
101 static guint dialog_signals[LAST_SIGNAL];
103 G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
104 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
105 gtk_dialog_buildable_interface_init))
108 gtk_dialog_class_init (GtkDialogClass *class)
110 GObjectClass *gobject_class;
111 GtkWidgetClass *widget_class;
112 GtkBindingSet *binding_set;
114 gobject_class = G_OBJECT_CLASS (class);
115 widget_class = GTK_WIDGET_CLASS (class);
117 widget_class->map = gtk_dialog_map;
118 widget_class->style_updated = gtk_dialog_style_updated;
120 class->close = gtk_dialog_close;
122 g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
125 * GtkDialog::response:
126 * @dialog: the object on which the signal is emitted
127 * @response_id: the response ID
129 * Emitted when an action widget is clicked, the dialog receives a
130 * delete event, or the application programmer calls gtk_dialog_response().
131 * On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT.
132 * Otherwise, it depends on which action widget was clicked.
134 dialog_signals[RESPONSE] =
135 g_signal_new (I_("response"),
136 G_OBJECT_CLASS_TYPE (class),
138 G_STRUCT_OFFSET (GtkDialogClass, response),
140 _gtk_marshal_VOID__INT,
147 * The ::close signal is a
148 * <link linkend="keybinding-signals">keybinding signal</link>
149 * which gets emitted when the user uses a keybinding to close
152 * The default binding for this signal is the Escape key.
154 dialog_signals[CLOSE] =
155 g_signal_new (I_("close"),
156 G_OBJECT_CLASS_TYPE (class),
157 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
158 G_STRUCT_OFFSET (GtkDialogClass, close),
160 _gtk_marshal_VOID__VOID,
163 gtk_widget_class_install_style_property (widget_class,
164 g_param_spec_int ("content-area-border",
165 P_("Content area border"),
166 P_("Width of border around the main dialog area"),
170 GTK_PARAM_READABLE));
172 * GtkDialog:content-area-spacing:
174 * The default spacing used between elements of the
175 * content area of the dialog, as returned by
176 * gtk_dialog_get_content_area(), unless gtk_box_set_spacing()
177 * was called on that widget directly.
181 gtk_widget_class_install_style_property (widget_class,
182 g_param_spec_int ("content-area-spacing",
183 P_("Content area spacing"),
184 P_("Spacing between elements of the main dialog area"),
188 GTK_PARAM_READABLE));
189 gtk_widget_class_install_style_property (widget_class,
190 g_param_spec_int ("button-spacing",
191 P_("Button spacing"),
192 P_("Spacing between buttons"),
196 GTK_PARAM_READABLE));
198 gtk_widget_class_install_style_property (widget_class,
199 g_param_spec_int ("action-area-border",
200 P_("Action area border"),
201 P_("Width of border around the button area at the bottom of the dialog"),
205 GTK_PARAM_READABLE));
207 binding_set = gtk_binding_set_by_class (class);
209 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0, "close", 0);
213 update_spacings (GtkDialog *dialog)
215 GtkDialogPrivate *priv = dialog->priv;
216 gint content_area_border;
217 gint content_area_spacing;
219 gint action_area_border;
221 gtk_widget_style_get (GTK_WIDGET (dialog),
222 "content-area-border", &content_area_border,
223 "content-area-spacing", &content_area_spacing,
224 "button-spacing", &button_spacing,
225 "action-area-border", &action_area_border,
228 gtk_container_set_border_width (GTK_CONTAINER (priv->vbox),
229 content_area_border);
230 if (!_gtk_box_get_spacing_set (GTK_BOX (priv->vbox)))
232 gtk_box_set_spacing (GTK_BOX (priv->vbox), content_area_spacing);
233 _gtk_box_set_spacing_set (GTK_BOX (priv->vbox), FALSE);
235 gtk_box_set_spacing (GTK_BOX (priv->action_area),
237 gtk_container_set_border_width (GTK_CONTAINER (priv->action_area),
242 gtk_dialog_init (GtkDialog *dialog)
244 GtkDialogPrivate *priv;
246 dialog->priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
251 /* To avoid breaking old code that prevents destroy on delete event
252 * by connecting a handler, we have to have the FIRST signal
253 * connection on the dialog.
255 g_signal_connect (dialog,
257 G_CALLBACK (gtk_dialog_delete_event_handler),
260 priv->vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, 0);
261 gtk_container_add (GTK_CONTAINER (dialog), priv->vbox);
262 gtk_widget_show (priv->vbox);
264 priv->action_area = gtk_button_box_new (GTK_ORIENTATION_HORIZONTAL);
266 gtk_button_box_set_layout (GTK_BUTTON_BOX (priv->action_area),
269 gtk_box_pack_end (GTK_BOX (priv->vbox), priv->action_area,
271 gtk_widget_show (priv->action_area);
273 gtk_window_set_type_hint (GTK_WINDOW (dialog),
274 GDK_WINDOW_TYPE_HINT_DIALOG);
275 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
278 static GtkBuildableIface *parent_buildable_iface;
281 gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
283 parent_buildable_iface = g_type_interface_peek_parent (iface);
284 iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
285 iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
286 iface->custom_finished = gtk_dialog_buildable_custom_finished;
290 gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
292 const gchar *childname)
294 GtkDialogPrivate *priv = GTK_DIALOG (buildable)->priv;
296 if (strcmp (childname, "vbox") == 0)
297 return G_OBJECT (priv->vbox);
298 else if (strcmp (childname, "action_area") == 0)
299 return G_OBJECT (priv->action_area);
301 return parent_buildable_iface->get_internal_child (buildable,
307 gtk_dialog_delete_event_handler (GtkWidget *widget,
311 /* emit response signal */
312 gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
314 /* Do the destroy by default */
318 /* A far too tricky heuristic for getting the right initial
319 * focus widget if none was set. What we do is we focus the first
320 * widget in the tab chain, but if this results in the focus
321 * ending up on one of the response widgets _other_ than the
322 * default response, we focus the default response instead.
324 * Additionally, skip selectable labels when looking for the
325 * right initial focus widget.
328 gtk_dialog_map (GtkWidget *widget)
330 GtkWidget *default_widget, *focus;
331 GtkWindow *window = GTK_WINDOW (widget);
332 GtkDialog *dialog = GTK_DIALOG (widget);
333 GtkDialogPrivate *priv = dialog->priv;
335 GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
337 focus = gtk_window_get_focus (window);
340 GList *children, *tmp_list;
341 GtkWidget *first_focus = NULL;
345 g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
347 focus = gtk_window_get_focus (window);
348 if (GTK_IS_LABEL (focus) &&
349 !gtk_label_get_current_uri (GTK_LABEL (focus)))
350 gtk_label_select_region (GTK_LABEL (focus), 0, 0);
352 if (first_focus == NULL)
354 else if (first_focus == focus)
357 if (!GTK_IS_LABEL (focus))
362 tmp_list = children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
366 GtkWidget *child = tmp_list->data;
368 default_widget = gtk_window_get_default_widget (window);
369 if ((focus == NULL || child == focus) &&
370 child != default_widget &&
373 gtk_widget_grab_focus (default_widget);
377 tmp_list = tmp_list->next;
380 g_list_free (children);
385 gtk_dialog_style_updated (GtkWidget *widget)
387 update_spacings (GTK_DIALOG (widget));
391 dialog_find_button (GtkDialog *dialog,
394 GtkDialogPrivate *priv = dialog->priv;
395 GtkWidget *child = NULL;
396 GList *children, *tmp_list;
398 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
400 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
402 ResponseData *rd = get_response_data (tmp_list->data, FALSE);
404 if (rd && rd->response_id == response_id)
406 child = tmp_list->data;
411 g_list_free (children);
417 gtk_dialog_close (GtkDialog *dialog)
419 /* Synthesize delete_event to close dialog. */
421 GtkWidget *widget = GTK_WIDGET (dialog);
424 event = gdk_event_new (GDK_DELETE);
426 event->any.window = g_object_ref (gtk_widget_get_window (widget));
427 event->any.send_event = TRUE;
429 gtk_main_do_event (event);
430 gdk_event_free (event);
434 gtk_dialog_new (void)
436 return g_object_new (GTK_TYPE_DIALOG, NULL);
440 gtk_dialog_new_empty (const gchar *title,
442 GtkDialogFlags flags)
446 dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
449 gtk_window_set_title (GTK_WINDOW (dialog), title);
452 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
454 if (flags & GTK_DIALOG_MODAL)
455 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
457 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
458 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
460 return GTK_WIDGET (dialog);
464 * gtk_dialog_new_with_buttons:
465 * @title: (allow-none): Title of the dialog, or %NULL
466 * @parent: (allow-none): Transient parent of the dialog, or %NULL
467 * @flags: from #GtkDialogFlags
468 * @first_button_text: (allow-none): stock ID or text to go in first button, or %NULL
469 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
471 * Creates a new #GtkDialog with title @title (or %NULL for the default
472 * title; see gtk_window_set_title()) and transient parent @parent (or
473 * %NULL for none; see gtk_window_set_transient_for()). The @flags
474 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
475 * and/or to have it destroyed along with its transient parent
476 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
477 * text/response ID pairs should be listed, with a %NULL pointer ending
478 * the list. Button text can be either a stock ID such as
479 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
480 * any positive number, or one of the values in the #GtkResponseType
481 * enumeration. If the user clicks one of these dialog buttons,
482 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
483 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
484 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
485 * However, destroying a dialog does not emit the ::response signal;
486 * so be careful relying on ::response when using the
487 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
488 * so the first button in the list will be the leftmost button in the dialog.
490 * Here's a simple example:
492 * GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
494 * GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
496 * GTK_RESPONSE_ACCEPT,
498 * GTK_RESPONSE_REJECT,
502 * Return value: a new #GtkDialog
505 gtk_dialog_new_with_buttons (const gchar *title,
507 GtkDialogFlags flags,
508 const gchar *first_button_text,
514 dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
516 va_start (args, first_button_text);
518 gtk_dialog_add_buttons_valist (dialog,
524 return GTK_WIDGET (dialog);
528 response_data_free (gpointer data)
530 g_slice_free (ResponseData, data);
534 get_response_data (GtkWidget *widget,
537 ResponseData *ad = g_object_get_data (G_OBJECT (widget),
538 "gtk-dialog-response-data");
540 if (ad == NULL && create)
542 ad = g_slice_new (ResponseData);
544 g_object_set_data_full (G_OBJECT (widget),
545 I_("gtk-dialog-response-data"),
554 action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
558 response_id = gtk_dialog_get_response_for_widget (dialog, widget);
560 gtk_dialog_response (dialog, response_id);
564 * gtk_dialog_add_action_widget:
565 * @dialog: a #GtkDialog
566 * @child: an activatable widget
567 * @response_id: response ID for @child
569 * Adds an activatable widget to the action area of a #GtkDialog,
570 * connecting a signal handler that will emit the #GtkDialog::response
571 * signal on the dialog when the widget is activated. The widget is
572 * appended to the end of the dialog's action area. If you want to add a
573 * non-activatable widget, simply pack it into the @action_area field
574 * of the #GtkDialog struct.
577 gtk_dialog_add_action_widget (GtkDialog *dialog,
581 GtkDialogPrivate *priv;
585 g_return_if_fail (GTK_IS_DIALOG (dialog));
586 g_return_if_fail (GTK_IS_WIDGET (child));
590 ad = get_response_data (child, TRUE);
592 ad->response_id = response_id;
594 if (GTK_IS_BUTTON (child))
595 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
597 signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
603 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
605 g_signal_connect_closure_by_id (child,
612 g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
614 gtk_box_pack_end (GTK_BOX (priv->action_area),
618 if (response_id == GTK_RESPONSE_HELP)
619 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area), child, TRUE);
623 * gtk_dialog_add_button:
624 * @dialog: a #GtkDialog
625 * @button_text: text of button, or stock ID
626 * @response_id: response ID for the button
628 * Adds a button with the given text (or a stock button, if @button_text is a
629 * stock ID) and sets things up so that clicking the button will emit the
630 * #GtkDialog::response signal with the given @response_id. The button is
631 * appended to the end of the dialog's action area. The button widget is
632 * returned, but usually you don't need it.
634 * Return value: (transfer full): the button widget that was added
637 gtk_dialog_add_button (GtkDialog *dialog,
638 const gchar *button_text,
643 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
644 g_return_val_if_fail (button_text != NULL, NULL);
646 button = gtk_button_new_from_stock (button_text);
648 gtk_widget_set_can_default (button, TRUE);
650 gtk_widget_show (button);
652 gtk_dialog_add_action_widget (dialog,
660 gtk_dialog_add_buttons_valist (GtkDialog *dialog,
661 const gchar *first_button_text,
667 g_return_if_fail (GTK_IS_DIALOG (dialog));
669 if (first_button_text == NULL)
672 text = first_button_text;
673 response_id = va_arg (args, gint);
677 gtk_dialog_add_button (dialog, text, response_id);
679 text = va_arg (args, gchar*);
682 response_id = va_arg (args, int);
687 * gtk_dialog_add_buttons:
688 * @dialog: a #GtkDialog
689 * @first_button_text: button text or stock ID
690 * @Varargs: response ID for first button, then more text-response_id pairs
692 * Adds more buttons, same as calling gtk_dialog_add_button()
693 * repeatedly. The variable argument list should be %NULL-terminated
694 * as with gtk_dialog_new_with_buttons(). Each button must have both
695 * text and response ID.
698 gtk_dialog_add_buttons (GtkDialog *dialog,
699 const gchar *first_button_text,
704 va_start (args, first_button_text);
706 gtk_dialog_add_buttons_valist (dialog,
714 * gtk_dialog_set_response_sensitive:
715 * @dialog: a #GtkDialog
716 * @response_id: a response ID
717 * @setting: %TRUE for sensitive
719 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
720 * for each widget in the dialog's action area with the given @response_id.
721 * A convenient way to sensitize/desensitize dialog buttons.
724 gtk_dialog_set_response_sensitive (GtkDialog *dialog,
728 GtkDialogPrivate *priv;
732 g_return_if_fail (GTK_IS_DIALOG (dialog));
736 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
739 while (tmp_list != NULL)
741 GtkWidget *widget = tmp_list->data;
742 ResponseData *rd = get_response_data (widget, FALSE);
744 if (rd && rd->response_id == response_id)
745 gtk_widget_set_sensitive (widget, setting);
747 tmp_list = g_list_next (tmp_list);
750 g_list_free (children);
754 * gtk_dialog_set_default_response:
755 * @dialog: a #GtkDialog
756 * @response_id: a response ID
758 * Sets the last widget in the dialog's action area with the given @response_id
759 * as the default widget for the dialog. Pressing "Enter" normally activates
760 * the default widget.
763 gtk_dialog_set_default_response (GtkDialog *dialog,
766 GtkDialogPrivate *priv;
770 g_return_if_fail (GTK_IS_DIALOG (dialog));
774 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
777 while (tmp_list != NULL)
779 GtkWidget *widget = tmp_list->data;
780 ResponseData *rd = get_response_data (widget, FALSE);
782 if (rd && rd->response_id == response_id)
783 gtk_widget_grab_default (widget);
785 tmp_list = g_list_next (tmp_list);
788 g_list_free (children);
792 * gtk_dialog_response:
793 * @dialog: a #GtkDialog
794 * @response_id: response ID
796 * Emits the #GtkDialog::response signal with the given response ID.
797 * Used to indicate that the user has responded to the dialog in some way;
798 * typically either you or gtk_dialog_run() will be monitoring the
799 * ::response signal and take appropriate action.
802 gtk_dialog_response (GtkDialog *dialog,
805 g_return_if_fail (GTK_IS_DIALOG (dialog));
807 g_signal_emit (dialog,
808 dialog_signals[RESPONSE],
822 shutdown_loop (RunInfo *ri)
824 if (g_main_loop_is_running (ri->loop))
825 g_main_loop_quit (ri->loop);
829 run_unmap_handler (GtkDialog *dialog, gpointer data)
837 run_response_handler (GtkDialog *dialog,
845 ri->response_id = response_id;
851 run_delete_handler (GtkDialog *dialog,
859 return TRUE; /* Do not destroy */
863 run_destroy_handler (GtkDialog *dialog, gpointer data)
867 /* shutdown_loop will be called by run_unmap_handler */
869 ri->destroyed = TRUE;
874 * @dialog: a #GtkDialog
876 * Blocks in a recursive main loop until the @dialog either emits the
877 * #GtkDialog::response signal, or is destroyed. If the dialog is
878 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
879 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
880 * ::response signal emission.
882 * Before entering the recursive main loop, gtk_dialog_run() calls
883 * gtk_widget_show() on the dialog for you. Note that you still
884 * need to show any children of the dialog yourself.
886 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
887 * is disabled; if the dialog receives ::delete_event, it will not be
888 * destroyed as windows usually are, and gtk_dialog_run() will return
889 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
890 * will be modal. You can force gtk_dialog_run() to return at any time by
891 * calling gtk_dialog_response() to emit the ::response signal. Destroying
892 * the dialog during gtk_dialog_run() is a very bad idea, because your
893 * post-run code won't know whether the dialog was destroyed or not.
895 * After gtk_dialog_run() returns, you are responsible for hiding or
896 * destroying the dialog if you wish to do so.
898 * Typical usage of this function might be:
900 * gint result = gtk_dialog_run (GTK_DIALOG (dialog));
903 * case GTK_RESPONSE_ACCEPT:
904 * do_application_specific_something ();
907 * do_nothing_since_dialog_was_cancelled ();
910 * gtk_widget_destroy (dialog);
913 * Note that even though the recursive main loop gives the effect of a
914 * modal dialog (it prevents the user from interacting with other
915 * windows in the same window group while the dialog is run), callbacks
916 * such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
917 * be triggered during a gtk_dialog_run() call.
919 * Return value: response ID
922 gtk_dialog_run (GtkDialog *dialog)
924 RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
926 gulong response_handler;
927 gulong unmap_handler;
928 gulong destroy_handler;
929 gulong delete_handler;
931 g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
933 g_object_ref (dialog);
935 was_modal = gtk_window_get_modal (GTK_WINDOW (dialog));
937 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
939 if (!gtk_widget_get_visible (GTK_WIDGET (dialog)))
940 gtk_widget_show (GTK_WIDGET (dialog));
943 g_signal_connect (dialog,
945 G_CALLBACK (run_response_handler),
949 g_signal_connect (dialog,
951 G_CALLBACK (run_unmap_handler),
955 g_signal_connect (dialog,
957 G_CALLBACK (run_delete_handler),
961 g_signal_connect (dialog,
963 G_CALLBACK (run_destroy_handler),
966 ri.loop = g_main_loop_new (NULL, FALSE);
968 GDK_THREADS_LEAVE ();
969 g_main_loop_run (ri.loop);
970 GDK_THREADS_ENTER ();
972 g_main_loop_unref (ri.loop);
979 gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
981 g_signal_handler_disconnect (dialog, response_handler);
982 g_signal_handler_disconnect (dialog, unmap_handler);
983 g_signal_handler_disconnect (dialog, delete_handler);
984 g_signal_handler_disconnect (dialog, destroy_handler);
987 g_object_unref (dialog);
989 return ri.response_id;
993 * gtk_dialog_get_widget_for_response:
994 * @dialog: a #GtkDialog
995 * @response_id: the response ID used by the @dialog widget
997 * Gets the widget button that uses the given response ID in the action area
1000 * Returns: (transfer none):the @widget button that uses the given @response_id, or %NULL.
1005 gtk_dialog_get_widget_for_response (GtkDialog *dialog,
1008 GtkDialogPrivate *priv;
1012 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1014 priv = dialog->priv;
1016 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
1018 tmp_list = children;
1019 while (tmp_list != NULL)
1021 GtkWidget *widget = tmp_list->data;
1022 ResponseData *rd = get_response_data (widget, FALSE);
1024 if (rd && rd->response_id == response_id)
1026 g_list_free (children);
1030 tmp_list = g_list_next (tmp_list);
1033 g_list_free (children);
1039 * gtk_dialog_get_response_for_widget:
1040 * @dialog: a #GtkDialog
1041 * @widget: a widget in the action area of @dialog
1043 * Gets the response id of a widget in the action area
1046 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
1047 * if @widget doesn't have a response id set.
1052 gtk_dialog_get_response_for_widget (GtkDialog *dialog,
1057 rd = get_response_data (widget, FALSE);
1059 return GTK_RESPONSE_NONE;
1061 return rd->response_id;
1065 * gtk_alternative_dialog_button_order:
1066 * @screen: (allow-none): a #GdkScreen, or %NULL to use the default screen
1068 * Returns %TRUE if dialogs are expected to use an alternative
1069 * button order on the screen @screen. See
1070 * gtk_dialog_set_alternative_button_order() for more details
1071 * about alternative button order.
1073 * If you need to use this function, you should probably connect
1074 * to the ::notify:gtk-alternative-button-order signal on the
1075 * #GtkSettings object associated to @screen, in order to be
1076 * notified if the button order setting changes.
1078 * Returns: Whether the alternative button order should be used
1083 gtk_alternative_dialog_button_order (GdkScreen *screen)
1085 GtkSettings *settings;
1089 settings = gtk_settings_get_for_screen (screen);
1091 settings = gtk_settings_get_default ();
1093 g_object_get (settings,
1094 "gtk-alternative-button-order", &result, NULL);
1100 gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
1101 gint first_response_id,
1104 GtkDialogPrivate *priv = dialog->priv;
1109 response_id = first_response_id;
1111 while (response_id != -1)
1113 /* reorder child with response_id to position */
1114 child = dialog_find_button (dialog, response_id);
1115 gtk_box_reorder_child (GTK_BOX (priv->action_area), child, position);
1117 response_id = va_arg (args, gint);
1123 * gtk_dialog_set_alternative_button_order:
1124 * @dialog: a #GtkDialog
1125 * @first_response_id: a response id used by one @dialog's buttons
1126 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
1128 * Sets an alternative button order. If the
1129 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1130 * the dialog buttons are reordered according to the order of the
1131 * response ids passed to this function.
1133 * By default, GTK+ dialogs use the button order advocated by the Gnome
1134 * <ulink url="http://library.gnome.org/devel/hig-book/stable/">Human
1135 * Interface Guidelines</ulink> with the affirmative button at the far
1136 * right, and the cancel button left of it. But the builtin GTK+ dialogs
1137 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
1138 * which is more suitable on some platforms, e.g. Windows.
1140 * Use this function after adding all the buttons to your dialog, as the
1141 * following example shows:
1143 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1145 * GTK_RESPONSE_CANCEL);
1147 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1151 * gtk_widget_grab_default (ok_button);
1153 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1155 * GTK_RESPONSE_HELP);
1157 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
1159 * GTK_RESPONSE_CANCEL,
1160 * GTK_RESPONSE_HELP,
1167 gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
1168 gint first_response_id,
1174 g_return_if_fail (GTK_IS_DIALOG (dialog));
1176 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1177 if (!gtk_alternative_dialog_button_order (screen))
1180 va_start (args, first_response_id);
1182 gtk_dialog_set_alternative_button_order_valist (dialog,
1188 * gtk_dialog_set_alternative_button_order_from_array:
1189 * @dialog: a #GtkDialog
1190 * @n_params: the number of response ids in @new_order
1191 * @new_order: an array of response ids of @dialog's buttons
1193 * Sets an alternative button order. If the
1194 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1195 * the dialog buttons are reordered according to the order of the
1196 * response ids in @new_order.
1198 * See gtk_dialog_set_alternative_button_order() for more information.
1200 * This function is for use by language bindings.
1205 gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
1209 GtkDialogPrivate *priv = dialog->priv;
1214 g_return_if_fail (GTK_IS_DIALOG (dialog));
1215 g_return_if_fail (new_order != NULL);
1217 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1218 if (!gtk_alternative_dialog_button_order (screen))
1221 for (position = 0; position < n_params; position++)
1223 /* reorder child with response_id to position */
1224 child = dialog_find_button (dialog, new_order[position]);
1225 gtk_box_reorder_child (GTK_BOX (priv->action_area), child, position);
1236 GtkBuilder *builder;
1239 } ActionWidgetsSubParserData;
1242 attributes_start_element (GMarkupParseContext *context,
1243 const gchar *element_name,
1244 const gchar **names,
1245 const gchar **values,
1249 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1252 if (strcmp (element_name, "action-widget") == 0)
1254 for (i = 0; names[i]; i++)
1255 if (strcmp (names[i], "response") == 0)
1256 parser_data->response = g_strdup (values[i]);
1258 else if (strcmp (element_name, "action-widgets") == 0)
1261 g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
1265 attributes_text_element (GMarkupParseContext *context,
1271 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1272 ActionWidgetInfo *item;
1274 if (!parser_data->response)
1277 item = g_new (ActionWidgetInfo, 1);
1278 item->widget_name = g_strndup (text, text_len);
1279 item->response_id = parser_data->response;
1280 parser_data->items = g_slist_prepend (parser_data->items, item);
1281 parser_data->response = NULL;
1284 static const GMarkupParser attributes_parser =
1286 attributes_start_element,
1288 attributes_text_element,
1292 gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
1293 GtkBuilder *builder,
1295 const gchar *tagname,
1296 GMarkupParser *parser,
1299 ActionWidgetsSubParserData *parser_data;
1304 if (strcmp (tagname, "action-widgets") == 0)
1306 parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1307 parser_data->dialog = GTK_DIALOG (buildable);
1308 parser_data->items = NULL;
1310 *parser = attributes_parser;
1311 *data = parser_data;
1315 return parent_buildable_iface->custom_tag_start (buildable, builder, child,
1316 tagname, parser, data);
1320 gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
1321 GtkBuilder *builder,
1323 const gchar *tagname,
1326 GtkDialog *dialog = GTK_DIALOG (buildable);
1327 GtkDialogPrivate *priv = dialog->priv;
1329 ActionWidgetsSubParserData *parser_data;
1334 if (strcmp (tagname, "action-widgets"))
1336 parent_buildable_iface->custom_finished (buildable, builder, child,
1337 tagname, user_data);
1341 parser_data = (ActionWidgetsSubParserData*)user_data;
1342 parser_data->items = g_slist_reverse (parser_data->items);
1344 for (l = parser_data->items; l; l = l->next)
1346 ActionWidgetInfo *item = l->data;
1348 object = gtk_builder_get_object (builder, item->widget_name);
1351 g_warning ("Unknown object %s specified in action-widgets of %s",
1353 gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1357 ad = get_response_data (GTK_WIDGET (object), TRUE);
1358 ad->response_id = g_ascii_strtoll (item->response_id, NULL, 10);
1360 if (GTK_IS_BUTTON (object))
1361 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1363 signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1369 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1371 g_signal_connect_closure_by_id (object,
1378 if (ad->response_id == GTK_RESPONSE_HELP)
1379 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area),
1380 GTK_WIDGET (object), TRUE);
1382 g_free (item->widget_name);
1383 g_free (item->response_id);
1386 g_slist_free (parser_data->items);
1387 g_slice_free (ActionWidgetsSubParserData, parser_data);
1391 * gtk_dialog_get_action_area:
1392 * @dialog: a #GtkDialog
1394 * Returns the action area of @dialog.
1396 * Returns: (transfer none): the action area.
1401 gtk_dialog_get_action_area (GtkDialog *dialog)
1403 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1405 return dialog->priv->action_area;
1409 * gtk_dialog_get_content_area:
1410 * @dialog: a #GtkDialog
1412 * Returns the content area of @dialog.
1414 * Returns: (transfer none): the content area #GtkBox.
1419 gtk_dialog_get_content_area (GtkDialog *dialog)
1421 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1423 return dialog->priv->vbox;