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/.
30 #include "gtkbutton.h"
31 #include "gtkdialog.h"
34 #include "gtkhseparator.h"
35 #include "gtkmarshalers.h"
37 #include "gdkkeysyms.h"
40 #include "gtkbindings.h"
41 #include "gtkprivate.h"
42 #include "gtkbuildable.h"
45 #define GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_DIALOG, GtkDialogPrivate))
48 guint ignore_separator : 1;
51 typedef struct _ResponseData ResponseData;
58 static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
59 const gchar *first_button_text,
62 static gint gtk_dialog_delete_event_handler (GtkWidget *widget,
66 static void gtk_dialog_set_property (GObject *object,
70 static void gtk_dialog_get_property (GObject *object,
74 static void gtk_dialog_style_set (GtkWidget *widget,
75 GtkStyle *prev_style);
76 static void gtk_dialog_map (GtkWidget *widget);
78 static void gtk_dialog_close (GtkDialog *dialog);
80 static ResponseData* get_response_data (GtkWidget *widget,
82 static void gtk_dialog_buildable_interface_init (GtkBuildableIface *iface);
83 static GObject * gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
85 const gchar *childname);
86 static gboolean gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
90 GMarkupParser *parser,
92 static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
110 static guint dialog_signals[LAST_SIGNAL];
112 G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
113 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
114 gtk_dialog_buildable_interface_init))
117 gtk_dialog_class_init (GtkDialogClass *class)
119 GObjectClass *gobject_class;
120 GtkWidgetClass *widget_class;
121 GtkBindingSet *binding_set;
123 gobject_class = G_OBJECT_CLASS (class);
124 widget_class = GTK_WIDGET_CLASS (class);
126 gobject_class->set_property = gtk_dialog_set_property;
127 gobject_class->get_property = gtk_dialog_get_property;
129 widget_class->map = gtk_dialog_map;
130 widget_class->style_set = gtk_dialog_style_set;
132 class->close = gtk_dialog_close;
134 g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
137 * GtkDialog:has-separator:
139 * When %TRUE, the dialog has a separator bar above its buttons.
141 g_object_class_install_property (gobject_class,
143 g_param_spec_boolean ("has-separator",
145 P_("The dialog has a separator bar above its buttons"),
147 GTK_PARAM_READWRITE));
150 * GtkDialog::response:
151 * @dialog: the object on which the signal is emitted
152 * @response_id: the response ID
154 * Emitted when an action widget is clicked, the dialog receives a
155 * delete event, or the application programmer calls gtk_dialog_response().
156 * On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT.
157 * Otherwise, it depends on which action widget was clicked.
159 dialog_signals[RESPONSE] =
160 g_signal_new (I_("response"),
161 G_OBJECT_CLASS_TYPE (class),
163 G_STRUCT_OFFSET (GtkDialogClass, response),
165 _gtk_marshal_NONE__INT,
172 * The ::close signal is a
173 * <link linkend="keybinding-signals">keybinding signal</link>
174 * which getrs emitted when the user uses a keybinding to close
177 * The default binding for this signal is the Escape key.
179 dialog_signals[CLOSE] =
180 g_signal_new (I_("close"),
181 G_OBJECT_CLASS_TYPE (class),
182 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
183 G_STRUCT_OFFSET (GtkDialogClass, close),
185 _gtk_marshal_NONE__NONE,
188 gtk_widget_class_install_style_property (widget_class,
189 g_param_spec_int ("content-area-border",
190 P_("Content area border"),
191 P_("Width of border around the main dialog area"),
195 GTK_PARAM_READABLE));
196 gtk_widget_class_install_style_property (widget_class,
197 g_param_spec_int ("button-spacing",
198 P_("Button spacing"),
199 P_("Spacing between buttons"),
203 GTK_PARAM_READABLE));
205 gtk_widget_class_install_style_property (widget_class,
206 g_param_spec_int ("action-area-border",
207 P_("Action area border"),
208 P_("Width of border around the button area at the bottom of the dialog"),
212 GTK_PARAM_READABLE));
214 binding_set = gtk_binding_set_by_class (class);
216 gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, "close", 0);
220 update_spacings (GtkDialog *dialog)
223 gint content_area_border;
225 gint action_area_border;
227 widget = GTK_WIDGET (dialog);
229 gtk_widget_style_get (widget,
230 "content-area-border", &content_area_border,
231 "button-spacing", &button_spacing,
232 "action-area-border", &action_area_border,
235 gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox),
236 content_area_border);
237 gtk_box_set_spacing (GTK_BOX (dialog->action_area),
239 gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area),
244 gtk_dialog_init (GtkDialog *dialog)
246 GtkDialogPrivate *priv;
248 priv = GET_PRIVATE (dialog);
249 priv->ignore_separator = FALSE;
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 dialog->vbox = gtk_vbox_new (FALSE, 0);
262 gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
263 gtk_widget_show (dialog->vbox);
265 dialog->action_area = gtk_hbutton_box_new ();
267 gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
270 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
272 gtk_widget_show (dialog->action_area);
274 dialog->separator = gtk_hseparator_new ();
275 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
276 gtk_widget_show (dialog->separator);
278 gtk_window_set_type_hint (GTK_WINDOW (dialog),
279 GDK_WINDOW_TYPE_HINT_DIALOG);
280 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
284 gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
286 iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
287 iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
288 iface->custom_finished = gtk_dialog_buildable_custom_finished;
292 gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
294 const gchar *childname)
296 if (strcmp (childname, "vbox") == 0)
297 return G_OBJECT (GTK_DIALOG (buildable)->vbox);
298 else if (strcmp (childname, "action_area") == 0)
299 return G_OBJECT (GTK_DIALOG (buildable)->action_area);
305 gtk_dialog_set_property (GObject *object,
312 dialog = GTK_DIALOG (object);
316 case PROP_HAS_SEPARATOR:
317 gtk_dialog_set_has_separator (dialog, g_value_get_boolean (value));
321 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
327 gtk_dialog_get_property (GObject *object,
334 dialog = GTK_DIALOG (object);
338 case PROP_HAS_SEPARATOR:
339 g_value_set_boolean (value, dialog->separator != NULL);
343 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
349 gtk_dialog_delete_event_handler (GtkWidget *widget,
353 /* emit response signal */
354 gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
356 /* Do the destroy by default */
360 /* A far too tricky heuristic for getting the right initial
361 * focus widget if none was set. What we do is we focus the first
362 * widget in the tab chain, but if this results in the focus
363 * ending up on one of the response widgets _other_ than the
364 * default response, we focus the default response instead.
366 * Additionally, skip selectable labels when looking for the
367 * right initial focus widget.
370 gtk_dialog_map (GtkWidget *widget)
372 GtkWindow *window = GTK_WINDOW (widget);
373 GtkDialog *dialog = GTK_DIALOG (widget);
375 GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
377 if (!window->focus_widget)
379 GList *children, *tmp_list;
380 GtkWidget *first_focus = NULL;
384 g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
386 if (first_focus == NULL)
387 first_focus = window->focus_widget;
388 else if (first_focus == window->focus_widget)
391 if (!GTK_IS_LABEL (window->focus_widget))
394 gtk_label_select_region (GTK_LABEL (window->focus_widget), 0, 0);
398 tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
402 GtkWidget *child = tmp_list->data;
404 if ((window->focus_widget == NULL ||
405 child == window->focus_widget) &&
406 child != window->default_widget &&
407 window->default_widget)
409 gtk_widget_grab_focus (window->default_widget);
413 tmp_list = tmp_list->next;
416 g_list_free (children);
421 gtk_dialog_style_set (GtkWidget *widget,
422 GtkStyle *prev_style)
424 update_spacings (GTK_DIALOG (widget));
428 dialog_find_button (GtkDialog *dialog,
431 GList *children, *tmp_list;
432 GtkWidget *child = NULL;
434 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
436 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
438 ResponseData *rd = get_response_data (tmp_list->data, FALSE);
440 if (rd && rd->response_id == response_id)
442 child = tmp_list->data;
447 g_list_free (children);
453 gtk_dialog_close (GtkDialog *dialog)
455 /* Synthesize delete_event to close dialog. */
457 GtkWidget *widget = GTK_WIDGET (dialog);
460 event = gdk_event_new (GDK_DELETE);
462 event->any.window = g_object_ref (widget->window);
463 event->any.send_event = TRUE;
465 gtk_main_do_event (event);
466 gdk_event_free (event);
470 gtk_dialog_new (void)
472 return g_object_new (GTK_TYPE_DIALOG, NULL);
476 gtk_dialog_new_empty (const gchar *title,
478 GtkDialogFlags flags)
482 dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
485 gtk_window_set_title (GTK_WINDOW (dialog), title);
488 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
490 if (flags & GTK_DIALOG_MODAL)
491 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
493 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
494 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
496 if (flags & GTK_DIALOG_NO_SEPARATOR)
497 gtk_dialog_set_has_separator (dialog, FALSE);
499 return GTK_WIDGET (dialog);
503 * gtk_dialog_new_with_buttons:
504 * @title: Title of the dialog, or %NULL
505 * @parent: Transient parent of the dialog, or %NULL
506 * @flags: from #GtkDialogFlags
507 * @first_button_text: stock ID or text to go in first button, or %NULL
508 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
510 * Creates a new #GtkDialog with title @title (or %NULL for the default
511 * title; see gtk_window_set_title()) and transient parent @parent (or
512 * %NULL for none; see gtk_window_set_transient_for()). The @flags
513 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
514 * and/or to have it destroyed along with its transient parent
515 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
516 * text/response ID pairs should be listed, with a %NULL pointer ending
517 * the list. Button text can be either a stock ID such as
518 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
519 * any positive number, or one of the values in the #GtkResponseType
520 * enumeration. If the user clicks one of these dialog buttons,
521 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
522 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
523 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
524 * However, destroying a dialog does not emit the ::response signal;
525 * so be careful relying on ::response when using the
526 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
527 * so the first button in the list will be the leftmost button in the dialog.
529 * Here's a simple example:
530 * <informalexample><programlisting>
531 * GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
533 * GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
535 * GTK_RESPONSE_ACCEPT,
537 * GTK_RESPONSE_REJECT,
539 * </programlisting></informalexample>
541 * Return value: a new #GtkDialog
544 gtk_dialog_new_with_buttons (const gchar *title,
546 GtkDialogFlags flags,
547 const gchar *first_button_text,
553 dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
555 va_start (args, first_button_text);
557 gtk_dialog_add_buttons_valist (dialog,
563 return GTK_WIDGET (dialog);
567 response_data_free (gpointer data)
569 g_slice_free (ResponseData, data);
573 get_response_data (GtkWidget *widget,
576 ResponseData *ad = g_object_get_data (G_OBJECT (widget),
577 "gtk-dialog-response-data");
579 if (ad == NULL && create)
581 ad = g_slice_new (ResponseData);
583 g_object_set_data_full (G_OBJECT (widget),
584 I_("gtk-dialog-response-data"),
593 action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
597 response_id = gtk_dialog_get_response_for_widget (dialog, widget);
599 gtk_dialog_response (dialog, response_id);
603 * gtk_dialog_add_action_widget:
604 * @dialog: a #GtkDialog
605 * @child: an activatable widget
606 * @response_id: response ID for @child
608 * Adds an activatable widget to the action area of a #GtkDialog,
609 * connecting a signal handler that will emit the #GtkDialog::response
610 * signal on the dialog when the widget is activated. The widget is
611 * appended to the end of the dialog's action area. If you want to add a
612 * non-activatable widget, simply pack it into the @action_area field
613 * of the #GtkDialog struct.
616 gtk_dialog_add_action_widget (GtkDialog *dialog,
623 g_return_if_fail (GTK_IS_DIALOG (dialog));
624 g_return_if_fail (GTK_IS_WIDGET (child));
626 ad = get_response_data (child, TRUE);
628 ad->response_id = response_id;
630 if (GTK_IS_BUTTON (child))
631 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
633 signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
639 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
641 g_signal_connect_closure_by_id (child,
648 g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
650 gtk_box_pack_end (GTK_BOX (dialog->action_area),
654 if (response_id == GTK_RESPONSE_HELP)
655 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
659 * gtk_dialog_add_button:
660 * @dialog: a #GtkDialog
661 * @button_text: text of button, or stock ID
662 * @response_id: response ID for the button
664 * Adds a button with the given text (or a stock button, if @button_text is a
665 * stock ID) and sets things up so that clicking the button will emit the
666 * #GtkDialog::response signal with the given @response_id. The button is
667 * appended to the end of the dialog's action area. The button widget is
668 * returned, but usually you don't need it.
670 * Return value: the button widget that was added
673 gtk_dialog_add_button (GtkDialog *dialog,
674 const gchar *button_text,
679 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
680 g_return_val_if_fail (button_text != NULL, NULL);
682 button = gtk_button_new_from_stock (button_text);
684 GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
686 gtk_widget_show (button);
688 gtk_dialog_add_action_widget (dialog,
696 gtk_dialog_add_buttons_valist (GtkDialog *dialog,
697 const gchar *first_button_text,
703 g_return_if_fail (GTK_IS_DIALOG (dialog));
705 if (first_button_text == NULL)
708 text = first_button_text;
709 response_id = va_arg (args, gint);
713 gtk_dialog_add_button (dialog, text, response_id);
715 text = va_arg (args, gchar*);
718 response_id = va_arg (args, int);
723 * gtk_dialog_add_buttons:
724 * @dialog: a #GtkDialog
725 * @first_button_text: button text or stock ID
726 * @Varargs: response ID for first button, then more text-response_id pairs
728 * Adds more buttons, same as calling gtk_dialog_add_button()
729 * repeatedly. The variable argument list should be %NULL-terminated
730 * as with gtk_dialog_new_with_buttons(). Each button must have both
731 * text and response ID.
734 gtk_dialog_add_buttons (GtkDialog *dialog,
735 const gchar *first_button_text,
740 va_start (args, first_button_text);
742 gtk_dialog_add_buttons_valist (dialog,
750 * gtk_dialog_set_response_sensitive:
751 * @dialog: a #GtkDialog
752 * @response_id: a response ID
753 * @setting: %TRUE for sensitive
755 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
756 * for each widget in the dialog's action area with the given @response_id.
757 * A convenient way to sensitize/desensitize dialog buttons.
760 gtk_dialog_set_response_sensitive (GtkDialog *dialog,
767 g_return_if_fail (GTK_IS_DIALOG (dialog));
769 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
772 while (tmp_list != NULL)
774 GtkWidget *widget = tmp_list->data;
775 ResponseData *rd = get_response_data (widget, FALSE);
777 if (rd && rd->response_id == response_id)
778 gtk_widget_set_sensitive (widget, setting);
780 tmp_list = g_list_next (tmp_list);
783 g_list_free (children);
787 * gtk_dialog_set_default_response:
788 * @dialog: a #GtkDialog
789 * @response_id: a response ID
791 * Sets the last widget in the dialog's action area with the given @response_id
792 * as the default widget for the dialog. Pressing "Enter" normally activates
793 * the default widget.
796 gtk_dialog_set_default_response (GtkDialog *dialog,
802 g_return_if_fail (GTK_IS_DIALOG (dialog));
804 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
807 while (tmp_list != NULL)
809 GtkWidget *widget = tmp_list->data;
810 ResponseData *rd = get_response_data (widget, FALSE);
812 if (rd && rd->response_id == response_id)
813 gtk_widget_grab_default (widget);
815 tmp_list = g_list_next (tmp_list);
818 g_list_free (children);
822 * gtk_dialog_set_has_separator:
823 * @dialog: a #GtkDialog
824 * @setting: %TRUE to have a separator
826 * Sets whether the dialog has a separator above the buttons.
830 gtk_dialog_set_has_separator (GtkDialog *dialog,
833 GtkDialogPrivate *priv;
835 g_return_if_fail (GTK_IS_DIALOG (dialog));
837 priv = GET_PRIVATE (dialog);
839 /* this might fail if we get called before _init() somehow */
840 g_assert (dialog->vbox != NULL);
842 if (priv->ignore_separator)
844 g_warning ("Ignoring the separator setting");
848 if (setting && dialog->separator == NULL)
850 dialog->separator = gtk_hseparator_new ();
851 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
853 /* The app programmer could screw this up, but, their own fault.
854 * Moves the separator just above the action area.
856 gtk_box_reorder_child (GTK_BOX (dialog->vbox), dialog->separator, 1);
857 gtk_widget_show (dialog->separator);
859 else if (!setting && dialog->separator != NULL)
861 gtk_widget_destroy (dialog->separator);
862 dialog->separator = NULL;
865 g_object_notify (G_OBJECT (dialog), "has-separator");
869 * gtk_dialog_get_has_separator:
870 * @dialog: a #GtkDialog
872 * Accessor for whether the dialog has a separator.
874 * Return value: %TRUE if the dialog has a separator
877 gtk_dialog_get_has_separator (GtkDialog *dialog)
879 g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);
881 return dialog->separator != NULL;
885 * gtk_dialog_response:
886 * @dialog: a #GtkDialog
887 * @response_id: response ID
889 * Emits the #GtkDialog::response signal with the given response ID.
890 * Used to indicate that the user has responded to the dialog in some way;
891 * typically either you or gtk_dialog_run() will be monitoring the
892 * ::response signal and take appropriate action.
895 gtk_dialog_response (GtkDialog *dialog,
898 g_return_if_fail (GTK_IS_DIALOG (dialog));
900 g_signal_emit (dialog,
901 dialog_signals[RESPONSE],
915 shutdown_loop (RunInfo *ri)
917 if (g_main_loop_is_running (ri->loop))
918 g_main_loop_quit (ri->loop);
922 run_unmap_handler (GtkDialog *dialog, gpointer data)
930 run_response_handler (GtkDialog *dialog,
938 ri->response_id = response_id;
944 run_delete_handler (GtkDialog *dialog,
952 return TRUE; /* Do not destroy */
956 run_destroy_handler (GtkDialog *dialog, gpointer data)
960 /* shutdown_loop will be called by run_unmap_handler */
962 ri->destroyed = TRUE;
967 * @dialog: a #GtkDialog
969 * Blocks in a recursive main loop until the @dialog either emits the
970 * #GtkDialog::response signal, or is destroyed. If the dialog is
971 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
972 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
973 * ::response signal emission.
975 * Before entering the recursive main loop, gtk_dialog_run() calls
976 * gtk_widget_show() on the dialog for you. Note that you still
977 * need to show any children of the dialog yourself.
979 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
980 * is disabled; if the dialog receives ::delete_event, it will not be
981 * destroyed as windows usually are, and gtk_dialog_run() will return
982 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
983 * will be modal. You can force gtk_dialog_run() to return at any time by
984 * calling gtk_dialog_response() to emit the ::response signal. Destroying
985 * the dialog during gtk_dialog_run() is a very bad idea, because your
986 * post-run code won't know whether the dialog was destroyed or not.
988 * After gtk_dialog_run() returns, you are responsible for hiding or
989 * destroying the dialog if you wish to do so.
991 * Typical usage of this function might be:
992 * <informalexample><programlisting>
993 * gint result = gtk_dialog_run (GTK_DIALOG (dialog));
996 * case GTK_RESPONSE_ACCEPT:
997 * do_application_specific_something (<!-- -->);
1000 * do_nothing_since_dialog_was_cancelled (<!-- -->);
1003 * gtk_widget_destroy (dialog);
1004 * </programlisting></informalexample>
1006 * Note that even though the recursive main loop gives the effect of a
1007 * modal dialog (it prevents the user from interacting with other
1008 * windows in the same window group while the dialog is run), callbacks
1009 * such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
1010 * be triggered during a gtk_dialog_run() call.
1012 * Return value: response ID
1015 gtk_dialog_run (GtkDialog *dialog)
1017 RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
1019 gulong response_handler;
1020 gulong unmap_handler;
1021 gulong destroy_handler;
1022 gulong delete_handler;
1024 g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
1026 g_object_ref (dialog);
1028 was_modal = GTK_WINDOW (dialog)->modal;
1030 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
1032 if (!GTK_WIDGET_VISIBLE (dialog))
1033 gtk_widget_show (GTK_WIDGET (dialog));
1036 g_signal_connect (dialog,
1038 G_CALLBACK (run_response_handler),
1042 g_signal_connect (dialog,
1044 G_CALLBACK (run_unmap_handler),
1048 g_signal_connect (dialog,
1050 G_CALLBACK (run_delete_handler),
1054 g_signal_connect (dialog,
1056 G_CALLBACK (run_destroy_handler),
1059 ri.loop = g_main_loop_new (NULL, FALSE);
1061 GDK_THREADS_LEAVE ();
1062 g_main_loop_run (ri.loop);
1063 GDK_THREADS_ENTER ();
1065 g_main_loop_unref (ri.loop);
1072 gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
1074 g_signal_handler_disconnect (dialog, response_handler);
1075 g_signal_handler_disconnect (dialog, unmap_handler);
1076 g_signal_handler_disconnect (dialog, delete_handler);
1077 g_signal_handler_disconnect (dialog, destroy_handler);
1080 g_object_unref (dialog);
1082 return ri.response_id;
1086 _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
1087 gboolean ignore_separator)
1089 GtkDialogPrivate *priv;
1091 priv = GET_PRIVATE (dialog);
1092 priv->ignore_separator = ignore_separator;
1096 * gtk_dialog_get_response_for_widget:
1097 * @dialog: a #GtkDialog
1098 * @widget: a widget in the action area of @dialog
1100 * Gets the response id of a widget in the action area
1103 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
1104 * if @widget doesn't have a response id set.
1109 gtk_dialog_get_response_for_widget (GtkDialog *dialog,
1114 rd = get_response_data (widget, FALSE);
1116 return GTK_RESPONSE_NONE;
1118 return rd->response_id;
1122 * gtk_alternative_dialog_button_order:
1123 * @screen: a #GdkScreen, or %NULL to use the default screen
1125 * Returns %TRUE if dialogs are expected to use an alternative
1126 * button order on the screen @screen. See
1127 * gtk_dialog_set_alternative_button_order() for more details
1128 * about alternative button order.
1130 * If you need to use this function, you should probably connect
1131 * to the ::notify:gtk-alternative-button-order signal on the
1132 * #GtkSettings object associated to @screen, in order to be
1133 * notified if the button order setting changes.
1135 * Returns: Whether the alternative button order should be used
1140 gtk_alternative_dialog_button_order (GdkScreen *screen)
1142 GtkSettings *settings;
1146 settings = gtk_settings_get_for_screen (screen);
1148 settings = gtk_settings_get_default ();
1150 g_object_get (settings,
1151 "gtk-alternative-button-order", &result, NULL);
1157 gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
1158 gint first_response_id,
1165 response_id = first_response_id;
1167 while (response_id != -1)
1169 /* reorder child with response_id to position */
1170 child = dialog_find_button (dialog, response_id);
1171 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1173 response_id = va_arg (args, gint);
1179 * gtk_dialog_set_alternative_button_order:
1180 * @dialog: a #GtkDialog
1181 * @first_response_id: a response id used by one @dialog's buttons
1182 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
1184 * Sets an alternative button order. If the
1185 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1186 * the dialog buttons are reordered according to the order of the
1187 * response ids passed to this function.
1189 * By default, GTK+ dialogs use the button order advocated by the Gnome
1190 * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
1191 * Interface Guidelines</ulink> with the affirmative button at the far
1192 * right, and the cancel button left of it. But the builtin GTK+ dialogs
1193 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
1194 * which is more suitable on some platforms, e.g. Windows.
1196 * Use this function after adding all the buttons to your dialog, as the
1197 * following example shows:
1198 * <informalexample><programlisting>
1199 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1201 * GTK_RESPONSE_CANCEL);
1203 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1207 * gtk_widget_grab_default (ok_button);
1209 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1211 * GTK_RESPONSE_HELP);
1213 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
1215 * GTK_RESPONSE_CANCEL,
1216 * GTK_RESPONSE_HELP,
1218 * </programlisting></informalexample>
1223 gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
1224 gint first_response_id,
1230 g_return_if_fail (GTK_IS_DIALOG (dialog));
1232 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1233 if (!gtk_alternative_dialog_button_order (screen))
1236 va_start (args, first_response_id);
1238 gtk_dialog_set_alternative_button_order_valist (dialog,
1244 * gtk_dialog_set_alternative_button_order_from_array:
1245 * @dialog: a #GtkDialog
1246 * @n_params: the number of response ids in @new_order
1247 * @new_order: an array of response ids of @dialog's buttons
1249 * Sets an alternative button order. If the
1250 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1251 * the dialog buttons are reordered according to the order of the
1252 * response ids in @new_order.
1254 * See gtk_dialog_set_alternative_button_order() for more information.
1256 * This function is for use by language bindings.
1261 gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
1269 g_return_if_fail (GTK_IS_DIALOG (dialog));
1270 g_return_if_fail (new_order != NULL);
1272 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1273 if (!gtk_alternative_dialog_button_order (screen))
1276 for (position = 0; position < n_params; position++)
1278 /* reorder child with response_id to position */
1279 child = dialog_find_button (dialog, new_order[position]);
1280 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1291 GtkBuilder *builder;
1294 } ActionWidgetsSubParserData;
1297 attributes_start_element (GMarkupParseContext *context,
1298 const gchar *element_name,
1299 const gchar **names,
1300 const gchar **values,
1304 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1307 if (strcmp (element_name, "action-widget") == 0)
1308 for (i = 0; names[i]; i++)
1309 if (strcmp (names[i], "response") == 0)
1310 parser_data->response = g_strdup (values[i]);
1311 else if (strcmp (element_name, "action-widgets") == 0)
1314 g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
1318 attributes_text_element (GMarkupParseContext *context,
1324 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1325 ActionWidgetInfo *item;
1327 if (!parser_data->response)
1330 item = g_new (ActionWidgetInfo, 1);
1331 item->widget_name = g_strndup (text, text_len);
1332 item->response_id = parser_data->response;
1333 parser_data->items = g_slist_prepend (parser_data->items, item);
1334 parser_data->response = NULL;
1337 static const GMarkupParser attributes_parser =
1339 attributes_start_element,
1341 attributes_text_element,
1345 gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
1346 GtkBuilder *builder,
1348 const gchar *tagname,
1349 GMarkupParser *parser,
1352 ActionWidgetsSubParserData *parser_data;
1357 if (strcmp (tagname, "action-widgets") == 0)
1359 parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1360 parser_data->dialog = GTK_DIALOG (buildable);
1361 parser_data->items = NULL;
1363 *parser = attributes_parser;
1364 *data = parser_data;
1372 gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
1373 GtkBuilder *builder,
1375 const gchar *tagname,
1379 ActionWidgetsSubParserData *parser_data;
1385 if (strcmp (tagname, "action-widgets"))
1388 dialog = GTK_DIALOG (buildable);
1389 parser_data = (ActionWidgetsSubParserData*)user_data;
1390 parser_data->items = g_slist_reverse (parser_data->items);
1392 for (l = parser_data->items; l; l = l->next)
1394 ActionWidgetInfo *item = l->data;
1396 object = gtk_builder_get_object (builder, item->widget_name);
1399 g_warning ("Unknown object %s specified in action-widgets of %s",
1401 gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1405 ad = get_response_data (GTK_WIDGET (object), TRUE);
1406 ad->response_id = atoi (item->response_id);
1408 if (GTK_IS_BUTTON (object))
1409 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1411 signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1417 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1419 g_signal_connect_closure_by_id (object,
1426 if (ad->response_id == GTK_RESPONSE_HELP)
1427 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area),
1428 GTK_WIDGET (object), TRUE);
1430 g_free (item->widget_name);
1431 g_free (item->response_id);
1434 g_slist_free (parser_data->items);
1435 g_slice_free (ActionWidgetsSubParserData, parser_data);
1438 #define __GTK_DIALOG_C__
1439 #include "gtkaliasdef.c"