gtkdialog.c 29.6 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);

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

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

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

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

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

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

  return dialog_type;
}

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

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

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

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

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

  binding_set = gtk_binding_set_by_class (class);
  
  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
                                "close", 0);
199 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
}

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
226 227 228 229 230
}

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

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

236 237 238 239
  /* 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
240 241 242 243
  g_signal_connect (dialog,
                    "delete_event",
                    G_CALLBACK (gtk_dialog_delete_event_handler),
                    NULL);
244
  
Elliot Lee's avatar
Elliot Lee committed
245
  dialog->vbox = gtk_vbox_new (FALSE, 0);
246
  
Elliot Lee's avatar
Elliot Lee committed
247 248 249
  gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
  gtk_widget_show (dialog->vbox);

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

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

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

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

  gtk_window_set_type_hint (GTK_WINDOW (dialog),
			    GDK_WINDOW_TYPE_HINT_DIALOG);
265
  gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
Elliot Lee's avatar
Elliot Lee committed
266 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

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

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

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

325 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
/* 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);
    }
}

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

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
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)
    {
      ResponseData *rd = get_response_data (tmp_list->data);
      
      if (rd && rd->response_id == GTK_RESPONSE_CANCEL)
	{
	  ret = TRUE;
	  break;
	}
    }

  g_list_free (children);

  return ret;
}

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

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

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

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

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

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

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

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

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

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

  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;
  
  ad = get_response_data (widget);

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

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

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

  ad = get_response_data (child);

  ad->response_id = response_id;

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

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

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

630
  button = gtk_button_new_from_stock (button_text);
631

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

  return button;
641 642 643
}

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

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

  va_start (args, first_button_text);

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

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

717
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
718 719 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

  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
751 752
  g_return_if_fail (GTK_IS_DIALOG (dialog));

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

  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)
763
	gtk_widget_grab_default (widget);
Owen Taylor's avatar
Owen Taylor committed
764
	    
765 766 767 768 769 770
      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

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

785 786
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Federico Mena Quintero's avatar
Federico Mena Quintero committed
787 788
  priv = GET_PRIVATE (dialog);

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

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

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

  return dialog->separator != NULL;
}

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

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

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

static void
872
run_unmap_handler (GtkDialog *dialog, gpointer data)
873 874 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
{
  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 */
}

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

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

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

Manish Singh's avatar
Manish Singh committed
969
  g_object_ref (dialog);
970 971 972 973 974

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

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

1004
  GDK_THREADS_LEAVE ();  
1005
  g_main_loop_run (ri.loop);
1006
  GDK_THREADS_ENTER ();  
1007 1008 1009 1010

  g_main_loop_unref (ri.loop);

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

Manish Singh's avatar
Manish Singh committed
1024
  g_object_unref (dialog);
1025 1026 1027

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

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

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