gtkdialog.c 29.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"
Elliot Lee's avatar
Elliot Lee committed
31
#include "gtkhseparator.h"
32
#include "gtkmarshalers.h"
Elliot Lee's avatar
Elliot Lee committed
33
#include "gtkvbox.h"
34 35
#include "gdkkeysyms.h"
#include "gtkmain.h"
36
#include "gtkintl.h"
37
#include "gtkbindings.h"
Elliot Lee's avatar
Elliot Lee committed
38

Federico Mena Quintero's avatar
Federico Mena Quintero committed
39 40 41 42 43 44
#define GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_DIALOG, GtkDialogPrivate))

typedef struct {
  guint ignore_separator : 1;
} GtkDialogPrivate;

45 46 47 48 49 50 51
typedef struct _ResponseData ResponseData;

struct _ResponseData
{
  gint response_id;
};

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

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);

63 64 65 66 67 68 69 70
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);
71 72
static void gtk_dialog_style_set         (GtkWidget        *widget,
                                          GtkStyle         *prev_style);
73
static void gtk_dialog_map               (GtkWidget        *widget);
74

75 76
static void gtk_dialog_close             (GtkDialog        *dialog);

77 78
static ResponseData* get_response_data   (GtkWidget        *widget,
					  gboolean          create);
79

80 81 82 83
enum {
  PROP_0,
  PROP_HAS_SEPARATOR
};
84 85 86

enum {
  RESPONSE,
87
  CLOSE,
88 89
  LAST_SIGNAL
};
Elliot Lee's avatar
Elliot Lee committed
90

91 92
static gpointer parent_class;
static guint dialog_signals[LAST_SIGNAL];
Elliot Lee's avatar
Elliot Lee committed
93

Manish Singh's avatar
Manish Singh committed
94
GType
95
gtk_dialog_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
96
{
Manish Singh's avatar
Manish Singh committed
97
  static GType dialog_type = 0;
Elliot Lee's avatar
Elliot Lee committed
98 99 100

  if (!dialog_type)
    {
Manish Singh's avatar
Manish Singh committed
101
      static const GTypeInfo dialog_info =
Elliot Lee's avatar
Elliot Lee committed
102 103
      {
	sizeof (GtkDialogClass),
Manish Singh's avatar
Manish Singh committed
104 105 106 107 108 109 110 111
	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
112 113
      };

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

  return dialog_type;
}

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

  gobject_class->set_property = gtk_dialog_set_property;
  gobject_class->get_property = gtk_dialog_get_property;
135
  
136
  widget_class->map = gtk_dialog_map;
137
  widget_class->style_set = gtk_dialog_style_set;
138 139

  class->close = gtk_dialog_close;
140
  
Federico Mena Quintero's avatar
Federico Mena Quintero committed
141 142
  g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));

143 144 145
  g_object_class_install_property (gobject_class,
                                   PROP_HAS_SEPARATOR,
                                   g_param_spec_boolean ("has_separator",
146 147
							 P_("Has separator"),
							 P_("The dialog has a separator bar above its buttons"),
148 149 150
                                                         TRUE,
                                                         G_PARAM_READWRITE));
  
151
  dialog_signals[RESPONSE] =
Manish Singh's avatar
Manish Singh committed
152 153 154 155 156 157 158 159
    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);
160

161
  dialog_signals[CLOSE] =
Manish Singh's avatar
Manish Singh committed
162 163 164 165 166 167 168
    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);
169
  
170 171
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("content_area_border",
172 173
                                                             P_("Content area border"),
                                                             P_("Width of border around the main dialog area"),
174 175 176 177 178 179
                                                             0,
                                                             G_MAXINT,
                                                             2,
                                                             G_PARAM_READABLE));
  gtk_widget_class_install_style_property (widget_class,
                                           g_param_spec_int ("button_spacing",
180 181
                                                             P_("Button spacing"),
                                                             P_("Spacing between buttons"),
182 183
                                                             0,
                                                             G_MAXINT,
184
                                                             10,
185 186 187 188
                                                             G_PARAM_READABLE));
  
  gtk_widget_class_install_style_property (widget_class,
                                           g_param_spec_int ("action_area_border",
189 190
                                                             P_("Action area border"),
                                                             P_("Width of border around the button area at the bottom of the dialog"),
191 192
                                                             0,
                                                             G_MAXINT,
193
                                                             5,
194
                                                             G_PARAM_READABLE));
195 196 197 198 199

  binding_set = gtk_binding_set_by_class (class);
  
  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
                                "close", 0);
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
}

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,
                        "content_area_border",
                        &content_area_border,
                        "button_spacing",
                        &button_spacing,
                        "action_area_border",
                        &action_area_border,
                        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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
/* 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.
 */
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;
      
      g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);

      tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));

      while (tmp_list)
	{
	  GtkWidget *child = tmp_list->data;

	  if (child == window->focus_widget && child != window->default_widget && window->default_widget)
	    {
	      gtk_widget_grab_focus (window->default_widget);
	      break;
	    }
	  
	  tmp_list = tmp_list->next;
	}

      g_list_free (children);
    }
}

365 366 367 368 369 370 371
static void
gtk_dialog_style_set (GtkWidget *widget,
                      GtkStyle  *prev_style)
{
  update_spacings (GTK_DIALOG (widget));
}

372 373 374 375 376 377 378 379 380 381
static gboolean
dialog_has_cancel (GtkDialog *dialog)
{
  GList *children, *tmp_list;
  gboolean ret = FALSE;
      
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));

  for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
    {
382
      ResponseData *rd = get_response_data (tmp_list->data, FALSE);
383 384 385 386 387 388 389 390 391 392 393 394 395
      
      if (rd && rd->response_id == GTK_RESPONSE_CANCEL)
	{
	  ret = TRUE;
	  break;
	}
    }

  g_list_free (children);

  return ret;
}

396 397
static void
gtk_dialog_close (GtkDialog *dialog)
398
{
399 400
  /* Synthesize delete_event to close dialog. */
  
401 402
  GtkWidget *widget = GTK_WIDGET (dialog);
  GdkEvent *event;
403

404 405 406
  if (!dialog_has_cancel (dialog))
    return;

407
  event = gdk_event_new (GDK_DELETE);
408
  
409 410
  event->any.window = g_object_ref (widget->window);
  event->any.send_event = TRUE;
411
  
412 413
  gtk_main_do_event (event);
  gdk_event_free (event);
414 415
}

Elliot Lee's avatar
Elliot Lee committed
416
GtkWidget*
417
gtk_dialog_new (void)
Elliot Lee's avatar
Elliot Lee committed
418
{
Manish Singh's avatar
Manish Singh committed
419
  return g_object_new (GTK_TYPE_DIALOG, NULL);
Elliot Lee's avatar
Elliot Lee committed
420
}
421 422 423 424 425 426 427 428

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

Manish Singh's avatar
Manish Singh committed
429
  dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
430 431 432 433 434 435 436 437 438

  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);
439
  
440 441 442
  if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
    gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);

443 444 445
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    gtk_dialog_set_has_separator (dialog, FALSE);
  
446 447 448 449 450
  return GTK_WIDGET (dialog);
}

/**
 * gtk_dialog_new_with_buttons:
451 452
 * @title: Title of the dialog, or %NULL
 * @parent: Transient parent of the dialog, or %NULL
453
 * @flags: from #GtkDialogFlags
454 455
 * @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
456
 * 
457
 * Creates a new #GtkDialog with title @title (or %NULL for the default
458
 * title; see gtk_window_set_title()) and transient parent @parent (or
459 460
 * %NULL for none; see gtk_window_set_transient_for()). The @flags
 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
461
 * and/or to have it destroyed along with its transient parent
462 463
 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
 * text/response ID pairs should be listed, with a %NULL pointer ending
464
 * the list. Button text can be either a stock ID such as
465
 * #GTK_STOCK_OK, or some arbitrary text.  A response ID can be
466 467 468 469
 * 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
470
 * will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT.
471 472
 * However, destroying a dialog does not emit the "response" signal;
 * so be careful relying on "response" when using
473
 * the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
474 475 476
 * 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
477
 * <informalexample><programlisting>
478 479 480 481 482 483 484 485
 *  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
486
 * </programlisting></informalexample>
487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
 * 
 * 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*
514 515
get_response_data (GtkWidget *widget,
		   gboolean   create)
516
{
Manish Singh's avatar
Manish Singh committed
517 518
  ResponseData *ad = g_object_get_data (G_OBJECT (widget),
                                        "gtk-dialog-response-data");
519

520
  if (ad == NULL && create)
521 522 523
    {
      ad = g_new (ResponseData, 1);
      
Manish Singh's avatar
Manish Singh committed
524 525 526 527
      g_object_set_data_full (G_OBJECT (widget),
                              "gtk-dialog-response-data",
                              ad,
                              g_free);
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
    }

  return ad;
}

static void
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
{
  ResponseData *ad;
  gint response_id;
  
  g_return_if_fail (GTK_IS_DIALOG (dialog));

  response_id = GTK_RESPONSE_NONE;
  
543
  ad = get_response_data (widget, TRUE);
544 545 546 547 548 549 550

  g_assert (ad != NULL);
  
  response_id = ad->response_id;

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

552 553 554 555 556 557 558 559 560 561 562 563 564 565
/**
 * 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
566 567 568
gtk_dialog_add_action_widget (GtkDialog *dialog,
                              GtkWidget *child,
                              gint       response_id)
569 570
{
  ResponseData *ad;
571
  gint signal_id = 0;
572 573 574 575
  
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  g_return_if_fail (GTK_IS_WIDGET (child));

576
  ad = get_response_data (child, TRUE);
577 578 579

  ad->response_id = response_id;

580
  if (GTK_IS_BUTTON (child))
Manish Singh's avatar
Manish Singh committed
581
    signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
582 583 584 585 586
  else
    signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal != 0;

  if (signal_id)
    {
Manish Singh's avatar
Manish Singh committed
587 588 589 590 591 592 593 594 595
      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);
596 597 598 599 600 601
    }
  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,
602 603 604 605
                    FALSE, TRUE, 0);
  
  if (response_id == GTK_RESPONSE_HELP)
    gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
606 607 608 609 610 611 612 613 614 615 616
}

/**
 * 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
617 618 619 620
 * 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
621
 **/
622
GtkWidget*
623 624 625 626 627 628
gtk_dialog_add_button (GtkDialog   *dialog,
                       const gchar *button_text,
                       gint         response_id)
{
  GtkWidget *button;
  
629 630
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
  g_return_val_if_fail (button_text != NULL, NULL);
631

632
  button = gtk_button_new_from_stock (button_text);
633

634 635
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
  
636 637 638 639 640
  gtk_widget_show (button);
  
  gtk_dialog_add_action_widget (dialog,
                                button,
                                response_id);
641 642

  return button;
643 644 645
}

static void
Chema Celorio's avatar
Chema Celorio committed
646 647 648
gtk_dialog_add_buttons_valist (GtkDialog      *dialog,
                               const gchar    *first_button_text,
                               va_list         args)
649 650 651 652
{
  const gchar* text;
  gint response_id;

653 654
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
  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()
679
 * repeatedly.  The variable argument list should be %NULL-terminated
680 681 682 683 684 685 686
 * 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,
                        ...)
687
{  
688 689 690 691 692 693 694 695 696 697 698
  va_list args;

  va_start (args, first_button_text);

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

699 700 701 702 703 704
/**
 * gtk_dialog_set_response_sensitive:
 * @dialog: a #GtkDialog
 * @response_id: a response ID
 * @setting: %TRUE for sensitive
 *
Matthias Clasen's avatar
Matthias Clasen committed
705 706
 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal> 
 * for each widget in the dialog's action area with the given @response_id.
707 708 709 710 711 712 713 714 715 716
 * 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
717 718
  g_return_if_fail (GTK_IS_DIALOG (dialog));

719
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
      ResponseData *rd = g_object_get_data (G_OBJECT (widget),
                                            "gtk-dialog-response-data");

      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
753 754
  g_return_if_fail (GTK_IS_DIALOG (dialog));

755
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
756 757 758 759 760 761 762 763 764

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
      ResponseData *rd = g_object_get_data (G_OBJECT (widget),
                                            "gtk-dialog-response-data");

      if (rd && rd->response_id == response_id)
765
	gtk_widget_grab_default (widget);
Owen Taylor's avatar
Owen Taylor committed
766
	    
767 768 769 770 771 772
      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

773 774 775 776 777 778 779 780
/**
 * 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.
 **/
781 782 783 784
void
gtk_dialog_set_has_separator (GtkDialog *dialog,
                              gboolean   setting)
{
Federico Mena Quintero's avatar
Federico Mena Quintero committed
785 786
  GtkDialogPrivate *priv;

787 788
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Federico Mena Quintero's avatar
Federico Mena Quintero committed
789 790
  priv = GET_PRIVATE (dialog);

791 792
  /* this might fail if we get called before _init() somehow */
  g_assert (dialog->vbox != NULL);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
793 794 795 796 797 798

  if (priv->ignore_separator)
    {
      g_warning ("Ignoring the separator setting");
      return;
    }
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
  
  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;
    }

  g_object_notify (G_OBJECT (dialog), "has_separator");
}

820 821 822 823 824 825 826 827
/**
 * 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
 **/
828 829 830 831 832 833 834 835
gboolean
gtk_dialog_get_has_separator (GtkDialog *dialog)
{
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);

  return dialog->separator != NULL;
}

836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
/**
 * 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
852 853 854 855
  g_signal_emit (dialog,
		 dialog_signals[RESPONSE],
		 0,
		 response_id);
856 857 858 859 860 861 862
}

typedef struct
{
  GtkDialog *dialog;
  gint response_id;
  GMainLoop *loop;
863
  gboolean destroyed;
864 865 866 867 868
} RunInfo;

static void
shutdown_loop (RunInfo *ri)
{
869 870
  if (g_main_loop_is_running (ri->loop))
    g_main_loop_quit (ri->loop);
871 872 873
}

static void
874
run_unmap_handler (GtkDialog *dialog, gpointer data)
875 876 877 878 879 880 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
{
  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 */
}

907 908 909 910 911 912 913 914 915 916
static void
run_destroy_handler (GtkDialog *dialog, gpointer data)
{
  RunInfo *ri = data;

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

917 918 919 920 921
/**
 * 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
922 923 924 925
 * 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
926 927 928 929 930 931
 * 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
932
 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
933 934 935 936 937 938 939 940 941 942
 * 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
943
 * <informalexample><programlisting>
944 945 946 947 948 949 950 951 952 953 954
 *   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
955
 * </programlisting></informalexample>
956 957 958 959 960 961 962 963
 * 
 * Return value: response ID
 **/
gint
gtk_dialog_run (GtkDialog *dialog)
{
  RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL };
  gboolean was_modal;
964 965 966 967
  gulong response_handler;
  gulong unmap_handler;
  gulong destroy_handler;
  gulong delete_handler;
968 969 970
  
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);

Manish Singh's avatar
Manish Singh committed
971
  g_object_ref (dialog);
972 973 974 975 976

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

977 978 979
  if (!GTK_WIDGET_VISIBLE (dialog))
    gtk_widget_show (GTK_WIDGET (dialog));
  
980
  response_handler =
Manish Singh's avatar
Manish Singh committed
981 982 983 984
    g_signal_connect (dialog,
                      "response",
                      G_CALLBACK (run_response_handler),
                      &ri);
985
  
986
  unmap_handler =
Manish Singh's avatar
Manish Singh committed
987 988 989 990
    g_signal_connect (dialog,
                      "unmap",
                      G_CALLBACK (run_unmap_handler),
                      &ri);
991 992
  
  delete_handler =
Manish Singh's avatar
Manish Singh committed
993 994 995 996
    g_signal_connect (dialog,
                      "delete_event",
                      G_CALLBACK (run_delete_handler),
                      &ri);
997
  
998
  destroy_handler =
Manish Singh's avatar
Manish Singh committed
999 1000 1001 1002
    g_signal_connect (dialog,
                      "destroy",
                      G_CALLBACK (run_destroy_handler),
                      &ri);
1003
  
Manish Singh's avatar
Manish Singh committed
1004
  ri.loop = g_main_loop_new (NULL, FALSE);
1005

1006
  GDK_THREADS_LEAVE ();  
1007
  g_main_loop_run (ri.loop);
1008
  GDK_THREADS_ENTER ();  
1009 1010 1011 1012

  g_main_loop_unref (ri.loop);

  ri.loop = NULL;
1013
  ri.destroyed = FALSE;
1014
  
1015
  if (!ri.destroyed)
1016 1017 1018 1019
    {
      if (!was_modal)
        gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
      
Manish Singh's avatar
Manish Singh committed
1020 1021 1022 1023
      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);
1024 1025
    }

Manish Singh's avatar
Manish Singh committed
1026
  g_object_unref (dialog);
1027 1028 1029

  return ri.response_id;
}
Federico Mena Quintero's avatar
Federico Mena Quintero committed
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039

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

  priv = GET_PRIVATE (dialog);
  priv->ignore_separator = ignore_separator;
}
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052

gint
_gtk_dialog_get_response_for_widget (GtkDialog *dialog,
				     GtkWidget *widget)
{
  ResponseData *rd;

  rd = get_response_data (widget, FALSE);
  if (!rd)
    return GTK_RESPONSE_NONE;
  else
    return rd->response_id;
}