gtkdialog.c 35.9 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10 11
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12
 * Lesser General Public License for more details.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23 24 25 26
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 */

27
#include <config.h>
Elliot Lee's avatar
Elliot Lee committed
28 29
#include "gtkbutton.h"
#include "gtkdialog.h"
30
#include "gtkhbbox.h"
31
#include "gtklabel.h"
Elliot Lee's avatar
Elliot Lee committed
32
#include "gtkhseparator.h"
33
#include "gtkmarshalers.h"
Elliot Lee's avatar
Elliot Lee committed
34
#include "gtkvbox.h"
35 36
#include "gdkkeysyms.h"
#include "gtkmain.h"
37
#include "gtkintl.h"
38
#include "gtkbindings.h"
39
#include "gtkprivate.h"
40
#include "gtkalias.h"
Elliot Lee's avatar
Elliot Lee committed
41

Federico Mena Quintero's avatar
Federico Mena Quintero committed
42 43 44 45 46 47
#define GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_DIALOG, GtkDialogPrivate))

typedef struct {
  guint ignore_separator : 1;
} GtkDialogPrivate;

48 49 50 51 52 53 54
typedef struct _ResponseData ResponseData;

struct _ResponseData
{
  gint response_id;
};

Elliot Lee's avatar
Elliot Lee committed
55 56
static void gtk_dialog_class_init (GtkDialogClass *klass);
static void gtk_dialog_init       (GtkDialog      *dialog);
57 58 59 60 61 62 63 64 65

static void gtk_dialog_add_buttons_valist (GtkDialog   *dialog,
                                           const gchar *first_button_text,
                                           va_list      args);

static gint gtk_dialog_delete_event_handler (GtkWidget   *widget,
                                             GdkEventAny *event,
                                             gpointer     user_data);

66 67 68 69 70 71 72 73
static void gtk_dialog_set_property      (GObject          *object,
                                          guint             prop_id,
                                          const GValue     *value,
                                          GParamSpec       *pspec);
static void gtk_dialog_get_property      (GObject          *object,
                                          guint             prop_id,
                                          GValue           *value,
                                          GParamSpec       *pspec);
74 75
static void gtk_dialog_style_set         (GtkWidget        *widget,
                                          GtkStyle         *prev_style);
76
static void gtk_dialog_map               (GtkWidget        *widget);
77

78 79
static void gtk_dialog_close             (GtkDialog        *dialog);

80 81
static ResponseData* get_response_data   (GtkWidget        *widget,
					  gboolean          create);
82

83 84 85 86
enum {
  PROP_0,
  PROP_HAS_SEPARATOR
};
87 88 89

enum {
  RESPONSE,
90
  CLOSE,
91 92
  LAST_SIGNAL
};
Elliot Lee's avatar
Elliot Lee committed
93

94 95
static gpointer parent_class;
static guint dialog_signals[LAST_SIGNAL];
Elliot Lee's avatar
Elliot Lee committed
96

Manish Singh's avatar
Manish Singh committed
97
GType
98
gtk_dialog_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
99
{
Manish Singh's avatar
Manish Singh committed
100
  static GType dialog_type = 0;
Elliot Lee's avatar
Elliot Lee committed
101 102 103

  if (!dialog_type)
    {
Manish Singh's avatar
Manish Singh committed
104
      static const GTypeInfo dialog_info =
Elliot Lee's avatar
Elliot Lee committed
105 106
      {
	sizeof (GtkDialogClass),
Manish Singh's avatar
Manish Singh committed
107 108 109 110 111 112 113 114
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_dialog_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkDialog),
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_dialog_init,
Elliot Lee's avatar
Elliot Lee committed
115 116
      };

Manish Singh's avatar
Manish Singh committed
117 118
      dialog_type = g_type_register_static (GTK_TYPE_WINDOW, "GtkDialog",
					    &dialog_info, 0);
Elliot Lee's avatar
Elliot Lee committed
119 120 121 122 123 124 125 126
    }

  return dialog_type;
}

static void
gtk_dialog_class_init (GtkDialogClass *class)
{
127
  GObjectClass *gobject_class;
128
  GtkWidgetClass *widget_class;
129 130
  GtkBindingSet *binding_set;
  
131 132
  gobject_class = G_OBJECT_CLASS (class);
  widget_class = GTK_WIDGET_CLASS (class);
133
  
134
  parent_class = g_type_class_peek_parent (class);
135 136 137

  gobject_class->set_property = gtk_dialog_set_property;
  gobject_class->get_property = gtk_dialog_get_property;
138
  
139
  widget_class->map = gtk_dialog_map;
140
  widget_class->style_set = gtk_dialog_style_set;
141 142

  class->close = gtk_dialog_close;
143
  
Federico Mena Quintero's avatar
Federico Mena Quintero committed
144 145
  g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));

146 147
  g_object_class_install_property (gobject_class,
                                   PROP_HAS_SEPARATOR,
148
                                   g_param_spec_boolean ("has-separator",
149 150
							 P_("Has separator"),
							 P_("The dialog has a separator bar above its buttons"),
151
                                                         TRUE,
152
                                                         GTK_PARAM_READWRITE));
153
  
154
  dialog_signals[RESPONSE] =
Manish Singh's avatar
Manish Singh committed
155 156 157 158 159 160 161 162
    g_signal_new ("response",
		  G_OBJECT_CLASS_TYPE (class),
		  G_SIGNAL_RUN_LAST,
		  G_STRUCT_OFFSET (GtkDialogClass, response),
		  NULL, NULL,
		  _gtk_marshal_NONE__INT,
		  G_TYPE_NONE, 1,
		  G_TYPE_INT);
163

164
  dialog_signals[CLOSE] =
Manish Singh's avatar
Manish Singh committed
165 166 167 168 169 170 171
    g_signal_new ("close",
		  G_OBJECT_CLASS_TYPE (class),
		  G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
		  G_STRUCT_OFFSET (GtkDialogClass, close),
		  NULL, NULL,
		  _gtk_marshal_NONE__NONE,
		  G_TYPE_NONE, 0);
172
  
173
  gtk_widget_class_install_style_property (widget_class,
174
					   g_param_spec_int ("content-area-border",
175 176
                                                             P_("Content area border"),
                                                             P_("Width of border around the main dialog area"),
177 178 179
                                                             0,
                                                             G_MAXINT,
                                                             2,
180
                                                             GTK_PARAM_READABLE));
181
  gtk_widget_class_install_style_property (widget_class,
182
                                           g_param_spec_int ("button-spacing",
183 184
                                                             P_("Button spacing"),
                                                             P_("Spacing between buttons"),
185 186
                                                             0,
                                                             G_MAXINT,
187
                                                             10,
188
                                                             GTK_PARAM_READABLE));
189 190
  
  gtk_widget_class_install_style_property (widget_class,
191
                                           g_param_spec_int ("action-area-border",
192 193
                                                             P_("Action area border"),
                                                             P_("Width of border around the button area at the bottom of the dialog"),
194 195
                                                             0,
                                                             G_MAXINT,
196
                                                             5,
197
                                                             GTK_PARAM_READABLE));
198 199 200 201 202

  binding_set = gtk_binding_set_by_class (class);
  
  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
                                "close", 0);
203 204 205 206 207 208 209 210 211 212 213 214 215
}

static void
update_spacings (GtkDialog *dialog)
{
  GtkWidget *widget;
  gint content_area_border;
  gint button_spacing;
  gint action_area_border;
  
  widget = GTK_WIDGET (dialog);

  gtk_widget_style_get (widget,
216 217 218
                        "content-area-border", &content_area_border,
                        "button-spacing", &button_spacing,
                        "action-area-border", &action_area_border,
219 220 221 222 223 224 225 226
                        NULL);

  gtk_container_set_border_width (GTK_CONTAINER (dialog->vbox),
                                  content_area_border);
  gtk_box_set_spacing (GTK_BOX (dialog->action_area),
                       button_spacing);
  gtk_container_set_border_width (GTK_CONTAINER (dialog->action_area),
                                  action_area_border);
Elliot Lee's avatar
Elliot Lee committed
227 228 229 230 231
}

static void
gtk_dialog_init (GtkDialog *dialog)
{
Federico Mena Quintero's avatar
Federico Mena Quintero committed
232 233 234 235 236
  GtkDialogPrivate *priv;

  priv = GET_PRIVATE (dialog);
  priv->ignore_separator = FALSE;

237 238 239 240
  /* To avoid breaking old code that prevents destroy on delete event
   * by connecting a handler, we have to have the FIRST signal
   * connection on the dialog.
   */
Manish Singh's avatar
Manish Singh committed
241 242 243 244
  g_signal_connect (dialog,
                    "delete_event",
                    G_CALLBACK (gtk_dialog_delete_event_handler),
                    NULL);
245
  
Elliot Lee's avatar
Elliot Lee committed
246
  dialog->vbox = gtk_vbox_new (FALSE, 0);
247
  
Elliot Lee's avatar
Elliot Lee committed
248 249 250
  gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
  gtk_widget_show (dialog->vbox);

251 252 253
  dialog->action_area = gtk_hbutton_box_new ();

  gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
254
                             GTK_BUTTONBOX_END);  
255

256 257
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
                    FALSE, TRUE, 0);
Elliot Lee's avatar
Elliot Lee committed
258 259
  gtk_widget_show (dialog->action_area);

260 261 262
  dialog->separator = gtk_hseparator_new ();
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
  gtk_widget_show (dialog->separator);
263 264 265

  gtk_window_set_type_hint (GTK_WINDOW (dialog),
			    GDK_WINDOW_TYPE_HINT_DIALOG);
266
  gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
Elliot Lee's avatar
Elliot Lee committed
267 268
}

269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313

static void 
gtk_dialog_set_property (GObject      *object,
                         guint         prop_id,
                         const GValue *value,
                         GParamSpec   *pspec)
{
  GtkDialog *dialog;
  
  dialog = GTK_DIALOG (object);
  
  switch (prop_id)
    {
    case PROP_HAS_SEPARATOR:
      gtk_dialog_set_has_separator (dialog, g_value_get_boolean (value));
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void 
gtk_dialog_get_property (GObject     *object,
                         guint        prop_id,
                         GValue      *value,
                         GParamSpec  *pspec)
{
  GtkDialog *dialog;
  
  dialog = GTK_DIALOG (object);
  
  switch (prop_id)
    {
    case PROP_HAS_SEPARATOR:
      g_value_set_boolean (value, dialog->separator != NULL);
      break;

    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

314 315 316 317 318 319
static gint
gtk_dialog_delete_event_handler (GtkWidget   *widget,
                                 GdkEventAny *event,
                                 gpointer     user_data)
{
  /* emit response signal */
320
  gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
321 322 323 324 325

  /* Do the destroy by default */
  return FALSE;
}

326 327 328 329 330
/* A far too tricky heuristic for getting the right initial
 * focus widget if none was set. What we do is we focus the first
 * widget in the tab chain, but if this results in the focus
 * ending up on one of the response widgets _other_ than the
 * default response, we focus the default response instead.
331 332 333
 *
 * Additionally, skip selectable labels when looking for the
 * right initial focus widget.
334 335 336 337 338 339 340 341 342 343 344 345
 */
static void
gtk_dialog_map (GtkWidget *widget)
{
  GtkWindow *window = GTK_WINDOW (widget);
  GtkDialog *dialog = GTK_DIALOG (widget);
  
  GTK_WIDGET_CLASS (parent_class)->map (widget);

  if (!window->focus_widget)
    {
      GList *children, *tmp_list;
346
      GtkWidget *first_focus = NULL;
347
      
348 349 350
      do 
	{
	  g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
351 352 353 354 355

	  if (first_focus == NULL)
	    first_focus = window->focus_widget;
	  else if (first_focus == window->focus_widget)
	    break;
356 357
	}
      while (GTK_IS_LABEL (window->focus_widget));
358 359

      tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
360
      
361 362 363
      while (tmp_list)
	{
	  GtkWidget *child = tmp_list->data;
364 365 366 367 368
	  
	  if ((window->focus_widget == NULL || 
	       child == window->focus_widget) && 
	      child != window->default_widget &&
	      window->default_widget)
369 370 371 372 373 374 375
	    {
	      gtk_widget_grab_focus (window->default_widget);
	      break;
	    }
	  
	  tmp_list = tmp_list->next;
	}
376
      
377 378 379 380
      g_list_free (children);
    }
}

381 382 383 384 385 386 387
static void
gtk_dialog_style_set (GtkWidget *widget,
                      GtkStyle  *prev_style)
{
  update_spacings (GTK_DIALOG (widget));
}

388 389 390
static GtkWidget *
dialog_find_button (GtkDialog *dialog,
		    gint       response_id)
391 392
{
  GList *children, *tmp_list;
393
  GtkWidget *child = NULL;
394 395 396 397 398
      
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));

  for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
    {
399
      ResponseData *rd = get_response_data (tmp_list->data, FALSE);
400
      
401
      if (rd && rd->response_id == response_id)
402
	{
403
	  child = tmp_list->data;
404 405 406 407 408 409
	  break;
	}
    }

  g_list_free (children);

410
  return child;
411 412
}

413 414
static void
gtk_dialog_close (GtkDialog *dialog)
415
{
416 417
  /* Synthesize delete_event to close dialog. */
  
418 419
  GtkWidget *widget = GTK_WIDGET (dialog);
  GdkEvent *event;
420

421
  if (!dialog_find_button (dialog, GTK_RESPONSE_CANCEL))
422 423
    return;

424
  event = gdk_event_new (GDK_DELETE);
425
  
426 427
  event->any.window = g_object_ref (widget->window);
  event->any.send_event = TRUE;
428
  
429 430
  gtk_main_do_event (event);
  gdk_event_free (event);
431 432
}

Elliot Lee's avatar
Elliot Lee committed
433
GtkWidget*
434
gtk_dialog_new (void)
Elliot Lee's avatar
Elliot Lee committed
435
{
Manish Singh's avatar
Manish Singh committed
436
  return g_object_new (GTK_TYPE_DIALOG, NULL);
Elliot Lee's avatar
Elliot Lee committed
437
}
438 439 440 441 442 443 444 445

static GtkWidget*
gtk_dialog_new_empty (const gchar     *title,
                      GtkWindow       *parent,
                      GtkDialogFlags   flags)
{
  GtkDialog *dialog;

Manish Singh's avatar
Manish Singh committed
446
  dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
447 448 449 450 451 452 453 454 455

  if (title)
    gtk_window_set_title (GTK_WINDOW (dialog), title);

  if (parent)
    gtk_window_set_transient_for (GTK_WINDOW (dialog), parent);

  if (flags & GTK_DIALOG_MODAL)
    gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
456
  
457 458 459
  if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
    gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);

460 461 462
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    gtk_dialog_set_has_separator (dialog, FALSE);
  
463 464 465 466 467
  return GTK_WIDGET (dialog);
}

/**
 * gtk_dialog_new_with_buttons:
468 469
 * @title: Title of the dialog, or %NULL
 * @parent: Transient parent of the dialog, or %NULL
470
 * @flags: from #GtkDialogFlags
471 472
 * @first_button_text: stock ID or text to go in first button, or %NULL
 * @Varargs: response ID for first button, then additional buttons, ending with %NULL
473
 * 
474
 * Creates a new #GtkDialog with title @title (or %NULL for the default
475
 * title; see gtk_window_set_title()) and transient parent @parent (or
476 477
 * %NULL for none; see gtk_window_set_transient_for()). The @flags
 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
478
 * and/or to have it destroyed along with its transient parent
479 480
 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
 * text/response ID pairs should be listed, with a %NULL pointer ending
481
 * the list. Button text can be either a stock ID such as
482
 * #GTK_STOCK_OK, or some arbitrary text.  A response ID can be
483 484 485 486
 * any positive number, or one of the values in the #GtkResponseType
 * enumeration. If the user clicks one of these dialog buttons,
 * #GtkDialog will emit the "response" signal with the corresponding
 * response ID. If a #GtkDialog receives the "delete_event" signal, it
487
 * will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT.
488 489
 * However, destroying a dialog does not emit the "response" signal;
 * so be careful relying on "response" when using
490
 * the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
491 492 493
 * so the first button in the list will be the leftmost button in the dialog.
 *
 * Here's a simple example:
Matthias Clasen's avatar
Matthias Clasen committed
494
 * <informalexample><programlisting>
495 496 497 498 499 500 501 502
 *  GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
 *                                                   main_app_window,
 *                                                   GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
 *                                                   GTK_STOCK_OK,
 *                                                   GTK_RESPONSE_ACCEPT,
 *                                                   GTK_STOCK_CANCEL,
 *                                                   GTK_RESPONSE_REJECT,
 *                                                   NULL);
Matthias Clasen's avatar
Matthias Clasen committed
503
 * </programlisting></informalexample>
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
 * 
 * Return value: a new #GtkDialog
 **/
GtkWidget*
gtk_dialog_new_with_buttons (const gchar    *title,
                             GtkWindow      *parent,
                             GtkDialogFlags  flags,
                             const gchar    *first_button_text,
                             ...)
{
  GtkDialog *dialog;
  va_list args;
  
  dialog = GTK_DIALOG (gtk_dialog_new_empty (title, parent, flags));

  va_start (args, first_button_text);

  gtk_dialog_add_buttons_valist (dialog,
                                 first_button_text,
                                 args);
  
  va_end (args);

  return GTK_WIDGET (dialog);
}

static ResponseData*
531 532
get_response_data (GtkWidget *widget,
		   gboolean   create)
533
{
Manish Singh's avatar
Manish Singh committed
534 535
  ResponseData *ad = g_object_get_data (G_OBJECT (widget),
                                        "gtk-dialog-response-data");
536

537
  if (ad == NULL && create)
538 539 540
    {
      ad = g_new (ResponseData, 1);
      
Manish Singh's avatar
Manish Singh committed
541 542 543 544
      g_object_set_data_full (G_OBJECT (widget),
                              "gtk-dialog-response-data",
                              ad,
                              g_free);
545 546 547 548 549 550 551 552 553 554
    }

  return ad;
}

static void
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
{
  gint response_id;
  
555
  response_id = gtk_dialog_get_response_for_widget (dialog, widget);
556 557 558

  gtk_dialog_response (dialog, response_id);
}
Manish Singh's avatar
Manish Singh committed
559

560 561 562 563 564 565 566 567 568 569 570 571 572 573
/**
 * gtk_dialog_add_action_widget:
 * @dialog: a #GtkDialog
 * @child: an activatable widget
 * @response_id: response ID for @child
 * 
 * Adds an activatable widget to the action area of a #GtkDialog,
 * connecting a signal handler that will emit the "response" signal on
 * the dialog when the widget is activated.  The widget is appended to
 * the end of the dialog's action area.  If you want to add a
 * non-activatable widget, simply pack it into the
 * <literal>action_area</literal> field of the #GtkDialog struct.
 **/
void
Manish Singh's avatar
Manish Singh committed
574 575 576
gtk_dialog_add_action_widget (GtkDialog *dialog,
                              GtkWidget *child,
                              gint       response_id)
577 578
{
  ResponseData *ad;
579
  guint signal_id;
580 581 582 583
  
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  g_return_if_fail (GTK_IS_WIDGET (child));

584
  ad = get_response_data (child, TRUE);
585 586 587

  ad->response_id = response_id;

588
  if (GTK_IS_BUTTON (child))
Manish Singh's avatar
Manish Singh committed
589
    signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
590
  else
591
    signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
592 593 594

  if (signal_id)
    {
Manish Singh's avatar
Manish Singh committed
595 596 597 598 599 600 601 602 603
      GClosure *closure;

      closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
				       G_OBJECT (dialog));
      g_signal_connect_closure_by_id (child,
				      signal_id,
				      0,
				      closure,
				      FALSE);
604 605 606 607 608 609
    }
  else
    g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkDialog");

  gtk_box_pack_end (GTK_BOX (dialog->action_area),
                    child,
610 611 612 613
                    FALSE, TRUE, 0);
  
  if (response_id == GTK_RESPONSE_HELP)
    gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
614 615 616 617 618 619 620 621 622 623 624
}

/**
 * gtk_dialog_add_button:
 * @dialog: a #GtkDialog
 * @button_text: text of button, or stock ID
 * @response_id: response ID for the button
 * 
 * Adds a button with the given text (or a stock button, if @button_text is a
 * stock ID) and sets things up so that clicking the button will emit the
 * "response" signal with the given @response_id. The button is appended to the
625 626 627 628
 * end of the dialog's action area. The button widget is returned, but usually
 * you don't need it.
 *
 * Return value: the button widget that was added
629
 **/
630
GtkWidget*
631 632 633 634 635 636
gtk_dialog_add_button (GtkDialog   *dialog,
                       const gchar *button_text,
                       gint         response_id)
{
  GtkWidget *button;
  
637 638
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
  g_return_val_if_fail (button_text != NULL, NULL);
639

640
  button = gtk_button_new_from_stock (button_text);
641

642 643
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
  
644 645 646 647 648
  gtk_widget_show (button);
  
  gtk_dialog_add_action_widget (dialog,
                                button,
                                response_id);
649 650

  return button;
651 652 653
}

static void
Chema Celorio's avatar
Chema Celorio committed
654 655 656
gtk_dialog_add_buttons_valist (GtkDialog      *dialog,
                               const gchar    *first_button_text,
                               va_list         args)
657 658 659 660
{
  const gchar* text;
  gint response_id;

661 662
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  
663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  if (first_button_text == NULL)
    return;
  
  text = first_button_text;
  response_id = va_arg (args, gint);

  while (text != NULL)
    {
      gtk_dialog_add_button (dialog, text, response_id);

      text = va_arg (args, gchar*);
      if (text == NULL)
        break;
      response_id = va_arg (args, int);
    }
}

/**
 * gtk_dialog_add_buttons:
 * @dialog: a #GtkDialog
 * @first_button_text: button text or stock ID
 * @Varargs: response ID for first button, then more text-response_id pairs
 * 
 * Adds more buttons, same as calling gtk_dialog_add_button()
687
 * repeatedly.  The variable argument list should be %NULL-terminated
688 689 690 691 692 693 694
 * as with gtk_dialog_new_with_buttons(). Each button must have both
 * text and response ID.
 **/
void
gtk_dialog_add_buttons (GtkDialog   *dialog,
                        const gchar *first_button_text,
                        ...)
695
{  
696 697 698 699 700 701 702 703 704 705 706
  va_list args;

  va_start (args, first_button_text);

  gtk_dialog_add_buttons_valist (dialog,
                                 first_button_text,
                                 args);
  
  va_end (args);
}

707 708 709 710 711 712
/**
 * gtk_dialog_set_response_sensitive:
 * @dialog: a #GtkDialog
 * @response_id: a response ID
 * @setting: %TRUE for sensitive
 *
Matthias Clasen's avatar
Matthias Clasen committed
713 714
 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal> 
 * for each widget in the dialog's action area with the given @response_id.
715 716 717 718 719 720 721 722 723 724
 * A convenient way to sensitize/desensitize dialog buttons.
 **/
void
gtk_dialog_set_response_sensitive (GtkDialog *dialog,
                                   gint       response_id,
                                   gboolean   setting)
{
  GList *children;
  GList *tmp_list;

Darin Adler's avatar
Darin Adler committed
725 726
  g_return_if_fail (GTK_IS_DIALOG (dialog));

727
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
728 729 730 731 732

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
733
      ResponseData *rd = get_response_data (widget, FALSE);
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759

      if (rd && rd->response_id == response_id)
        gtk_widget_set_sensitive (widget, setting);

      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

/**
 * gtk_dialog_set_default_response:
 * @dialog: a #GtkDialog
 * @response_id: a response ID
 * 
 * Sets the last widget in the dialog's action area with the given @response_id
 * as the default widget for the dialog. Pressing "Enter" normally activates
 * the default widget.
 **/
void
gtk_dialog_set_default_response (GtkDialog *dialog,
                                 gint       response_id)
{
  GList *children;
  GList *tmp_list;

Darin Adler's avatar
Darin Adler committed
760 761
  g_return_if_fail (GTK_IS_DIALOG (dialog));

762
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
763 764 765 766 767

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
768
      ResponseData *rd = get_response_data (widget, FALSE);
769 770

      if (rd && rd->response_id == response_id)
771
	gtk_widget_grab_default (widget);
Owen Taylor's avatar
Owen Taylor committed
772
	    
773 774 775 776 777 778
      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

779 780 781 782 783 784 785 786
/**
 * gtk_dialog_set_has_separator:
 * @dialog: a #GtkDialog
 * @setting: %TRUE to have a separator
 *
 * Sets whether the dialog has a separator above the buttons.
 * %TRUE by default.
 **/
787 788 789 790
void
gtk_dialog_set_has_separator (GtkDialog *dialog,
                              gboolean   setting)
{
Federico Mena Quintero's avatar
Federico Mena Quintero committed
791 792
  GtkDialogPrivate *priv;

793 794
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Federico Mena Quintero's avatar
Federico Mena Quintero committed
795 796
  priv = GET_PRIVATE (dialog);

797 798
  /* this might fail if we get called before _init() somehow */
  g_assert (dialog->vbox != NULL);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
799 800 801 802 803 804

  if (priv->ignore_separator)
    {
      g_warning ("Ignoring the separator setting");
      return;
    }
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
  
  if (setting && dialog->separator == NULL)
    {
      dialog->separator = gtk_hseparator_new ();
      gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);

      /* The app programmer could screw this up, but, their own fault.
       * Moves the separator just above the action area.
       */
      gtk_box_reorder_child (GTK_BOX (dialog->vbox), dialog->separator, 1);
      gtk_widget_show (dialog->separator);
    }
  else if (!setting && dialog->separator != NULL)
    {
      gtk_widget_destroy (dialog->separator);
      dialog->separator = NULL;
    }

823
  g_object_notify (G_OBJECT (dialog), "has-separator");
824 825
}

826 827 828 829 830 831 832 833
/**
 * gtk_dialog_get_has_separator:
 * @dialog: a #GtkDialog
 * 
 * Accessor for whether the dialog has a separator.
 * 
 * Return value: %TRUE if the dialog has a separator
 **/
834 835 836 837 838 839 840 841
gboolean
gtk_dialog_get_has_separator (GtkDialog *dialog)
{
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);

  return dialog->separator != NULL;
}

842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
/**
 * gtk_dialog_response:
 * @dialog: a #GtkDialog
 * @response_id: response ID 
 * 
 * Emits the "response" signal with the given response ID. Used to
 * indicate that the user has responded to the dialog in some way;
 * typically either you or gtk_dialog_run() will be monitoring the
 * "response" signal and take appropriate action.
 **/
void
gtk_dialog_response (GtkDialog *dialog,
                     gint       response_id)
{
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Manish Singh's avatar
Manish Singh committed
858 859 860 861
  g_signal_emit (dialog,
		 dialog_signals[RESPONSE],
		 0,
		 response_id);
862 863 864 865 866 867 868
}

typedef struct
{
  GtkDialog *dialog;
  gint response_id;
  GMainLoop *loop;
869
  gboolean destroyed;
870 871 872 873 874
} RunInfo;

static void
shutdown_loop (RunInfo *ri)
{
875 876
  if (g_main_loop_is_running (ri->loop))
    g_main_loop_quit (ri->loop);
877 878 879
}

static void
880
run_unmap_handler (GtkDialog *dialog, gpointer data)
881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
{
  RunInfo *ri = data;

  shutdown_loop (ri);
}

static void
run_response_handler (GtkDialog *dialog,
                      gint response_id,
                      gpointer data)
{
  RunInfo *ri;

  ri = data;

  ri->response_id = response_id;

  shutdown_loop (ri);
}

static gint
run_delete_handler (GtkDialog *dialog,
                    GdkEventAny *event,
                    gpointer data)
{
  RunInfo *ri = data;
    
  shutdown_loop (ri);
  
  return TRUE; /* Do not destroy */
}

913 914 915 916 917 918 919 920 921 922
static void
run_destroy_handler (GtkDialog *dialog, gpointer data)
{
  RunInfo *ri = data;

  /* shutdown_loop will be called by run_unmap_handler */
  
  ri->destroyed = TRUE;
}

923 924 925 926 927
/**
 * gtk_dialog_run:
 * @dialog: a #GtkDialog
 * 
 * Blocks in a recursive main loop until the @dialog either emits the
Soeren Sandmann's avatar
Soeren Sandmann committed
928 929 930 931
 * response signal, or is destroyed. If the dialog is destroyed during the call
 * to gtk_dialog_run(), gtk_dialog_returns #GTK_RESPONSE_NONE.
 * Otherwise, it returns the response ID from the "response" signal emission.
 * Before entering the recursive main loop, gtk_dialog_run() calls
932 933 934 935 936 937
 * gtk_widget_show() on the dialog for you. Note that you still
 * need to show any children of the dialog yourself.
 *
 * During gtk_dialog_run(), the default behavior of "delete_event" is
 * disabled; if the dialog receives "delete_event", it will not be
 * destroyed as windows usually are, and gtk_dialog_run() will return
938
 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
939 940 941 942 943 944 945 946 947 948
 * modal. You can force gtk_dialog_run() to return at any time by
 * calling gtk_dialog_response() to emit the "response"
 * signal. Destroying the dialog during gtk_dialog_run() is a very bad
 * idea, because your post-run code won't know whether the dialog was
 * destroyed or not.
 *
 * After gtk_dialog_run() returns, you are responsible for hiding or
 * destroying the dialog if you wish to do so.
 *
 * Typical usage of this function might be:
Matthias Clasen's avatar
Matthias Clasen committed
949
 * <informalexample><programlisting>
950 951 952 953 954 955 956 957 958 959 960
 *   gint result = gtk_dialog_run (GTK_DIALOG (dialog));
 *   switch (result)
 *     {
 *       case GTK_RESPONSE_ACCEPT:
 *          do_application_specific_something (<!-- -->);
 *          break;
 *       default:
 *          do_nothing_since_dialog_was_cancelled (<!-- -->);
 *          break;
 *     }
 *   gtk_widget_destroy (dialog);
Matthias Clasen's avatar
Matthias Clasen committed
961
 * </programlisting></informalexample>
962
 * 
963 964 965 966 967 968
 * Note that even though the recursive main loop gives the effect of a
 * modal dialog (it prevents the user from interacting with other 
 * windows while the dialog is run), callbacks such as timeouts, 
 * IO channel watches, DND drops, etc, <emphasis>will</emphasis> be 
 * triggered during a gtk_dialog_run() call.
 * 
969 970 971 972 973
 * Return value: response ID
 **/
gint
gtk_dialog_run (GtkDialog *dialog)
{
974
  RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
975
  gboolean was_modal;
976 977 978 979
  gulong response_handler;
  gulong unmap_handler;
  gulong destroy_handler;
  gulong delete_handler;
980 981 982
  
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);

Manish Singh's avatar
Manish Singh committed
983
  g_object_ref (dialog);
984 985 986 987 988

  was_modal = GTK_WINDOW (dialog)->modal;
  if (!was_modal)
    gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);

989 990 991
  if (!GTK_WIDGET_VISIBLE (dialog))
    gtk_widget_show (GTK_WIDGET (dialog));
  
992
  response_handler =
Manish Singh's avatar
Manish Singh committed
993 994 995 996
    g_signal_connect (dialog,
                      "response",
                      G_CALLBACK (run_response_handler),
                      &ri);
997
  
998
  unmap_handler =
Manish Singh's avatar
Manish Singh committed
999 1000 1001 1002
    g_signal_connect (dialog,
                      "unmap",
                      G_CALLBACK (run_unmap_handler),
                      &ri);
1003 1004
  
  delete_handler =
Manish Singh's avatar
Manish Singh committed
1005 1006 1007 1008
    g_signal_connect (dialog,
                      "delete_event",
                      G_CALLBACK (run_delete_handler),
                      &ri);
1009
  
1010
  destroy_handler =
Manish Singh's avatar
Manish Singh committed
1011 1012 1013 1014
    g_signal_connect (dialog,
                      "destroy",
                      G_CALLBACK (run_destroy_handler),
                      &ri);
1015
  
Manish Singh's avatar
Manish Singh committed
1016
  ri.loop = g_main_loop_new (NULL, FALSE);
1017

1018
  GDK_THREADS_LEAVE ();  
1019
  g_main_loop_run (ri.loop);
1020
  GDK_THREADS_ENTER ();  
1021 1022 1023 1024

  g_main_loop_unref (ri.loop);

  ri.loop = NULL;
1025
  
1026
  if (!ri.destroyed)
1027 1028 1029 1030
    {
      if (!was_modal)
        gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
      
Manish Singh's avatar
Manish Singh committed
1031 1032 1033 1034
      g_signal_handler_disconnect (dialog, response_handler);
      g_signal_handler_disconnect (dialog, unmap_handler);
      g_signal_handler_disconnect (dialog, delete_handler);
      g_signal_handler_disconnect (dialog, destroy_handler);
1035 1036
    }

Manish Singh's avatar
Manish Singh committed
1037
  g_object_unref (dialog);
1038 1039 1040

  return ri.response_id;
}
Federico Mena Quintero's avatar
Federico Mena Quintero committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050

void
_gtk_dialog_set_ignore_separator (GtkDialog *dialog,
				  gboolean   ignore_separator)
{
  GtkDialogPrivate *priv;

  priv = GET_PRIVATE (dialog);
  priv->ignore_separator = ignore_separator;
}
1051

1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
/**
 * gtk_dialog_get_response_for_widget:
 * @dialog: a #GtkDialog
 * @widget: a widget in the action area of @dialog
 *
 * Gets the response id of a widget in the action area
 * of a dialog.
 *
 * Returns: the response id of @widget, or %GTK_RESPONSE_NONE
 *  if @widget doesn't have a response id set.
 *
 * Since: 2.8
 */
1065
gint
1066 1067
gtk_dialog_get_response_for_widget (GtkDialog *dialog,
				    GtkWidget *widget)
1068 1069 1070 1071 1072 1073 1074 1075 1076
{
  ResponseData *rd;

  rd = get_response_data (widget, FALSE);
  if (!rd)
    return GTK_RESPONSE_NONE;
  else
    return rd->response_id;
}
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157

/**
 * gtk_alternative_dialog_button_order:
 * @screen: a #GdkScreen, or %NULL to use the default screen
 *
 * Returns %TRUE if dialogs are expected to use an alternative
 * button order on the screen @screen. See 
 * gtk_dialog_set_alternative_button_order() for more details
 * about alternative button order. 
 *
 * If you need to use this function, you should probably connect
 * to the ::notify:gtk-alternative-button-order signal on the
 * #GtkSettings object associated to @screen, in order to be 
 * notified if the button order setting changes.
 *
 * Returns: Whether the alternative button order should be used
 *
 * Since: 2.6
 */
gboolean 
gtk_alternative_dialog_button_order (GdkScreen *screen)
{
  GtkSettings *settings;
  gboolean result;

  if (screen)
    settings = gtk_settings_get_for_screen (screen);
  else
    settings = gtk_settings_get_default ();
  
  g_object_get (settings,
		"gtk-alternative-button-order", &result, NULL);

  return result;
}

static void
gtk_dialog_set_alternative_button_order_valist (GtkDialog *dialog,
						gint       first_response_id,
						va_list    args)
{
  GtkWidget *child;
  gint response_id;
  gint position;

  response_id = first_response_id;
  position = 0;
  while (response_id != -1)
    {
      /* reorder child with response_id to position */
      child = dialog_find_button (dialog, response_id);
      gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);

      response_id = va_arg (args, gint);
      position++;
    }
}

/**
 * gtk_dialog_set_alternative_button_order:
 * @dialog: a #GtkDialog
 * @first_response_id: a response id used by one @dialog's buttons
 * @Varargs: a list of more response ids of @dialog's buttons, terminated by -1
 *
 * Sets an alternative button order. If the gtk-alternative-button-order 
 * setting is set to %TRUE, the dialog buttons are reordered according to 
 * the order of the response ids passed to this function.
 *
 * By default, GTK+ dialogs use the button order advocated by the Gnome 
 * <ulink url="http://developer.gnome.org/projects/gup/hig/2.0/">Human 
 * Interface Guidelines</ulink> with the affirmative button at the far 
 * right, and the cancel button left of it. But the builtin GTK+ dialogs
 * and #GtkMessageDialog<!-- -->s do provide an alternative button order,
 * which is more suitable on some platforms, e.g. Windows.
 *
 * Use this function after adding all the buttons to your dialog, as the 
 * following example shows:
 * <informalexample><programlisting>
 * cancel_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
 *                                        GTK_STOCK_CANCEL,
 *                                        GTK_RESPONSE_CANCEL);
Matthias Clasen's avatar
Matthias Clasen committed
1158
 *  
1159 1160 1161
 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
 *                                    GTK_STOCK_OK,
 *                                    GTK_RESPONSE_OK);
Matthias Clasen's avatar
Matthias Clasen committed
1162
 *   
1163
 * gtk_widget_grab_default (ok_button);
Matthias Clasen's avatar
Matthias Clasen committed
1164
 *   
1165 1166 1167
 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
 *                                      GTK_STOCK_HELP,
 *                                      GTK_RESPONSE_HELP);
Matthias Clasen's avatar
Matthias Clasen committed
1168
 *  
1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
 * gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
 *                                          GTK_RESPONSE_OK,
 *                                          GTK_RESPONSE_CANCEL,
 *                                          GTK_RESPONSE_HELP,
 *                                          -1);
 * </programlisting></informalexample>
 * 
 * Since: 2.6
 */
void 
gtk_dialog_set_alternative_button_order (GtkDialog *dialog,
					 gint       first_response_id,
					 ...)
{
  GdkScreen *screen;
  va_list args;
  
  g_return_if_fail (GTK_IS_DIALOG (dialog));

  screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
  if (!gtk_alternative_dialog_button_order (screen))
      return;

  va_start (args, first_response_id);

  gtk_dialog_set_alternative_button_order_valist (dialog,
						  first_response_id,
						  args);
  va_end (args);
}
1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
/**
 * gtk_dialog_set_alternative_button_order_from_array:
 * @dialog: a #GtkDialog
 * @n_params: the number of response ids in @new_order
 * @new_order: an array of response ids of @dialog's buttons
 *
 * Sets an alternative button order. If the gtk-alternative-button-order 
 * setting is set to %TRUE, the dialog buttons are reordered according to 
 * the order of the response ids in @new_order.
 *
 * See gtk_dialog_set_alternative_button_order() for more information.
 *
 * This function is for use by language bindings.
 * 
 * Since: 2.6
 */
void 
gtk_dialog_set_alternative_button_order_from_array (GtkDialog *dialog,
                                                    gint       n_params,
                                                    gint      *new_order)
{
  GdkScreen *screen;
  GtkWidget *child;
  gint position;

  g_return_if_fail (GTK_IS_DIALOG (dialog));
  g_return_if_fail (new_order != NULL);

  screen = gtk_widget_get_screen (GTK_WIDGET (dialog));
  if (!gtk_alternative_dialog_button_order (screen))
      return;

  for (position = 0; position < n_params; position++)
  {
      /* reorder child with response_id to position */
      child = dialog_find_button (dialog, new_order[position]);
      gtk_box_reorder_child (GTK_BOX (dialog->action_area), child, position);
    }
}
1238

1239 1240
#define __GTK_DIALOG_C__
#include "gtkaliasdef.c"