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));
136 g_object_class_install_property (gobject_class,
138 g_param_spec_boolean ("has-separator",
140 P_("The dialog has a separator bar above its buttons"),
142 GTK_PARAM_READWRITE));
144 dialog_signals[RESPONSE] =
145 g_signal_new (I_("response"),
146 G_OBJECT_CLASS_TYPE (class),
148 G_STRUCT_OFFSET (GtkDialogClass, response),
150 _gtk_marshal_NONE__INT,
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_NONE__NONE,
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));
171 gtk_widget_class_install_style_property (widget_class,
172 g_param_spec_int ("button-spacing",
173 P_("Button spacing"),
174 P_("Spacing between buttons"),
178 GTK_PARAM_READABLE));
180 gtk_widget_class_install_style_property (widget_class,
181 g_param_spec_int ("action-area-border",
182 P_("Action area border"),
183 P_("Width of border around the button area at the bottom of the dialog"),
187 GTK_PARAM_READABLE));
189 binding_set = gtk_binding_set_by_class (class);
191 gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
196 update_spacings (GtkDialog *dialog)
199 gint content_area_border;
201 gint action_area_border;
203 widget = GTK_WIDGET (dialog);
205 gtk_widget_style_get (widget,
206 "content-area-border", &content_area_border,
207 "button-spacing", &button_spacing,
208 "action-area-border", &action_area_border,
211 gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox),
212 content_area_border);
213 gtk_box_set_spacing (GTK_BOX (dialog->action_area),
215 gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area),
220 gtk_dialog_init (GtkDialog *dialog)
222 GtkDialogPrivate *priv;
224 priv = GET_PRIVATE (dialog);
225 priv->ignore_separator = FALSE;
227 /* To avoid breaking old code that prevents destroy on delete event
228 * by connecting a handler, we have to have the FIRST signal
229 * connection on the dialog.
231 g_signal_connect (dialog,
233 G_CALLBACK (gtk_dialog_delete_event_handler),
236 dialog->vbox = gtk_vbox_new (FALSE, 0);
238 gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
239 gtk_widget_show (dialog->vbox);
241 dialog->action_area = gtk_hbutton_box_new ();
243 gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
246 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
248 gtk_widget_show (dialog->action_area);
250 dialog->separator = gtk_hseparator_new ();
251 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
252 gtk_widget_show (dialog->separator);
254 gtk_window_set_type_hint (GTK_WINDOW (dialog),
255 GDK_WINDOW_TYPE_HINT_DIALOG);
256 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
260 gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
262 iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
263 iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
264 iface->custom_finished = gtk_dialog_buildable_custom_finished;
268 gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
270 const gchar *childname)
272 if (strcmp (childname, "vbox") == 0)
273 return G_OBJECT (GTK_DIALOG (buildable)->vbox);
274 else if (strcmp (childname, "action_area") == 0)
275 return G_OBJECT (GTK_DIALOG (buildable)->action_area);
281 gtk_dialog_set_property (GObject *object,
288 dialog = GTK_DIALOG (object);
292 case PROP_HAS_SEPARATOR:
293 gtk_dialog_set_has_separator (dialog, g_value_get_boolean (value));
297 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
303 gtk_dialog_get_property (GObject *object,
310 dialog = GTK_DIALOG (object);
314 case PROP_HAS_SEPARATOR:
315 g_value_set_boolean (value, dialog->separator != NULL);
319 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
325 gtk_dialog_delete_event_handler (GtkWidget *widget,
329 /* emit response signal */
330 gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
332 /* Do the destroy by default */
336 /* A far too tricky heuristic for getting the right initial
337 * focus widget if none was set. What we do is we focus the first
338 * widget in the tab chain, but if this results in the focus
339 * ending up on one of the response widgets _other_ than the
340 * default response, we focus the default response instead.
342 * Additionally, skip selectable labels when looking for the
343 * right initial focus widget.
346 gtk_dialog_map (GtkWidget *widget)
348 GtkWindow *window = GTK_WINDOW (widget);
349 GtkDialog *dialog = GTK_DIALOG (widget);
351 GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
353 if (!window->focus_widget)
355 GList *children, *tmp_list;
356 GtkWidget *first_focus = NULL;
360 g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
362 if (first_focus == NULL)
363 first_focus = window->focus_widget;
364 else if (first_focus == window->focus_widget)
367 if (!GTK_IS_LABEL (window->focus_widget))
370 gtk_label_select_region (GTK_LABEL (window->focus_widget), 0, 0);
374 tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
378 GtkWidget *child = tmp_list->data;
380 if ((window->focus_widget == NULL ||
381 child == window->focus_widget) &&
382 child != window->default_widget &&
383 window->default_widget)
385 gtk_widget_grab_focus (window->default_widget);
389 tmp_list = tmp_list->next;
392 g_list_free (children);
397 gtk_dialog_style_set (GtkWidget *widget,
398 GtkStyle *prev_style)
400 update_spacings (GTK_DIALOG (widget));
404 dialog_find_button (GtkDialog *dialog,
407 GList *children, *tmp_list;
408 GtkWidget *child = NULL;
410 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
412 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
414 ResponseData *rd = get_response_data (tmp_list->data, FALSE);
416 if (rd && rd->response_id == response_id)
418 child = tmp_list->data;
423 g_list_free (children);
429 gtk_dialog_close (GtkDialog *dialog)
431 /* Synthesize delete_event to close dialog. */
433 GtkWidget *widget = GTK_WIDGET (dialog);
436 event = gdk_event_new (GDK_DELETE);
438 event->any.window = g_object_ref (widget->window);
439 event->any.send_event = TRUE;
441 gtk_main_do_event (event);
442 gdk_event_free (event);
446 gtk_dialog_new (void)
448 return g_object_new (GTK_TYPE_DIALOG, NULL);
452 gtk_dialog_new_empty (const gchar *title,
454 GtkDialogFlags flags)
458 dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
461 gtk_window_set_title (GTK_WINDOW (dialog), title);
464 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
466 if (flags & GTK_DIALOG_MODAL)
467 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
469 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
470 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
472 if (flags & GTK_DIALOG_NO_SEPARATOR)
473 gtk_dialog_set_has_separator (dialog, FALSE);
475 return GTK_WIDGET (dialog);
479 * gtk_dialog_new_with_buttons:
480 * @title: Title of the dialog, or %NULL
481 * @parent: Transient parent of the dialog, or %NULL
482 * @flags: from #GtkDialogFlags
483 * @first_button_text: stock ID or text to go in first button, or %NULL
484 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
486 * Creates a new #GtkDialog with title @title (or %NULL for the default
487 * title; see gtk_window_set_title()) and transient parent @parent (or
488 * %NULL for none; see gtk_window_set_transient_for()). The @flags
489 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
490 * and/or to have it destroyed along with its transient parent
491 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
492 * text/response ID pairs should be listed, with a %NULL pointer ending
493 * the list. Button text can be either a stock ID such as
494 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
495 * any positive number, or one of the values in the #GtkResponseType
496 * enumeration. If the user clicks one of these dialog buttons,
497 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
498 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
499 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
500 * However, destroying a dialog does not emit the ::response signal;
501 * so be careful relying on ::response when using the
502 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
503 * so the first button in the list will be the leftmost button in the dialog.
505 * Here's a simple example:
506 * <informalexample><programlisting>
507 * GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
509 * GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
511 * GTK_RESPONSE_ACCEPT,
513 * GTK_RESPONSE_REJECT,
515 * </programlisting></informalexample>
517 * Return value: a new #GtkDialog
520 gtk_dialog_new_with_buttons (const gchar *title,
522 GtkDialogFlags flags,
523 const gchar *first_button_text,
529 dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
531 va_start (args, first_button_text);
533 gtk_dialog_add_buttons_valist (dialog,
539 return GTK_WIDGET (dialog);
543 response_data_free (gpointer data)
545 g_slice_free (ResponseData, data);
549 get_response_data (GtkWidget *widget,
552 ResponseData *ad = g_object_get_data (G_OBJECT (widget),
553 "gtk-dialog-response-data");
555 if (ad == NULL && create)
557 ad = g_slice_new (ResponseData);
559 g_object_set_data_full (G_OBJECT (widget),
560 I_("gtk-dialog-response-data"),
569 action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
573 response_id = gtk_dialog_get_response_for_widget (dialog, widget);
575 gtk_dialog_response (dialog, response_id);
579 * gtk_dialog_add_action_widget:
580 * @dialog: a #GtkDialog
581 * @child: an activatable widget
582 * @response_id: response ID for @child
584 * Adds an activatable widget to the action area of a #GtkDialog,
585 * connecting a signal handler that will emit the #GtkDialog::response
586 * signal on the dialog when the widget is activated. The widget is
587 * appended to the end of the dialog's action area. If you want to add a
588 * non-activatable widget, simply pack it into the @action_area field
589 * of the #GtkDialog struct.
592 gtk_dialog_add_action_widget (GtkDialog *dialog,
599 g_return_if_fail (GTK_IS_DIALOG (dialog));
600 g_return_if_fail (GTK_IS_WIDGET (child));
602 ad = get_response_data (child, TRUE);
604 ad->response_id = response_id;
606 if (GTK_IS_BUTTON (child))
607 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
609 signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
615 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
617 g_signal_connect_closure_by_id (child,
624 g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
626 gtk_box_pack_end (GTK_BOX (dialog->action_area),
630 if (response_id == GTK_RESPONSE_HELP)
631 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
635 * gtk_dialog_add_button:
636 * @dialog: a #GtkDialog
637 * @button_text: text of button, or stock ID
638 * @response_id: response ID for the button
640 * Adds a button with the given text (or a stock button, if @button_text is a
641 * stock ID) and sets things up so that clicking the button will emit the
642 * #GtkDialog::response signal with the given @response_id. The button is
643 * appended to the end of the dialog's action area. The button widget is
644 * returned, but usually you don't need it.
646 * Return value: the button widget that was added
649 gtk_dialog_add_button (GtkDialog *dialog,
650 const gchar *button_text,
655 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
656 g_return_val_if_fail (button_text != NULL, NULL);
658 button = gtk_button_new_from_stock (button_text);
660 GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
662 gtk_widget_show (button);
664 gtk_dialog_add_action_widget (dialog,
672 gtk_dialog_add_buttons_valist (GtkDialog *dialog,
673 const gchar *first_button_text,
679 g_return_if_fail (GTK_IS_DIALOG (dialog));
681 if (first_button_text == NULL)
684 text = first_button_text;
685 response_id = va_arg (args, gint);
689 gtk_dialog_add_button (dialog, text, response_id);
691 text = va_arg (args, gchar*);
694 response_id = va_arg (args, int);
699 * gtk_dialog_add_buttons:
700 * @dialog: a #GtkDialog
701 * @first_button_text: button text or stock ID
702 * @Varargs: response ID for first button, then more text-response_id pairs
704 * Adds more buttons, same as calling gtk_dialog_add_button()
705 * repeatedly. The variable argument list should be %NULL-terminated
706 * as with gtk_dialog_new_with_buttons(). Each button must have both
707 * text and response ID.
710 gtk_dialog_add_buttons (GtkDialog *dialog,
711 const gchar *first_button_text,
716 va_start (args, first_button_text);
718 gtk_dialog_add_buttons_valist (dialog,
726 * gtk_dialog_set_response_sensitive:
727 * @dialog: a #GtkDialog
728 * @response_id: a response ID
729 * @setting: %TRUE for sensitive
731 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
732 * for each widget in the dialog's action area with the given @response_id.
733 * A convenient way to sensitize/desensitize dialog buttons.
736 gtk_dialog_set_response_sensitive (GtkDialog *dialog,
743 g_return_if_fail (GTK_IS_DIALOG (dialog));
745 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
748 while (tmp_list != NULL)
750 GtkWidget *widget = tmp_list->data;
751 ResponseData *rd = get_response_data (widget, FALSE);
753 if (rd && rd->response_id == response_id)
754 gtk_widget_set_sensitive (widget, setting);
756 tmp_list = g_list_next (tmp_list);
759 g_list_free (children);
763 * gtk_dialog_set_default_response:
764 * @dialog: a #GtkDialog
765 * @response_id: a response ID
767 * Sets the last widget in the dialog's action area with the given @response_id
768 * as the default widget for the dialog. Pressing "Enter" normally activates
769 * the default widget.
772 gtk_dialog_set_default_response (GtkDialog *dialog,
778 g_return_if_fail (GTK_IS_DIALOG (dialog));
780 children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
783 while (tmp_list != NULL)
785 GtkWidget *widget = tmp_list->data;
786 ResponseData *rd = get_response_data (widget, FALSE);
788 if (rd && rd->response_id == response_id)
789 gtk_widget_grab_default (widget);
791 tmp_list = g_list_next (tmp_list);
794 g_list_free (children);
798 * gtk_dialog_set_has_separator:
799 * @dialog: a #GtkDialog
800 * @setting: %TRUE to have a separator
802 * Sets whether the dialog has a separator above the buttons.
806 gtk_dialog_set_has_separator (GtkDialog *dialog,
809 GtkDialogPrivate *priv;
811 g_return_if_fail (GTK_IS_DIALOG (dialog));
813 priv = GET_PRIVATE (dialog);
815 /* this might fail if we get called before _init() somehow */
816 g_assert (dialog->vbox != NULL);
818 if (priv->ignore_separator)
820 g_warning ("Ignoring the separator setting");
824 if (setting && dialog->separator == NULL)
826 dialog->separator = gtk_hseparator_new ();
827 gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
829 /* The app programmer could screw this up, but, their own fault.
830 * Moves the separator just above the action area.
832 gtk_box_reorder_child (GTK_BOX (dialog->vbox), dialog->separator, 1);
833 gtk_widget_show (dialog->separator);
835 else if (!setting && dialog->separator != NULL)
837 gtk_widget_destroy (dialog->separator);
838 dialog->separator = NULL;
841 g_object_notify (G_OBJECT (dialog), "has-separator");
845 * gtk_dialog_get_has_separator:
846 * @dialog: a #GtkDialog
848 * Accessor for whether the dialog has a separator.
850 * Return value: %TRUE if the dialog has a separator
853 gtk_dialog_get_has_separator (GtkDialog *dialog)
855 g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);
857 return dialog->separator != NULL;
861 * gtk_dialog_response:
862 * @dialog: a #GtkDialog
863 * @response_id: response ID
865 * Emits the #GtkDialog::response signal with the given response ID.
866 * Used to indicate that the user has responded to the dialog in some way;
867 * typically either you or gtk_dialog_run() will be monitoring the
868 * ::response signal and take appropriate action.
871 gtk_dialog_response (GtkDialog *dialog,
874 g_return_if_fail (GTK_IS_DIALOG (dialog));
876 g_signal_emit (dialog,
877 dialog_signals[RESPONSE],
891 shutdown_loop (RunInfo *ri)
893 if (g_main_loop_is_running (ri->loop))
894 g_main_loop_quit (ri->loop);
898 run_unmap_handler (GtkDialog *dialog, gpointer data)
906 run_response_handler (GtkDialog *dialog,
914 ri->response_id = response_id;
920 run_delete_handler (GtkDialog *dialog,
928 return TRUE; /* Do not destroy */
932 run_destroy_handler (GtkDialog *dialog, gpointer data)
936 /* shutdown_loop will be called by run_unmap_handler */
938 ri->destroyed = TRUE;
943 * @dialog: a #GtkDialog
945 * Blocks in a recursive main loop until the @dialog either emits the
946 * #GtkDialog::response signal, or is destroyed. If the dialog is
947 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
948 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
949 * ::response signal emission.
951 * Before entering the recursive main loop, gtk_dialog_run() calls
952 * gtk_widget_show() on the dialog for you. Note that you still
953 * need to show any children of the dialog yourself.
955 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
956 * is disabled; if the dialog receives ::delete_event, it will not be
957 * destroyed as windows usually are, and gtk_dialog_run() will return
958 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
959 * will be modal. You can force gtk_dialog_run() to return at any time by
960 * calling gtk_dialog_response() to emit the ::response signal. Destroying
961 * the dialog during gtk_dialog_run() is a very bad idea, because your
962 * post-run code won't know whether the dialog was destroyed or not.
964 * After gtk_dialog_run() returns, you are responsible for hiding or
965 * destroying the dialog if you wish to do so.
967 * Typical usage of this function might be:
968 * <informalexample><programlisting>
969 * gint result = gtk_dialog_run (GTK_DIALOG (dialog));
972 * case GTK_RESPONSE_ACCEPT:
973 * do_application_specific_something (<!-- -->);
976 * do_nothing_since_dialog_was_cancelled (<!-- -->);
979 * gtk_widget_destroy (dialog);
980 * </programlisting></informalexample>
982 * Note that even though the recursive main loop gives the effect of a
983 * modal dialog (it prevents the user from interacting with other
984 * windows in the same window group while the dialog is run), callbacks
985 * such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
986 * be triggered during a gtk_dialog_run() call.
988 * Return value: response ID
991 gtk_dialog_run (GtkDialog *dialog)
993 RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
995 gulong response_handler;
996 gulong unmap_handler;
997 gulong destroy_handler;
998 gulong delete_handler;
1000 g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
1002 g_object_ref (dialog);
1004 was_modal = GTK_WINDOW (dialog)->modal;
1006 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
1008 if (!GTK_WIDGET_VISIBLE (dialog))
1009 gtk_widget_show (GTK_WIDGET (dialog));
1012 g_signal_connect (dialog,
1014 G_CALLBACK (run_response_handler),
1018 g_signal_connect (dialog,
1020 G_CALLBACK (run_unmap_handler),
1024 g_signal_connect (dialog,
1026 G_CALLBACK (run_delete_handler),
1030 g_signal_connect (dialog,
1032 G_CALLBACK (run_destroy_handler),
1035 ri.loop = g_main_loop_new (NULL, FALSE);
1037 GDK_THREADS_LEAVE ();
1038 g_main_loop_run (ri.loop);
1039 GDK_THREADS_ENTER ();
1041 g_main_loop_unref (ri.loop);
1048 gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
1050 g_signal_handler_disconnect (dialog, response_handler);
1051 g_signal_handler_disconnect (dialog, unmap_handler);
1052 g_signal_handler_disconnect (dialog, delete_handler);
1053 g_signal_handler_disconnect (dialog, destroy_handler);
1056 g_object_unref (dialog);
1058 return ri.response_id;
1062 _gtk_dialog_set_ignore_separator (GtkDialog *dialog,
1063 gboolean ignore_separator)
1065 GtkDialogPrivate *priv;
1067 priv = GET_PRIVATE (dialog);
1068 priv->ignore_separator = ignore_separator;
1072 * gtk_dialog_get_response_for_widget:
1073 * @dialog: a #GtkDialog
1074 * @widget: a widget in the action area of @dialog
1076 * Gets the response id of a widget in the action area
1079 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
1080 * if @widget doesn't have a response id set.
1085 gtk_dialog_get_response_for_widget (GtkDialog *dialog,
1090 rd = get_response_data (widget, FALSE);
1092 return GTK_RESPONSE_NONE;
1094 return rd->response_id;
1098 * gtk_alternative_dialog_button_order:
1099 * @screen: a #GdkScreen, or %NULL to use the default screen
1101 * Returns %TRUE if dialogs are expected to use an alternative
1102 * button order on the screen @screen. See
1103 * gtk_dialog_set_alternative_button_order() for more details
1104 * about alternative button order.
1106 * If you need to use this function, you should probably connect
1107 * to the ::notify:gtk-alternative-button-order signal on the
1108 * #GtkSettings object associated to @screen, in order to be
1109 * notified if the button order setting changes.
1111 * Returns: Whether the alternative button order should be used
1116 gtk_alternative_dialog_button_order (GdkScreen *screen)
1118 GtkSettings *settings;
1122 settings = gtk_settings_get_for_screen (screen);
1124 settings = gtk_settings_get_default ();
1126 g_object_get (settings,
1127 "gtk-alternative-button-order", &result, NULL);
1133 gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
1134 gint first_response_id,
1141 response_id = first_response_id;
1143 while (response_id != -1)
1145 /* reorder child with response_id to position */
1146 child = dialog_find_button (dialog, response_id);
1147 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1149 response_id = va_arg (args, gint);
1155 * gtk_dialog_set_alternative_button_order:
1156 * @dialog: a #GtkDialog
1157 * @first_response_id: a response id used by one @dialog's buttons
1158 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
1160 * Sets an alternative button order. If the
1161 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1162 * the dialog buttons are reordered according to the order of the
1163 * response ids passed to this function.
1165 * By default, GTK+ dialogs use the button order advocated by the Gnome
1166 * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
1167 * Interface Guidelines</ulink> with the affirmative button at the far
1168 * right, and the cancel button left of it. But the builtin GTK+ dialogs
1169 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
1170 * which is more suitable on some platforms, e.g. Windows.
1172 * Use this function after adding all the buttons to your dialog, as the
1173 * following example shows:
1174 * <informalexample><programlisting>
1175 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1177 * GTK_RESPONSE_CANCEL);
1179 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1183 * gtk_widget_grab_default (ok_button);
1185 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1187 * GTK_RESPONSE_HELP);
1189 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
1191 * GTK_RESPONSE_CANCEL,
1192 * GTK_RESPONSE_HELP,
1194 * </programlisting></informalexample>
1199 gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
1200 gint first_response_id,
1206 g_return_if_fail (GTK_IS_DIALOG (dialog));
1208 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1209 if (!gtk_alternative_dialog_button_order (screen))
1212 va_start (args, first_response_id);
1214 gtk_dialog_set_alternative_button_order_valist (dialog,
1220 * gtk_dialog_set_alternative_button_order_from_array:
1221 * @dialog: a #GtkDialog
1222 * @n_params: the number of response ids in @new_order
1223 * @new_order: an array of response ids of @dialog's buttons
1225 * Sets an alternative button order. If the
1226 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1227 * the dialog buttons are reordered according to the order of the
1228 * response ids in @new_order.
1230 * See gtk_dialog_set_alternative_button_order() for more information.
1232 * This function is for use by language bindings.
1237 gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
1245 g_return_if_fail (GTK_IS_DIALOG (dialog));
1246 g_return_if_fail (new_order != NULL);
1248 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1249 if (!gtk_alternative_dialog_button_order (screen))
1252 for (position = 0; position < n_params; position++)
1254 /* reorder child with response_id to position */
1255 child = dialog_find_button (dialog, new_order[position]);
1256 gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
1267 GtkBuilder *builder;
1270 } ActionWidgetsSubParserData;
1273 attributes_start_element (GMarkupParseContext *context,
1274 const gchar *element_name,
1275 const gchar **names,
1276 const gchar **values,
1280 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1283 if (strcmp (element_name, "action-widget") == 0)
1284 for (i = 0; names[i]; i++)
1285 if (strcmp (names[i], "response") == 0)
1286 parser_data->response = g_strdup (values[i]);
1287 else if (strcmp (element_name, "action-widgets") == 0)
1290 g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
1294 attributes_text_element (GMarkupParseContext *context,
1300 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1301 ActionWidgetInfo *item;
1303 if (!parser_data->response)
1306 item = g_new (ActionWidgetInfo, 1);
1307 item->widget_name = g_strndup (text, text_len);
1308 item->response_id = parser_data->response;
1309 parser_data->items = g_slist_prepend (parser_data->items, item);
1310 parser_data->response = NULL;
1313 static const GMarkupParser attributes_parser =
1315 attributes_start_element,
1317 attributes_text_element,
1321 gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
1322 GtkBuilder *builder,
1324 const gchar *tagname,
1325 GMarkupParser *parser,
1328 ActionWidgetsSubParserData *parser_data;
1333 if (strcmp (tagname, "action-widgets") == 0)
1335 parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1336 parser_data->dialog = GTK_DIALOG (buildable);
1337 parser_data->items = NULL;
1339 *parser = attributes_parser;
1340 *data = parser_data;
1348 gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
1349 GtkBuilder *builder,
1351 const gchar *tagname,
1355 ActionWidgetsSubParserData *parser_data;
1361 if (strcmp (tagname, "action-widgets"))
1364 dialog = GTK_DIALOG (buildable);
1365 parser_data = (ActionWidgetsSubParserData*)user_data;
1366 parser_data->items = g_slist_reverse (parser_data->items);
1368 for (l = parser_data->items; l; l = l->next)
1370 ActionWidgetInfo *item = l->data;
1372 object = gtk_builder_get_object (builder, item->widget_name);
1375 g_warning ("Unknown object %s specified in action-widgets of %s",
1377 gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1381 ad = get_response_data (GTK_WIDGET (object), TRUE);
1382 ad->response_id = atoi (item->response_id);
1384 if (GTK_IS_BUTTON (object))
1385 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1387 signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1393 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1395 g_signal_connect_closure_by_id (object,
1402 if (ad->response_id == GTK_RESPONSE_HELP)
1403 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area),
1404 GTK_WIDGET (object), TRUE);
1406 g_free (item->widget_name);
1407 g_free (item->response_id);
1410 g_slist_free (parser_data->items);
1411 g_slice_free (ActionWidgetsSubParserData, parser_data);
1414 #define __GTK_DIALOG_C__
1415 #include "gtkaliasdef.c"