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 "gtkmarshalers.h"
36 #include "gdkkeysyms.h"
39 #include "gtkbindings.h"
40 #include "gtkprivate.h"
41 #include "gtkbuildable.h"
44 struct _GtkDialogPrivate
47 GtkWidget *action_area;
50 typedef struct _ResponseData ResponseData;
57 static void gtk_dialog_add_buttons_valist (GtkDialog *dialog,
58 const gchar *first_button_text,
61 static gboolean gtk_dialog_delete_event_handler (GtkWidget *widget,
64 static void gtk_dialog_style_set (GtkWidget *widget,
65 GtkStyle *prev_style);
66 static void gtk_dialog_map (GtkWidget *widget);
68 static void gtk_dialog_close (GtkDialog *dialog);
70 static ResponseData * get_response_data (GtkWidget *widget,
73 static void gtk_dialog_buildable_interface_init (GtkBuildableIface *iface);
74 static GObject * gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
76 const gchar *childname);
77 static gboolean gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
81 GMarkupParser *parser,
83 static void gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
101 static guint dialog_signals[LAST_SIGNAL];
103 G_DEFINE_TYPE_WITH_CODE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW,
104 G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
105 gtk_dialog_buildable_interface_init))
108 gtk_dialog_class_init (GtkDialogClass *class)
110 GObjectClass *gobject_class;
111 GtkWidgetClass *widget_class;
112 GtkBindingSet *binding_set;
114 gobject_class = G_OBJECT_CLASS (class);
115 widget_class = GTK_WIDGET_CLASS (class);
117 widget_class->map = gtk_dialog_map;
118 widget_class->style_set = gtk_dialog_style_set;
120 class->close = gtk_dialog_close;
122 g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));
125 * GtkDialog::response:
126 * @dialog: the object on which the signal is emitted
127 * @response_id: the response ID
129 * Emitted when an action widget is clicked, the dialog receives a
130 * delete event, or the application programmer calls gtk_dialog_response().
131 * On a delete event, the response ID is #GTK_RESPONSE_DELETE_EVENT.
132 * Otherwise, it depends on which action widget was clicked.
134 dialog_signals[RESPONSE] =
135 g_signal_new (I_("response"),
136 G_OBJECT_CLASS_TYPE (class),
138 G_STRUCT_OFFSET (GtkDialogClass, response),
140 _gtk_marshal_VOID__INT,
147 * The ::close signal is a
148 * <link linkend="keybinding-signals">keybinding signal</link>
149 * which gets emitted when the user uses a keybinding to close
152 * The default binding for this signal is the Escape key.
154 dialog_signals[CLOSE] =
155 g_signal_new (I_("close"),
156 G_OBJECT_CLASS_TYPE (class),
157 G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
158 G_STRUCT_OFFSET (GtkDialogClass, close),
160 _gtk_marshal_VOID__VOID,
163 gtk_widget_class_install_style_property (widget_class,
164 g_param_spec_int ("content-area-border",
165 P_("Content area border"),
166 P_("Width of border around the main dialog area"),
170 GTK_PARAM_READABLE));
172 * GtkDialog:content-area-spacing:
174 * The default spacing used between elements of the
175 * content area of the dialog, as returned by
176 * gtk_dialog_get_content_area(), unless gtk_box_set_spacing()
177 * was called on that widget directly.
181 gtk_widget_class_install_style_property (widget_class,
182 g_param_spec_int ("content-area-spacing",
183 P_("Content area spacing"),
184 P_("Spacing between elements of the main dialog area"),
188 GTK_PARAM_READABLE));
189 gtk_widget_class_install_style_property (widget_class,
190 g_param_spec_int ("button-spacing",
191 P_("Button spacing"),
192 P_("Spacing between buttons"),
196 GTK_PARAM_READABLE));
198 gtk_widget_class_install_style_property (widget_class,
199 g_param_spec_int ("action-area-border",
200 P_("Action area border"),
201 P_("Width of border around the button area at the bottom of the dialog"),
205 GTK_PARAM_READABLE));
207 binding_set = gtk_binding_set_by_class (class);
209 gtk_binding_entry_add_signal (binding_set, GDK_KEY_Escape, 0, "close", 0);
213 update_spacings (GtkDialog *dialog)
215 GtkDialogPrivate *priv = dialog->priv;
216 gint content_area_border;
217 gint content_area_spacing;
219 gint action_area_border;
221 gtk_widget_style_get (GTK_WIDGET (dialog),
222 "content-area-border", &content_area_border,
223 "content-area-spacing", &content_area_spacing,
224 "button-spacing", &button_spacing,
225 "action-area-border", &action_area_border,
228 gtk_container_set_border_width (GTK_CONTAINER (priv->vbox),
229 content_area_border);
230 if (!_gtk_box_get_spacing_set (GTK_BOX (priv->vbox)))
232 gtk_box_set_spacing (GTK_BOX (priv->vbox), content_area_spacing);
233 _gtk_box_set_spacing_set (GTK_BOX (priv->vbox), FALSE);
235 gtk_box_set_spacing (GTK_BOX (priv->action_area),
237 gtk_container_set_border_width (GTK_CONTAINER (priv->action_area),
242 gtk_dialog_init (GtkDialog *dialog)
244 GtkDialogPrivate *priv;
246 dialog->priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
251 /* To avoid breaking old code that prevents destroy on delete event
252 * by connecting a handler, we have to have the FIRST signal
253 * connection on the dialog.
255 g_signal_connect (dialog,
257 G_CALLBACK (gtk_dialog_delete_event_handler),
260 priv->vbox = gtk_box_new (GTK_ORIENTATION_VERTICAL, FALSE, 0);
262 gtk_container_add (GTK_CONTAINER (dialog), priv->vbox);
263 gtk_widget_show (priv->vbox);
265 priv->action_area = gtk_button_box_new (GTK_ORIENTATION_HORIZONTAL);
267 gtk_button_box_set_layout (GTK_BUTTON_BOX (priv->action_area),
270 gtk_box_pack_end (GTK_BOX (priv->vbox), priv->action_area,
272 gtk_widget_show (priv->action_area);
274 gtk_window_set_type_hint (GTK_WINDOW (dialog),
275 GDK_WINDOW_TYPE_HINT_DIALOG);
276 gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
279 static GtkBuildableIface *parent_buildable_iface;
282 gtk_dialog_buildable_interface_init (GtkBuildableIface *iface)
284 parent_buildable_iface = g_type_interface_peek_parent (iface);
285 iface->get_internal_child = gtk_dialog_buildable_get_internal_child;
286 iface->custom_tag_start = gtk_dialog_buildable_custom_tag_start;
287 iface->custom_finished = gtk_dialog_buildable_custom_finished;
291 gtk_dialog_buildable_get_internal_child (GtkBuildable *buildable,
293 const gchar *childname)
295 GtkDialogPrivate *priv = GTK_DIALOG (buildable)->priv;
297 if (strcmp (childname, "vbox") == 0)
298 return G_OBJECT (priv->vbox);
299 else if (strcmp (childname, "action_area") == 0)
300 return G_OBJECT (priv->action_area);
302 return parent_buildable_iface->get_internal_child (buildable,
308 gtk_dialog_delete_event_handler (GtkWidget *widget,
312 /* emit response signal */
313 gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
315 /* Do the destroy by default */
319 /* A far too tricky heuristic for getting the right initial
320 * focus widget if none was set. What we do is we focus the first
321 * widget in the tab chain, but if this results in the focus
322 * ending up on one of the response widgets _other_ than the
323 * default response, we focus the default response instead.
325 * Additionally, skip selectable labels when looking for the
326 * right initial focus widget.
329 gtk_dialog_map (GtkWidget *widget)
331 GtkWidget *default_widget, *focus;
332 GtkWindow *window = GTK_WINDOW (widget);
333 GtkDialog *dialog = GTK_DIALOG (widget);
334 GtkDialogPrivate *priv = dialog->priv;
336 GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
338 focus = gtk_window_get_focus (window);
341 GList *children, *tmp_list;
342 GtkWidget *first_focus = NULL;
346 g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
348 focus = gtk_window_get_focus (window);
349 if (GTK_IS_LABEL (focus) &&
350 !gtk_label_get_current_uri (GTK_LABEL (focus)))
351 gtk_label_select_region (GTK_LABEL (focus), 0, 0);
353 if (first_focus == NULL)
355 else if (first_focus == focus)
358 if (!GTK_IS_LABEL (focus))
363 tmp_list = children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
367 GtkWidget *child = tmp_list->data;
369 default_widget = gtk_window_get_default_widget (window);
370 if ((focus == NULL || child == focus) &&
371 child != default_widget &&
374 gtk_widget_grab_focus (default_widget);
378 tmp_list = tmp_list->next;
381 g_list_free (children);
386 gtk_dialog_style_set (GtkWidget *widget,
387 GtkStyle *prev_style)
389 update_spacings (GTK_DIALOG (widget));
393 dialog_find_button (GtkDialog *dialog,
396 GtkDialogPrivate *priv = dialog->priv;
397 GtkWidget *child = NULL;
398 GList *children, *tmp_list;
400 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
402 for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
404 ResponseData *rd = get_response_data (tmp_list->data, FALSE);
406 if (rd && rd->response_id == response_id)
408 child = tmp_list->data;
413 g_list_free (children);
419 gtk_dialog_close (GtkDialog *dialog)
421 /* Synthesize delete_event to close dialog. */
423 GtkWidget *widget = GTK_WIDGET (dialog);
426 event = gdk_event_new (GDK_DELETE);
428 event->any.window = g_object_ref (gtk_widget_get_window (widget));
429 event->any.send_event = TRUE;
431 gtk_main_do_event (event);
432 gdk_event_free (event);
436 gtk_dialog_new (void)
438 return g_object_new (GTK_TYPE_DIALOG, NULL);
442 gtk_dialog_new_empty (const gchar *title,
444 GtkDialogFlags flags)
448 dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
451 gtk_window_set_title (GTK_WINDOW (dialog), title);
454 gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);
456 if (flags & GTK_DIALOG_MODAL)
457 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
459 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
460 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
462 return GTK_WIDGET (dialog);
466 * gtk_dialog_new_with_buttons:
467 * @title: (allow-none): Title of the dialog, or %NULL
468 * @parent: (allow-none): Transient parent of the dialog, or %NULL
469 * @flags: from #GtkDialogFlags
470 * @first_button_text: (allow-none): stock ID or text to go in first button, or %NULL
471 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
473 * Creates a new #GtkDialog with title @title (or %NULL for the default
474 * title; see gtk_window_set_title()) and transient parent @parent (or
475 * %NULL for none; see gtk_window_set_transient_for()). The @flags
476 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
477 * and/or to have it destroyed along with its transient parent
478 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
479 * text/response ID pairs should be listed, with a %NULL pointer ending
480 * the list. Button text can be either a stock ID such as
481 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
482 * any positive number, or one of the values in the #GtkResponseType
483 * enumeration. If the user clicks one of these dialog buttons,
484 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
485 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal,
486 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
487 * However, destroying a dialog does not emit the ::response signal;
488 * so be careful relying on ::response when using the
489 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
490 * so the first button in the list will be the leftmost button in the dialog.
492 * Here's a simple example:
494 * GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
496 * GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
498 * GTK_RESPONSE_ACCEPT,
500 * GTK_RESPONSE_REJECT,
504 * Return value: a new #GtkDialog
507 gtk_dialog_new_with_buttons (const gchar *title,
509 GtkDialogFlags flags,
510 const gchar *first_button_text,
516 dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));
518 va_start (args, first_button_text);
520 gtk_dialog_add_buttons_valist (dialog,
526 return GTK_WIDGET (dialog);
530 response_data_free (gpointer data)
532 g_slice_free (ResponseData, data);
536 get_response_data (GtkWidget *widget,
539 ResponseData *ad = g_object_get_data (G_OBJECT (widget),
540 "gtk-dialog-response-data");
542 if (ad == NULL && create)
544 ad = g_slice_new (ResponseData);
546 g_object_set_data_full (G_OBJECT (widget),
547 I_("gtk-dialog-response-data"),
556 action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
560 response_id = gtk_dialog_get_response_for_widget (dialog, widget);
562 gtk_dialog_response (dialog, response_id);
566 * gtk_dialog_add_action_widget:
567 * @dialog: a #GtkDialog
568 * @child: an activatable widget
569 * @response_id: response ID for @child
571 * Adds an activatable widget to the action area of a #GtkDialog,
572 * connecting a signal handler that will emit the #GtkDialog::response
573 * signal on the dialog when the widget is activated. The widget is
574 * appended to the end of the dialog's action area. If you want to add a
575 * non-activatable widget, simply pack it into the @action_area field
576 * of the #GtkDialog struct.
579 gtk_dialog_add_action_widget (GtkDialog *dialog,
583 GtkDialogPrivate *priv;
587 g_return_if_fail (GTK_IS_DIALOG (dialog));
588 g_return_if_fail (GTK_IS_WIDGET (child));
592 ad = get_response_data (child, TRUE);
594 ad->response_id = response_id;
596 if (GTK_IS_BUTTON (child))
597 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
599 signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
605 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
607 g_signal_connect_closure_by_id (child,
614 g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");
616 gtk_box_pack_end (GTK_BOX (priv->action_area),
620 if (response_id == GTK_RESPONSE_HELP)
621 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area), child, TRUE);
625 * gtk_dialog_add_button:
626 * @dialog: a #GtkDialog
627 * @button_text: text of button, or stock ID
628 * @response_id: response ID for the button
630 * Adds a button with the given text (or a stock button, if @button_text is a
631 * stock ID) and sets things up so that clicking the button will emit the
632 * #GtkDialog::response signal with the given @response_id. The button is
633 * appended to the end of the dialog's action area. The button widget is
634 * returned, but usually you don't need it.
636 * Return value: (transfer full): the button widget that was added
639 gtk_dialog_add_button (GtkDialog *dialog,
640 const gchar *button_text,
645 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
646 g_return_val_if_fail (button_text != NULL, NULL);
648 button = gtk_button_new_from_stock (button_text);
650 gtk_widget_set_can_default (button, TRUE);
652 gtk_widget_show (button);
654 gtk_dialog_add_action_widget (dialog,
662 gtk_dialog_add_buttons_valist (GtkDialog *dialog,
663 const gchar *first_button_text,
669 g_return_if_fail (GTK_IS_DIALOG (dialog));
671 if (first_button_text == NULL)
674 text = first_button_text;
675 response_id = va_arg (args, gint);
679 gtk_dialog_add_button (dialog, text, response_id);
681 text = va_arg (args, gchar*);
684 response_id = va_arg (args, int);
689 * gtk_dialog_add_buttons:
690 * @dialog: a #GtkDialog
691 * @first_button_text: button text or stock ID
692 * @Varargs: response ID for first button, then more text-response_id pairs
694 * Adds more buttons, same as calling gtk_dialog_add_button()
695 * repeatedly. The variable argument list should be %NULL-terminated
696 * as with gtk_dialog_new_with_buttons(). Each button must have both
697 * text and response ID.
700 gtk_dialog_add_buttons (GtkDialog *dialog,
701 const gchar *first_button_text,
706 va_start (args, first_button_text);
708 gtk_dialog_add_buttons_valist (dialog,
716 * gtk_dialog_set_response_sensitive:
717 * @dialog: a #GtkDialog
718 * @response_id: a response ID
719 * @setting: %TRUE for sensitive
721 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal>
722 * for each widget in the dialog's action area with the given @response_id.
723 * A convenient way to sensitize/desensitize dialog buttons.
726 gtk_dialog_set_response_sensitive (GtkDialog *dialog,
730 GtkDialogPrivate *priv;
734 g_return_if_fail (GTK_IS_DIALOG (dialog));
738 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
741 while (tmp_list != NULL)
743 GtkWidget *widget = tmp_list->data;
744 ResponseData *rd = get_response_data (widget, FALSE);
746 if (rd && rd->response_id == response_id)
747 gtk_widget_set_sensitive (widget, setting);
749 tmp_list = g_list_next (tmp_list);
752 g_list_free (children);
756 * gtk_dialog_set_default_response:
757 * @dialog: a #GtkDialog
758 * @response_id: a response ID
760 * Sets the last widget in the dialog's action area with the given @response_id
761 * as the default widget for the dialog. Pressing "Enter" normally activates
762 * the default widget.
765 gtk_dialog_set_default_response (GtkDialog *dialog,
768 GtkDialogPrivate *priv;
772 g_return_if_fail (GTK_IS_DIALOG (dialog));
776 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
779 while (tmp_list != NULL)
781 GtkWidget *widget = tmp_list->data;
782 ResponseData *rd = get_response_data (widget, FALSE);
784 if (rd && rd->response_id == response_id)
785 gtk_widget_grab_default (widget);
787 tmp_list = g_list_next (tmp_list);
790 g_list_free (children);
794 * gtk_dialog_response:
795 * @dialog: a #GtkDialog
796 * @response_id: response ID
798 * Emits the #GtkDialog::response signal with the given response ID.
799 * Used to indicate that the user has responded to the dialog in some way;
800 * typically either you or gtk_dialog_run() will be monitoring the
801 * ::response signal and take appropriate action.
804 gtk_dialog_response (GtkDialog *dialog,
807 g_return_if_fail (GTK_IS_DIALOG (dialog));
809 g_signal_emit (dialog,
810 dialog_signals[RESPONSE],
824 shutdown_loop (RunInfo *ri)
826 if (g_main_loop_is_running (ri->loop))
827 g_main_loop_quit (ri->loop);
831 run_unmap_handler (GtkDialog *dialog, gpointer data)
839 run_response_handler (GtkDialog *dialog,
847 ri->response_id = response_id;
853 run_delete_handler (GtkDialog *dialog,
861 return TRUE; /* Do not destroy */
865 run_destroy_handler (GtkDialog *dialog, gpointer data)
869 /* shutdown_loop will be called by run_unmap_handler */
871 ri->destroyed = TRUE;
876 * @dialog: a #GtkDialog
878 * Blocks in a recursive main loop until the @dialog either emits the
879 * #GtkDialog::response signal, or is destroyed. If the dialog is
880 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns
881 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the
882 * ::response signal emission.
884 * Before entering the recursive main loop, gtk_dialog_run() calls
885 * gtk_widget_show() on the dialog for you. Note that you still
886 * need to show any children of the dialog yourself.
888 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event
889 * is disabled; if the dialog receives ::delete_event, it will not be
890 * destroyed as windows usually are, and gtk_dialog_run() will return
891 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog
892 * will be modal. You can force gtk_dialog_run() to return at any time by
893 * calling gtk_dialog_response() to emit the ::response signal. Destroying
894 * the dialog during gtk_dialog_run() is a very bad idea, because your
895 * post-run code won't know whether the dialog was destroyed or not.
897 * After gtk_dialog_run() returns, you are responsible for hiding or
898 * destroying the dialog if you wish to do so.
900 * Typical usage of this function might be:
902 * gint result = gtk_dialog_run (GTK_DIALOG (dialog));
905 * case GTK_RESPONSE_ACCEPT:
906 * do_application_specific_something ();
909 * do_nothing_since_dialog_was_cancelled ();
912 * gtk_widget_destroy (dialog);
915 * Note that even though the recursive main loop gives the effect of a
916 * modal dialog (it prevents the user from interacting with other
917 * windows in the same window group while the dialog is run), callbacks
918 * such as timeouts, IO channel watches, DND drops, etc, <emphasis>will</emphasis>
919 * be triggered during a gtk_dialog_run() call.
921 * Return value: response ID
924 gtk_dialog_run (GtkDialog *dialog)
926 RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
928 gulong response_handler;
929 gulong unmap_handler;
930 gulong destroy_handler;
931 gulong delete_handler;
933 g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);
935 g_object_ref (dialog);
937 was_modal = gtk_window_get_modal (GTK_WINDOW (dialog));
939 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
941 if (!gtk_widget_get_visible (GTK_WIDGET (dialog)))
942 gtk_widget_show (GTK_WIDGET (dialog));
945 g_signal_connect (dialog,
947 G_CALLBACK (run_response_handler),
951 g_signal_connect (dialog,
953 G_CALLBACK (run_unmap_handler),
957 g_signal_connect (dialog,
959 G_CALLBACK (run_delete_handler),
963 g_signal_connect (dialog,
965 G_CALLBACK (run_destroy_handler),
968 ri.loop = g_main_loop_new (NULL, FALSE);
970 GDK_THREADS_LEAVE ();
971 g_main_loop_run (ri.loop);
972 GDK_THREADS_ENTER ();
974 g_main_loop_unref (ri.loop);
981 gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
983 g_signal_handler_disconnect (dialog, response_handler);
984 g_signal_handler_disconnect (dialog, unmap_handler);
985 g_signal_handler_disconnect (dialog, delete_handler);
986 g_signal_handler_disconnect (dialog, destroy_handler);
989 g_object_unref (dialog);
991 return ri.response_id;
995 * gtk_dialog_get_widget_for_response:
996 * @dialog: a #GtkDialog
997 * @response_id: the response ID used by the @dialog widget
999 * Gets the widget button that uses the given response ID in the action area
1002 * Returns: (transfer none):the @widget button that uses the given @response_id, or %NULL.
1007 gtk_dialog_get_widget_for_response (GtkDialog *dialog,
1010 GtkDialogPrivate *priv;
1014 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1016 priv = dialog->priv;
1018 children = gtk_container_get_children (GTK_CONTAINER (priv->action_area));
1020 tmp_list = children;
1021 while (tmp_list != NULL)
1023 GtkWidget *widget = tmp_list->data;
1024 ResponseData *rd = get_response_data (widget, FALSE);
1026 if (rd && rd->response_id == response_id)
1028 g_list_free (children);
1032 tmp_list = g_list_next (tmp_list);
1035 g_list_free (children);
1041 * gtk_dialog_get_response_for_widget:
1042 * @dialog: a #GtkDialog
1043 * @widget: a widget in the action area of @dialog
1045 * Gets the response id of a widget in the action area
1048 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
1049 * if @widget doesn't have a response id set.
1054 gtk_dialog_get_response_for_widget (GtkDialog *dialog,
1059 rd = get_response_data (widget, FALSE);
1061 return GTK_RESPONSE_NONE;
1063 return rd->response_id;
1067 * gtk_alternative_dialog_button_order:
1068 * @screen: (allow-none): a #GdkScreen, or %NULL to use the default screen
1070 * Returns %TRUE if dialogs are expected to use an alternative
1071 * button order on the screen @screen. See
1072 * gtk_dialog_set_alternative_button_order() for more details
1073 * about alternative button order.
1075 * If you need to use this function, you should probably connect
1076 * to the ::notify:gtk-alternative-button-order signal on the
1077 * #GtkSettings object associated to @screen, in order to be
1078 * notified if the button order setting changes.
1080 * Returns: Whether the alternative button order should be used
1085 gtk_alternative_dialog_button_order (GdkScreen *screen)
1087 GtkSettings *settings;
1091 settings = gtk_settings_get_for_screen (screen);
1093 settings = gtk_settings_get_default ();
1095 g_object_get (settings,
1096 "gtk-alternative-button-order", &result, NULL);
1102 gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
1103 gint first_response_id,
1106 GtkDialogPrivate *priv = dialog->priv;
1111 response_id = first_response_id;
1113 while (response_id != -1)
1115 /* reorder child with response_id to position */
1116 child = dialog_find_button (dialog, response_id);
1117 gtk_box_reorder_child (GTK_BOX (priv->action_area), child, position);
1119 response_id = va_arg (args, gint);
1125 * gtk_dialog_set_alternative_button_order:
1126 * @dialog: a #GtkDialog
1127 * @first_response_id: a response id used by one @dialog's buttons
1128 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
1130 * Sets an alternative button order. If the
1131 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1132 * the dialog buttons are reordered according to the order of the
1133 * response ids passed to this function.
1135 * By default, GTK+ dialogs use the button order advocated by the Gnome
1136 * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human
1137 * Interface Guidelines</ulink> with the affirmative button at the far
1138 * right, and the cancel button left of it. But the builtin GTK+ dialogs
1139 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
1140 * which is more suitable on some platforms, e.g. Windows.
1142 * Use this function after adding all the buttons to your dialog, as the
1143 * following example shows:
1145 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1147 * GTK_RESPONSE_CANCEL);
1149 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1153 * gtk_widget_grab_default (ok_button);
1155 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
1157 * GTK_RESPONSE_HELP);
1159 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
1161 * GTK_RESPONSE_CANCEL,
1162 * GTK_RESPONSE_HELP,
1169 gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
1170 gint first_response_id,
1176 g_return_if_fail (GTK_IS_DIALOG (dialog));
1178 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1179 if (!gtk_alternative_dialog_button_order (screen))
1182 va_start (args, first_response_id);
1184 gtk_dialog_set_alternative_button_order_valist (dialog,
1190 * gtk_dialog_set_alternative_button_order_from_array:
1191 * @dialog: a #GtkDialog
1192 * @n_params: the number of response ids in @new_order
1193 * @new_order: an array of response ids of @dialog's buttons
1195 * Sets an alternative button order. If the
1196 * #GtkSettings:gtk-alternative-button-order setting is set to %TRUE,
1197 * the dialog buttons are reordered according to the order of the
1198 * response ids in @new_order.
1200 * See gtk_dialog_set_alternative_button_order() for more information.
1202 * This function is for use by language bindings.
1207 gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
1211 GtkDialogPrivate *priv = dialog->priv;
1216 g_return_if_fail (GTK_IS_DIALOG (dialog));
1217 g_return_if_fail (new_order != NULL);
1219 screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
1220 if (!gtk_alternative_dialog_button_order (screen))
1223 for (position = 0; position < n_params; position++)
1225 /* reorder child with response_id to position */
1226 child = dialog_find_button (dialog, new_order[position]);
1227 gtk_box_reorder_child (GTK_BOX (priv->action_area), child, position);
1238 GtkBuilder *builder;
1241 } ActionWidgetsSubParserData;
1244 attributes_start_element (GMarkupParseContext *context,
1245 const gchar *element_name,
1246 const gchar **names,
1247 const gchar **values,
1251 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1254 if (strcmp (element_name, "action-widget") == 0)
1256 for (i = 0; names[i]; i++)
1257 if (strcmp (names[i], "response") == 0)
1258 parser_data->response = g_strdup (values[i]);
1260 else if (strcmp (element_name, "action-widgets") == 0)
1263 g_warning ("Unsupported tag for GtkDialog: %s\n", element_name);
1267 attributes_text_element (GMarkupParseContext *context,
1273 ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1274 ActionWidgetInfo *item;
1276 if (!parser_data->response)
1279 item = g_new (ActionWidgetInfo, 1);
1280 item->widget_name = g_strndup (text, text_len);
1281 item->response_id = parser_data->response;
1282 parser_data->items = g_slist_prepend (parser_data->items, item);
1283 parser_data->response = NULL;
1286 static const GMarkupParser attributes_parser =
1288 attributes_start_element,
1290 attributes_text_element,
1294 gtk_dialog_buildable_custom_tag_start (GtkBuildable *buildable,
1295 GtkBuilder *builder,
1297 const gchar *tagname,
1298 GMarkupParser *parser,
1301 ActionWidgetsSubParserData *parser_data;
1306 if (strcmp (tagname, "action-widgets") == 0)
1308 parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1309 parser_data->dialog = GTK_DIALOG (buildable);
1310 parser_data->items = NULL;
1312 *parser = attributes_parser;
1313 *data = parser_data;
1317 return parent_buildable_iface->custom_tag_start (buildable, builder, child,
1318 tagname, parser, data);
1322 gtk_dialog_buildable_custom_finished (GtkBuildable *buildable,
1323 GtkBuilder *builder,
1325 const gchar *tagname,
1328 GtkDialog *dialog = GTK_DIALOG (buildable);
1329 GtkDialogPrivate *priv = dialog->priv;
1331 ActionWidgetsSubParserData *parser_data;
1336 if (strcmp (tagname, "action-widgets"))
1338 parent_buildable_iface->custom_finished (buildable, builder, child,
1339 tagname, user_data);
1343 parser_data = (ActionWidgetsSubParserData*)user_data;
1344 parser_data->items = g_slist_reverse (parser_data->items);
1346 for (l = parser_data->items; l; l = l->next)
1348 ActionWidgetInfo *item = l->data;
1350 object = gtk_builder_get_object (builder, item->widget_name);
1353 g_warning ("Unknown object %s specified in action-widgets of %s",
1355 gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1359 ad = get_response_data (GTK_WIDGET (object), TRUE);
1360 ad->response_id = g_ascii_strtoll (item->response_id, NULL, 10);
1362 if (GTK_IS_BUTTON (object))
1363 signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1365 signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1371 closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1373 g_signal_connect_closure_by_id (object,
1380 if (ad->response_id == GTK_RESPONSE_HELP)
1381 gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (priv->action_area),
1382 GTK_WIDGET (object), TRUE);
1384 g_free (item->widget_name);
1385 g_free (item->response_id);
1388 g_slist_free (parser_data->items);
1389 g_slice_free (ActionWidgetsSubParserData, parser_data);
1393 * gtk_dialog_get_action_area:
1394 * @dialog: a #GtkDialog
1396 * Returns the action area of @dialog.
1398 * Returns: (transfer none): the action area.
1403 gtk_dialog_get_action_area (GtkDialog *dialog)
1405 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1407 return dialog->priv->action_area;
1411 * gtk_dialog_get_content_area:
1412 * @dialog: a #GtkDialog
1414 * Returns the content area of @dialog.
1416 * Returns: (transfer none): the content area #GtkVBox.
1421 gtk_dialog_get_content_area (GtkDialog *dialog)
1423 g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
1425 return dialog->priv->vbox;