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 gboolean 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,
83 static void gtk_dialog_buildable_interface_init (GtkBuildableIface *iface);
84 static GObject * gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
86 const gchar *childname);
87 static gboolean gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
91 GMarkupParser *parser,
93 static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
111 static guint dialog_signals[LAST_SIGNAL];
113 G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
114 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
115 gtk_dialog_buildable_interface_init))
118 gtk_dialog_class_init (GtkDialogClass *class)
120 GObjectClass *gobject_class;
121 GtkWidgetClass *widget_class;
122 GtkBindingSet *binding_set;
124 gobject_class = G_OBJECT_CLASS (class);
125 widget_class = GTK_WIDGET_CLASS (class);
127 gobject_class->set_property = gtk_dialog_set_property;
128 gobject_class->get_property = gtk_dialog_get_property;
130 widget_class->map = gtk_dialog_map;
131 widget_class->style_set = gtk_dialog_style_set;
133 class->close = gtk_dialog_close;
135 g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
138 * GtkDialog:has-separator:
140 * When %TRUE, the dialog has a separator bar above its buttons.
142 g_object_class_install_property (gobject_class,
144 g_param_spec_boolean ("has-separator",
146 P_("The dialog has a separator bar above its buttons"),
148 GTK_PARAM_READWRITE));
151 * GtkDialog::response:
152 * @dialog: the object on which the signal is emitted
153 * @response_id: the response ID
155 * Emitted when an action widget is clicked, the dialog receives a
156 * delete event, or the application programmer calls gtk_dialog_response().
157 * On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT.
158 * Otherwise, it depends on which action widget was clicked.
160 dialog_signals[RESPONSE] =
161 g_signal_new (I_("response"),
162 G_OBJECT_CLASS_TYPE (class),
164 G_STRUCT_OFFSET (GtkDialogClass, response),
166 _gtk_marshal_VOID__INT,
173 * The ::close signal is a
174 * <link linkend="keybinding-signals">keybinding signal</link>
175 * which gets emitted when the user uses a keybinding to close
178 * The default binding for this signal is the Escape key.
180 dialog_signals[CLOSE] =
181 g_signal_new (I_("close"),
182 G_OBJECT_CLASS_TYPE (class),
183 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
184 G_STRUCT_OFFSET (GtkDialogClass, close),
186 _gtk_marshal_VOID__VOID,
189 gtk_widget_class_install_style_property (widget_class,
190 g_param_spec_int ("content-area-border",
191 P_("Content area border"),
192 P_("Width of border around the main dialog area"),
196 GTK_PARAM_READABLE));
198 * GtkDialog:content-area-spacing:
200 * The default spacing used between elements of the
201 * content area of the dialog, as returned by
202 * gtk_dialog_get_content_area(), unless gtk_box_set_spacing()
203 * was called on that widget directly.
207 gtk_widget_class_install_style_property (widget_class,
208 g_param_spec_int ("content-area-spacing",
209 P_("Content area spacing"),
210 P_("Spacing between elements of the main dialog area"),
214 GTK_PARAM_READABLE));
215 gtk_widget_class_install_style_property (widget_class,
216 g_param_spec_int ("button-spacing",
217 P_("Button spacing"),
218 P_("Spacing between buttons"),
222 GTK_PARAM_READABLE));
224 gtk_widget_class_install_style_property (widget_class,
225 g_param_spec_int ("action-area-border",
226 P_("Action area border"),
227 P_("Width of border around the button area at the bottom of the dialog"),
231 GTK_PARAM_READABLE));
233 binding_set = gtk_binding_set_by_class (class);
235 gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, "close", 0);
239 update_spacings (GtkDialog *dialog)
241 gint content_area_border;
242 gint content_area_spacing;
244 gint action_area_border;
246 gtk_widget_style_get (GTK_WIDGET (dialog),
247 "content-area-border", &content_area_border,
248 "content-area-spacing", &content_area_spacing,
249 "button-spacing", &button_spacing,
250 "action-area-border", &action_area_border,
253 gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox),
254 content_area_border);
255 if (!_gtk_box_get_spacing_set (GTK_BOX (dialog->vbox)))
257 gtk_box_set_spacing (GTK_BOX (dialog->vbox), content_area_spacing);
258 _gtk_box_set_spacing_set (GTK_BOX (dialog->vbox), FALSE);
260 gtk_box_set_spacing (GTK_BOX (dialog->action_area),
262 gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area),
267 gtk_dialog_init (GtkDialog *dialog)
269 GtkDialogPrivate *priv;
271 priv = GET_PRIVATE (dialog);
272 priv->ignore_separator = FALSE;
274 /* To avoid breaking old code that prevents destroy on delete event
275 * by connecting a handler, we have to have the FIRST signal
276 * connection on the dialog.
278 g_signal_connect (dialog,
280 G_CALLBACK (gtk_dialog_delete_event_handler),
283 dialog->vbox = gtk_vbox_new (FALSE, 0);
285 gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
286 gtk_widget_show (dialog->vbox);
288 dialog->action_area = gtk_hbutton_box_new ();
290 gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
293 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
295 gtk_widget_show (dialog->action_area);
297 dialog->separator = gtk_hseparator_new ();
298 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
299 gtk_widget_show (dialog->separator);
301 gtk_window_set_type_hint (GTK_WINDOW (dialog),
302 GDK_WINDOW_TYPE_HINT_DIALOG);
303 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
306 static GtkBuildableIface *parent_buildable_iface;
309 gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
311 parent_buildable_iface = g_type_interface_peek_parent (iface);
312 iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
313 iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
314 iface->custom_finished = gtk_dialog_buildable_custom_finished;
318 gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
320 const gchar *childname)
322 if (strcmp (childname, "vbox") == 0)
323 return G_OBJECT (GTK_DIALOG (buildable)->vbox);
324 else if (strcmp (childname, "action_area") == 0)
325 return G_OBJECT (GTK_DIALOG (buildable)->action_area);
327 return parent_buildable_iface->get_internal_child (buildable,
333 gtk_dialog_set_property (GObject *object,
340 dialog = GTK_DIALOG (object);
344 case PROP_HAS_SEPARATOR:
345 gtk_dialog_set_has_separator (dialog, g_value_get_boolean (value));
349 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
355 gtk_dialog_get_property (GObject *object,
362 dialog = GTK_DIALOG (object);
366 case PROP_HAS_SEPARATOR:
367 g_value_set_boolean (value, dialog->separator != NULL);
371 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
377 gtk_dialog_delete_event_handler (GtkWidget *widget,
381 /* emit response signal */
382 gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
384 /* Do the destroy by default */
388 /* A far too tricky heuristic for getting the right initial
389 * focus widget if none was set. What we do is we focus the first
390 * widget in the tab chain, but if this results in the focus
391 * ending up on one of the response widgets _other_ than the
392 * default response, we focus the default response instead.
394 * Additionally, skip selectable labels when looking for the
395 * right initial focus widget.
398 gtk_dialog_map (GtkWidget *widget)
400 GtkWindow *window = GTK_WINDOW (widget);
401 GtkDialog *dialog = GTK_DIALOG (widget);
403 GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
405 if (!window->focus_widget)
407 GList *children, *tmp_list;
408 GtkWidget *first_focus = NULL;
412 g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
414 if (first_focus == NULL)
415 first_focus = window->focus_widget;
416 else if (first_focus == window->focus_widget)
419 if (!GTK_IS_LABEL (window->focus_widget))
422 gtk_label_select_region (GTK_LABEL (window->focus_widget), 0, 0);
426 tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
430 GtkWidget *child = tmp_list->data;
432 if ((window->focus_widget == NULL ||
433 child == window->focus_widget) &&
434 child != window->default_widget &&
435 window->default_widget)
437 gtk_widget_grab_focus (window->default_widget);
441 tmp_list = tmp_list->next;
444 g_list_free (children);
449 gtk_dialog_style_set (GtkWidget *widget,
450 GtkStyle *prev_style)
452 update_spacings (GTK_DIALOG (widget));
456 dialog_find_button (GtkDialog *dialog,
459 GList *children, *tmp_list;
460 GtkWidget *child = NULL;
462 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
464 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
466 ResponseData *rd = get_response_data (tmp_list->data, FALSE);
468 if (rd && rd->response_id == response_id)
470 child = tmp_list->data;
475 g_list_free (children);
481 gtk_dialog_close (GtkDialog *dialog)
483 /* Synthesize delete_event to close dialog. */
485 GtkWidget *widget = GTK_WIDGET (dialog);
488 event = gdk_event_new (GDK_DELETE);
490 event->any.window = g_object_ref (widget->window);
491 event->any.send_event = TRUE;
493 gtk_main_do_event (event);
494 gdk_event_free (event);
498 gtk_dialog_new (void)
500 return g_object_new (GTK_TYPE_DIALOG, NULL);
504 gtk_dialog_new_empty (const gchar *title,
506 GtkDialogFlags flags)
510 dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
513 gtk_window_set_title (GTK_WINDOW (dialog), title);
516 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
518 if (flags & GTK_DIALOG_MODAL)
519 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
521 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
522 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
524 if (flags & GTK_DIALOG_NO_SEPARATOR)
525 gtk_dialog_set_has_separator (dialog, FALSE);
527 return GTK_WIDGET (dialog);
531 * gtk_dialog_new_with_buttons:
532 * @title: (allow-none): Title of the dialog, or %NULL
533 * @parent: (allow-none): Transient parent of the dialog, or %NULL
534 * @flags: from #GtkDialogFlags
535 * @first_button_text: (allow-none): stock ID or text to go in first button, or %NULL
536 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
538 * Creates a new #GtkDialog with title @title (or %NULL for the default
539 * title; see gtk_window_set_title()) and transient parent @parent (or
540 * %NULL for none; see gtk_window_set_transient_for()). The @flags
541 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
542 * and/or to have it destroyed along with its transient parent
543 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
544 * text/response ID pairs should be listed, with a %NULL pointer ending
545 * the list. Button text can be either a stock ID such as
546 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
547 * any positive number, or one of the values in the #GtkResponseType
548 * enumeration. If the user clicks one of these dialog buttons,
549 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
550 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
551 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
552 * However, destroying a dialog does not emit the ::response signal;
553 * so be careful relying on ::response when using the
554 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
555 * so the first button in the list will be the leftmost button in the dialog.
557 * Here's a simple example:
559 * GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
561 * GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
563 * GTK_RESPONSE_ACCEPT,
565 * GTK_RESPONSE_REJECT,
569 * Return value: a new #GtkDialog
572 gtk_dialog_new_with_buttons (const gchar *title,
574 GtkDialogFlags flags,
575 const gchar *first_button_text,
581 dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
583 va_start (args, first_button_text);
585 gtk_dialog_add_buttons_valist (dialog,
591 return GTK_WIDGET (dialog);
595 response_data_free (gpointer data)
597 g_slice_free (ResponseData, data);
601 get_response_data (GtkWidget *widget,
604 ResponseData *ad = g_object_get_data (G_OBJECT (widget),
605 "gtk-dialog-response-data");
607 if (ad == NULL && create)
609 ad = g_slice_new (ResponseData);
611 g_object_set_data_full (G_OBJECT (widget),
612 I_("gtk-dialog-response-data"),
621 action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
625 response_id = gtk_dialog_get_response_for_widget (dialog, widget);
627 gtk_dialog_response (dialog, response_id);
631 * gtk_dialog_add_action_widget:
632 * @dialog: a #GtkDialog
633 * @child: an activatable widget
634 * @response_id: response ID for @child
636 * Adds an activatable widget to the action area of a #GtkDialog,
637 * connecting a signal handler that will emit the #GtkDialog::response
638 * signal on the dialog when the widget is activated. The widget is
639 * appended to the end of the dialog's action area. If you want to add a
640 * non-activatable widget, simply pack it into the @action_area field
641 * of the #GtkDialog struct.
644 gtk_dialog_add_action_widget (GtkDialog *dialog,
651 g_return_if_fail (GTK_IS_DIALOG (dialog));
652 g_return_if_fail (GTK_IS_WIDGET (child));
654 ad = get_response_data (child, TRUE);
656 ad->response_id = response_id;
658 if (GTK_IS_BUTTON (child))
659 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
661 signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
667 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
669 g_signal_connect_closure_by_id (child,
676 g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
678 gtk_box_pack_end (GTK_BOX (dialog->action_area),
682 if (response_id == GTK_RESPONSE_HELP)
683 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
687 * gtk_dialog_add_button:
688 * @dialog: a #GtkDialog
689 * @button_text: text of button, or stock ID
690 * @response_id: response ID for the button
692 * Adds a button with the given text (or a stock button, if @button_text is a
693 * stock ID) and sets things up so that clicking the button will emit the
694 * #GtkDialog::response signal with the given @response_id. The button is
695 * appended to the end of the dialog's action area. The button widget is
696 * returned, but usually you don't need it.
698 * Return value: the button widget that was added
701 gtk_dialog_add_button (GtkDialog *dialog,
702 const gchar *button_text,
707 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
708 g_return_val_if_fail (button_text != NULL, NULL);
710 button = gtk_button_new_from_stock (button_text);
712 gtk_widget_set_can_default (button, TRUE);
714 gtk_widget_show (button);
716 gtk_dialog_add_action_widget (dialog,
724 gtk_dialog_add_buttons_valist (GtkDialog *dialog,
725 const gchar *first_button_text,
731 g_return_if_fail (GTK_IS_DIALOG (dialog));
733 if (first_button_text == NULL)
736 text = first_button_text;
737 response_id = va_arg (args, gint);
741 gtk_dialog_add_button (dialog, text, response_id);
743 text = va_arg (args, gchar*);
746 response_id = va_arg (args, int);
751 * gtk_dialog_add_buttons:
752 * @dialog: a #GtkDialog
753 * @first_button_text: button text or stock ID
754 * @Varargs: response ID for first button, then more text-response_id pairs
756 * Adds more buttons, same as calling gtk_dialog_add_button()
757 * repeatedly. The variable argument list should be %NULL-terminated
758 * as with gtk_dialog_new_with_buttons(). Each button must have both
759 * text and response ID.
762 gtk_dialog_add_buttons (GtkDialog *dialog,
763 const gchar *first_button_text,
768 va_start (args, first_button_text);
770 gtk_dialog_add_buttons_valist (dialog,
778 * gtk_dialog_set_response_sensitive:
779 * @dialog: a #GtkDialog
780 * @response_id: a response ID
781 * @setting: %TRUE for sensitive
783 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
784 * for each widget in the dialog's action area with the given @response_id.
785 * A convenient way to sensitize/desensitize dialog buttons.
788 gtk_dialog_set_response_sensitive (GtkDialog *dialog,
795 g_return_if_fail (GTK_IS_DIALOG (dialog));
797 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
800 while (tmp_list != NULL)
802 GtkWidget *widget = tmp_list->data;
803 ResponseData *rd = get_response_data (widget, FALSE);
805 if (rd && rd->response_id == response_id)
806 gtk_widget_set_sensitive (widget, setting);
808 tmp_list = g_list_next (tmp_list);
811 g_list_free (children);
815 * gtk_dialog_set_default_response:
816 * @dialog: a #GtkDialog
817 * @response_id: a response ID
819 * Sets the last widget in the dialog's action area with the given @response_id
820 * as the default widget for the dialog. Pressing "Enter" normally activates
821 * the default widget.
824 gtk_dialog_set_default_response (GtkDialog *dialog,
830 g_return_if_fail (GTK_IS_DIALOG (dialog));
832 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
835 while (tmp_list != NULL)
837 GtkWidget *widget = tmp_list->data;
838 ResponseData *rd = get_response_data (widget, FALSE);
840 if (rd && rd->response_id == response_id)
841 gtk_widget_grab_default (widget);
843 tmp_list = g_list_next (tmp_list);
846 g_list_free (children);
850 * gtk_dialog_set_has_separator:
851 * @dialog: a #GtkDialog
852 * @setting: %TRUE to have a separator
854 * Sets whether the dialog has a separator above the buttons.
858 gtk_dialog_set_has_separator (GtkDialog *dialog,
861 GtkDialogPrivate *priv;
863 g_return_if_fail (GTK_IS_DIALOG (dialog));
865 priv = GET_PRIVATE (dialog);
867 /* this might fail if we get called before _init() somehow */
868 g_assert (dialog->vbox != NULL);
870 if (priv->ignore_separator)
872 g_warning ("Ignoring the separator setting");
876 if (setting && dialog->separator == NULL)
878 dialog->separator = gtk_hseparator_new ();
879 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
881 /* The app programmer could screw this up, but, their own fault.
882 * Moves the separator just above the action area.
884 gtk_box_reorder_child (GTK_BOX (dialog->vbox), dialog->separator, 1);
885 gtk_widget_show (dialog->separator);
887 else if (!setting && dialog->separator != NULL)
889 gtk_widget_destroy (dialog->separator);
890 dialog->separator = NULL;
893 g_object_notify (G_OBJECT (dialog), "has-separator");
897 * gtk_dialog_get_has_separator:
898 * @dialog: a #GtkDialog
900 * Accessor for whether the dialog has a separator.
902 * Return value: %TRUE if the dialog has a separator
905 gtk_dialog_get_has_separator (GtkDialog *dialog)
907 g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);
909 return dialog->separator != NULL;
913 * gtk_dialog_response:
914 * @dialog: a #GtkDialog
915 * @response_id: response ID
917 * Emits the #GtkDialog::response signal with the given response ID.
918 * Used to indicate that the user has responded to the dialog in some way;
919 * typically either you or gtk_dialog_run() will be monitoring the
920 * ::response signal and take appropriate action.
923 gtk_dialog_response (GtkDialog *dialog,
926 g_return_if_fail (GTK_IS_DIALOG (dialog));
928 g_signal_emit (dialog,
929 dialog_signals[RESPONSE],
943 shutdown_loop (RunInfo *ri)
945 if (g_main_loop_is_running (ri->loop))
946 g_main_loop_quit (ri->loop);
950 run_unmap_handler (GtkDialog *dialog, gpointer data)
958 run_response_handler (GtkDialog *dialog,
966 ri->response_id = response_id;
972 run_delete_handler (GtkDialog *dialog,
980 return TRUE; /* Do not destroy */
984 run_destroy_handler (GtkDialog *dialog, gpointer data)
988 /* shutdown_loop will be called by run_unmap_handler */
990 ri->destroyed = TRUE;
995 * @dialog: a #GtkDialog
997 * Blocks in a recursive main loop until the @dialog either emits the
998 * #GtkDialog::response signal, or is destroyed. If the dialog is
999 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
1000 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
1001 * ::response signal emission.
1003 * Before entering the recursive main loop, gtk_dialog_run() calls
1004 * gtk_widget_show() on the dialog for you. Note that you still
1005 * need to show any children of the dialog yourself.
1007 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
1008 * is disabled; if the dialog receives ::delete_event, it will not be
1009 * destroyed as windows usually are, and gtk_dialog_run() will return
1010 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
1011 * will be modal. You can force gtk_dialog_run() to return at any time by
1012 * calling gtk_dialog_response() to emit the ::response signal. Destroying
1013 * the dialog during gtk_dialog_run() is a very bad idea, because your
1014 * post-run code won't know whether the dialog was destroyed or not.
1016 * After gtk_dialog_run() returns, you are responsible for hiding or
1017 * destroying the dialog if you wish to do so.
1019 * Typical usage of this function might be:
1021 * gint result = gtk_dialog_run (GTK_DIALOG (dialog));
1024 * case GTK_RESPONSE_ACCEPT:
1025 * do_application_specific_something ();
1028 * do_nothing_since_dialog_was_cancelled ();
1031 * gtk_widget_destroy (dialog);
1034 * Note that even though the recursive main loop gives the effect of a
1035 * modal dialog (it prevents the user from interacting with other
1036 * windows in the same window group while the dialog is run), callbacks
1037 * such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
1038 * be triggered during a gtk_dialog_run() call.
1040 * Return value: response ID
1043 gtk_dialog_run (GtkDialog *dialog)
1045 RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
1047 gulong response_handler;
1048 gulong unmap_handler;
1049 gulong destroy_handler;
1050 gulong delete_handler;
1052 g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
1054 g_object_ref (dialog);
1056 was_modal = GTK_WINDOW (dialog)->modal;
1058 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
1060 if (!gtk_widget_get_visible (GTK_WIDGET (dialog)))
1061 gtk_widget_show (GTK_WIDGET (dialog));
1064 g_signal_connect (dialog,
1066 G_CALLBACK (run_response_handler),
1070 g_signal_connect (dialog,
1072 G_CALLBACK (run_unmap_handler),
1076 g_signal_connect (dialog,
1078 G_CALLBACK (run_delete_handler),
1082 g_signal_connect (dialog,
1084 G_CALLBACK (run_destroy_handler),
1087 ri.loop = g_main_loop_new (NULL, FALSE);
1089 GDK_THREADS_LEAVE ();
1090 g_main_loop_run (ri.loop);
1091 GDK_THREADS_ENTER ();
1093 g_main_loop_unref (ri.loop);
1100 gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
1102 g_signal_handler_disconnect (dialog, response_handler);
1103 g_signal_handler_disconnect (dialog, unmap_handler);
1104 g_signal_handler_disconnect (dialog, delete_handler);
1105 g_signal_handler_disconnect (dialog, destroy_handler);
1108 g_object_unref (dialog);
1110 return ri.response_id;
1114 _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
1115 gboolean ignore_separator)
1117 GtkDialogPrivate *priv;
1119 priv = GET_PRIVATE (dialog);
1120 priv->ignore_separator = ignore_separator;
1124 * gtk_dialog_get_widget_for_response:
1125 * @dialog: a #GtkDialog
1126 * @response_id: the response ID used by the @dialog widget
1128 * Gets the widget button that uses the given response ID in the action area
1131 * Returns: the @widget button that uses the given @response_id, or %NULL.
1136 gtk_dialog_get_widget_for_response (GtkDialog *dialog,
1142 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1144 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
1146 tmp_list = children;
1147 while (tmp_list != NULL)
1149 GtkWidget *widget = tmp_list->data;
1150 ResponseData *rd = get_response_data (widget, FALSE);
1152 if (rd && rd->response_id == response_id)
1154 g_list_free (children);
1158 tmp_list = g_list_next (tmp_list);
1161 g_list_free (children);
1167 * gtk_dialog_get_response_for_widget:
1168 * @dialog: a #GtkDialog
1169 * @widget: a widget in the action area of @dialog
1171 * Gets the response id of a widget in the action area
1174 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
1175 * if @widget doesn't have a response id set.
1180 gtk_dialog_get_response_for_widget (GtkDialog *dialog,
1185 rd = get_response_data (widget, FALSE);
1187 return GTK_RESPONSE_NONE;
1189 return rd->response_id;
1193 * gtk_alternative_dialog_button_order:
1194 * @screen: (allow-none): a #GdkScreen, or %NULL to use the default screen
1196 * Returns %TRUE if dialogs are expected to use an alternative
1197 * button order on the screen @screen. See
1198 * gtk_dialog_set_alternative_button_order() for more details
1199 * about alternative button order.
1201 * If you need to use this function, you should probably connect
1202 * to the ::notify:gtk-alternative-button-order signal on the
1203 * #GtkSettings object associated to @screen, in order to be
1204 * notified if the button order setting changes.
1206 * Returns: Whether the alternative button order should be used
1211 gtk_alternative_dialog_button_order (GdkScreen *screen)
1213 GtkSettings *settings;
1217 settings = gtk_settings_get_for_screen (screen);
1219 settings = gtk_settings_get_default ();
1221 g_object_get (settings,
1222 "gtk-alternative-button-order", &result, NULL);
1228 gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
1229 gint first_response_id,
1236 response_id = first_response_id;
1238 while (response_id != -1)
1240 /* reorder child with response_id to position */
1241 child = dialog_find_button (dialog, response_id);
1242 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1244 response_id = va_arg (args, gint);
1250 * gtk_dialog_set_alternative_button_order:
1251 * @dialog: a #GtkDialog
1252 * @first_response_id: a response id used by one @dialog's buttons
1253 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
1255 * Sets an alternative button order. If the
1256 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1257 * the dialog buttons are reordered according to the order of the
1258 * response ids passed to this function.
1260 * By default, GTK+ dialogs use the button order advocated by the Gnome
1261 * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
1262 * Interface Guidelines</ulink> with the affirmative button at the far
1263 * right, and the cancel button left of it. But the builtin GTK+ dialogs
1264 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
1265 * which is more suitable on some platforms, e.g. Windows.
1267 * Use this function after adding all the buttons to your dialog, as the
1268 * following example shows:
1270 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1272 * GTK_RESPONSE_CANCEL);
1274 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1278 * gtk_widget_grab_default (ok_button);
1280 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1282 * GTK_RESPONSE_HELP);
1284 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
1286 * GTK_RESPONSE_CANCEL,
1287 * GTK_RESPONSE_HELP,
1294 gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
1295 gint first_response_id,
1301 g_return_if_fail (GTK_IS_DIALOG (dialog));
1303 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1304 if (!gtk_alternative_dialog_button_order (screen))
1307 va_start (args, first_response_id);
1309 gtk_dialog_set_alternative_button_order_valist (dialog,
1315 * gtk_dialog_set_alternative_button_order_from_array:
1316 * @dialog: a #GtkDialog
1317 * @n_params: the number of response ids in @new_order
1318 * @new_order: an array of response ids of @dialog's buttons
1320 * Sets an alternative button order. If the
1321 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1322 * the dialog buttons are reordered according to the order of the
1323 * response ids in @new_order.
1325 * See gtk_dialog_set_alternative_button_order() for more information.
1327 * This function is for use by language bindings.
1332 gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
1340 g_return_if_fail (GTK_IS_DIALOG (dialog));
1341 g_return_if_fail (new_order != NULL);
1343 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1344 if (!gtk_alternative_dialog_button_order (screen))
1347 for (position = 0; position < n_params; position++)
1349 /* reorder child with response_id to position */
1350 child = dialog_find_button (dialog, new_order[position]);
1351 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1362 GtkBuilder *builder;
1365 } ActionWidgetsSubParserData;
1368 attributes_start_element (GMarkupParseContext *context,
1369 const gchar *element_name,
1370 const gchar **names,
1371 const gchar **values,
1375 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1378 if (strcmp (element_name, "action-widget") == 0)
1380 for (i = 0; names[i]; i++)
1381 if (strcmp (names[i], "response") == 0)
1382 parser_data->response = g_strdup (values[i]);
1384 else if (strcmp (element_name, "action-widgets") == 0)
1387 g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
1391 attributes_text_element (GMarkupParseContext *context,
1397 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1398 ActionWidgetInfo *item;
1400 if (!parser_data->response)
1403 item = g_new (ActionWidgetInfo, 1);
1404 item->widget_name = g_strndup (text, text_len);
1405 item->response_id = parser_data->response;
1406 parser_data->items = g_slist_prepend (parser_data->items, item);
1407 parser_data->response = NULL;
1410 static const GMarkupParser attributes_parser =
1412 attributes_start_element,
1414 attributes_text_element,
1418 gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
1419 GtkBuilder *builder,
1421 const gchar *tagname,
1422 GMarkupParser *parser,
1425 ActionWidgetsSubParserData *parser_data;
1430 if (strcmp (tagname, "action-widgets") == 0)
1432 parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1433 parser_data->dialog = GTK_DIALOG (buildable);
1434 parser_data->items = NULL;
1436 *parser = attributes_parser;
1437 *data = parser_data;
1441 return parent_buildable_iface->custom_tag_start (buildable, builder, child,
1442 tagname, parser, data);
1446 gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
1447 GtkBuilder *builder,
1449 const gchar *tagname,
1453 ActionWidgetsSubParserData *parser_data;
1459 if (strcmp (tagname, "action-widgets"))
1461 parent_buildable_iface->custom_finished (buildable, builder, child,
1462 tagname, user_data);
1466 dialog = GTK_DIALOG (buildable);
1467 parser_data = (ActionWidgetsSubParserData*)user_data;
1468 parser_data->items = g_slist_reverse (parser_data->items);
1470 for (l = parser_data->items; l; l = l->next)
1472 ActionWidgetInfo *item = l->data;
1474 object = gtk_builder_get_object (builder, item->widget_name);
1477 g_warning ("Unknown object %s specified in action-widgets of %s",
1479 gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1483 ad = get_response_data (GTK_WIDGET (object), TRUE);
1484 ad->response_id = atoi (item->response_id);
1486 if (GTK_IS_BUTTON (object))
1487 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1489 signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1495 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1497 g_signal_connect_closure_by_id (object,
1504 if (ad->response_id == GTK_RESPONSE_HELP)
1505 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area),
1506 GTK_WIDGET (object), TRUE);
1508 g_free (item->widget_name);
1509 g_free (item->response_id);
1512 g_slist_free (parser_data->items);
1513 g_slice_free (ActionWidgetsSubParserData, parser_data);
1517 * gtk_dialog_get_action_area:
1518 * @dialog: a #GtkDialog
1520 * Returns the action area of @dialog.
1522 * Returns: (transfer none): the action area.
1527 gtk_dialog_get_action_area (GtkDialog *dialog)
1529 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1531 return dialog->action_area;
1535 * gtk_dialog_get_content_area:
1536 * @dialog: a #GtkDialog
1538 * Returns the content area of @dialog.
1540 * Returns: (transfer none): the content area #GtkVBox.
1545 gtk_dialog_get_content_area (GtkDialog *dialog)
1547 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1549 return dialog->vbox;
1552 #define __GTK_DIALOG_C__
1553 #include "gtkaliasdef.c"