gtkdialog.c 35.5 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;
};

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
static guint dialog_signals[LAST_SIGNAL];
Elliot Lee's avatar
Elliot Lee committed
92

Matthias Clasen's avatar
Matthias Clasen committed
93
G_DEFINE_TYPE (GtkDialog, gtk_dialog, GTK_TYPE_WINDOW)
Elliot Lee's avatar
Elliot Lee committed
94 95 96 97

static void
gtk_dialog_class_init (GtkDialogClass *class)
{
98
  GObjectClass *gobject_class;
99
  GtkWidgetClass *widget_class;
100 101
  GtkBindingSet *binding_set;
  
102 103
  gobject_class = G_OBJECT_CLASS (class);
  widget_class = GTK_WIDGET_CLASS (class);
104
  
105 106
  gobject_class->set_property = gtk_dialog_set_property;
  gobject_class->get_property = gtk_dialog_get_property;
107
  
108
  widget_class->map = gtk_dialog_map;
109
  widget_class->style_set = gtk_dialog_style_set;
110 111

  class->close = gtk_dialog_close;
112
  
Federico Mena Quintero's avatar
Federico Mena Quintero committed
113 114
  g_type_class_add_private (gobject_class, sizeof (GtkDialogPrivate));

115 116
  g_object_class_install_property (gobject_class,
                                   PROP_HAS_SEPARATOR,
117
                                   g_param_spec_boolean ("has-separator",
118 119
							 P_("Has separator"),
							 P_("The dialog has a separator bar above its buttons"),
120
                                                         TRUE,
121
                                                         GTK_PARAM_READWRITE));
122
  
123
  dialog_signals[RESPONSE] =
124
    g_signal_new (I_("response"),
Manish Singh's avatar
Manish Singh committed
125 126 127 128 129 130 131
		  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);
132

133
  dialog_signals[CLOSE] =
134
    g_signal_new (I_("close"),
Manish Singh's avatar
Manish Singh committed
135 136 137 138 139 140
		  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);
141
  
142
  gtk_widget_class_install_style_property (widget_class,
143
					   g_param_spec_int ("content-area-border",
144 145
                                                             P_("Content area border"),
                                                             P_("Width of border around the main dialog area"),
146 147 148
                                                             0,
                                                             G_MAXINT,
                                                             2,
149
                                                             GTK_PARAM_READABLE));
150
  gtk_widget_class_install_style_property (widget_class,
151
                                           g_param_spec_int ("button-spacing",
152 153
                                                             P_("Button spacing"),
                                                             P_("Spacing between buttons"),
154 155
                                                             0,
                                                             G_MAXINT,
156
                                                             6,
157
                                                             GTK_PARAM_READABLE));
158 159
  
  gtk_widget_class_install_style_property (widget_class,
160
                                           g_param_spec_int ("action-area-border",
161 162
                                                             P_("Action area border"),
                                                             P_("Width of border around the button area at the bottom of the dialog"),
163 164
                                                             0,
                                                             G_MAXINT,
165
                                                             5,
166
                                                             GTK_PARAM_READABLE));
167 168 169 170 171

  binding_set = gtk_binding_set_by_class (class);
  
  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
                                "close", 0);
172 173 174 175 176 177 178 179 180 181 182 183 184
}

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,
185 186 187
                        "content-area-border", &content_area_border,
                        "button-spacing", &button_spacing,
                        "action-area-border", &action_area_border,
188 189 190 191 192 193 194 195
                        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
196 197 198 199 200
}

static void
gtk_dialog_init (GtkDialog *dialog)
{
Federico Mena Quintero's avatar
Federico Mena Quintero committed
201 202 203 204 205
  GtkDialogPrivate *priv;

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

206 207 208 209
  /* 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
210 211 212 213
  g_signal_connect (dialog,
                    "delete_event",
                    G_CALLBACK (gtk_dialog_delete_event_handler),
                    NULL);
214
  
Elliot Lee's avatar
Elliot Lee committed
215
  dialog->vbox = gtk_vbox_new (FALSE, 0);
216
  
Elliot Lee's avatar
Elliot Lee committed
217 218 219
  gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
  gtk_widget_show (dialog->vbox);

220 221 222
  dialog->action_area = gtk_hbutton_box_new ();

  gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
223
                             GTK_BUTTONBOX_END);  
224

225 226
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
                    FALSE, TRUE, 0);
Elliot Lee's avatar
Elliot Lee committed
227 228
  gtk_widget_show (dialog->action_area);

229 230 231
  dialog->separator = gtk_hseparator_new ();
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
  gtk_widget_show (dialog->separator);
232 233 234

  gtk_window_set_type_hint (GTK_WINDOW (dialog),
			    GDK_WINDOW_TYPE_HINT_DIALOG);
235
  gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
Elliot Lee's avatar
Elliot Lee committed
236 237
}

238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

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

283 284 285 286 287 288
static gint
gtk_dialog_delete_event_handler (GtkWidget   *widget,
                                 GdkEventAny *event,
                                 gpointer     user_data)
{
  /* emit response signal */
289
  gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
290 291 292 293 294

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

295 296 297 298 299
/* 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.
300 301 302
 *
 * Additionally, skip selectable labels when looking for the
 * right initial focus widget.
303 304 305 306 307 308 309
 */
static void
gtk_dialog_map (GtkWidget *widget)
{
  GtkWindow *window = GTK_WINDOW (widget);
  GtkDialog *dialog = GTK_DIALOG (widget);
  
Matthias Clasen's avatar
Matthias Clasen committed
310
  GTK_WIDGET_CLASS (gtk_dialog_parent_class)->map (widget);
311 312 313 314

  if (!window->focus_widget)
    {
      GList *children, *tmp_list;
315
      GtkWidget *first_focus = NULL;
316
      
317 318 319
      do 
	{
	  g_signal_emit_by_name (window, "move_focus", GTK_DIR_TAB_FORWARD);
320 321 322 323 324

	  if (first_focus == NULL)
	    first_focus = window->focus_widget;
	  else if (first_focus == window->focus_widget)
	    break;
325 326 327 328 329

	  if (!GTK_IS_LABEL (window->focus_widget))
	    break;
	  else
	    gtk_label_select_region (GTK_LABEL (window->focus_widget), 0, 0);
330
	}
331
      while (TRUE);
332 333

      tmp_list = children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
334
      
335 336 337
      while (tmp_list)
	{
	  GtkWidget *child = tmp_list->data;
338 339 340 341 342
	  
	  if ((window->focus_widget == NULL || 
	       child == window->focus_widget) && 
	      child != window->default_widget &&
	      window->default_widget)
343 344 345 346 347 348 349
	    {
	      gtk_widget_grab_focus (window->default_widget);
	      break;
	    }
	  
	  tmp_list = tmp_list->next;
	}
350
      
351 352 353 354
      g_list_free (children);
    }
}

355 356 357 358 359 360 361
static void
gtk_dialog_style_set (GtkWidget *widget,
                      GtkStyle  *prev_style)
{
  update_spacings (GTK_DIALOG (widget));
}

362 363 364
static GtkWidget *
dialog_find_button (GtkDialog *dialog,
		    gint       response_id)
365 366
{
  GList *children, *tmp_list;
367
  GtkWidget *child = NULL;
368 369 370 371 372
      
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));

  for (tmp_list = children; tmp_list; tmp_list = tmp_list->next)
    {
373
      ResponseData *rd = get_response_data (tmp_list->data, FALSE);
374
      
375
      if (rd && rd->response_id == response_id)
376
	{
377
	  child = tmp_list->data;
378 379 380 381 382 383
	  break;
	}
    }

  g_list_free (children);

384
  return child;
385 386
}

387 388
static void
gtk_dialog_close (GtkDialog *dialog)
389
{
390 391
  /* Synthesize delete_event to close dialog. */
  
392 393
  GtkWidget *widget = GTK_WIDGET (dialog);
  GdkEvent *event;
394

395
  event = gdk_event_new (GDK_DELETE);
396
  
397 398
  event->any.window = g_object_ref (widget->window);
  event->any.send_event = TRUE;
399
  
400 401
  gtk_main_do_event (event);
  gdk_event_free (event);
402 403
}

Elliot Lee's avatar
Elliot Lee committed
404
GtkWidget*
405
gtk_dialog_new (void)
Elliot Lee's avatar
Elliot Lee committed
406
{
Manish Singh's avatar
Manish Singh committed
407
  return g_object_new (GTK_TYPE_DIALOG, NULL);
Elliot Lee's avatar
Elliot Lee committed
408
}
409 410 411 412 413 414 415 416

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

Manish Singh's avatar
Manish Singh committed
417
  dialog = g_object_new (GTK_TYPE_DIALOG, NULL);
418 419 420 421 422 423 424 425 426

  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);
427
  
428 429 430
  if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
    gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);

431 432 433
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    gtk_dialog_set_has_separator (dialog, FALSE);
  
434 435 436 437 438
  return GTK_WIDGET (dialog);
}

/**
 * gtk_dialog_new_with_buttons:
439 440
 * @title: Title of the dialog, or %NULL
 * @parent: Transient parent of the dialog, or %NULL
441
 * @flags: from #GtkDialogFlags
442 443
 * @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
444
 * 
445
 * Creates a new #GtkDialog with title @title (or %NULL for the default
446
 * title; see gtk_window_set_title()) and transient parent @parent (or
447 448
 * %NULL for none; see gtk_window_set_transient_for()). The @flags
 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
449
 * and/or to have it destroyed along with its transient parent
450 451
 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
 * text/response ID pairs should be listed, with a %NULL pointer ending
452
 * the list. Button text can be either a stock ID such as
453
 * #GTK_STOCK_OK, or some arbitrary text. A response ID can be
454 455
 * any positive number, or one of the values in the #GtkResponseType
 * enumeration. If the user clicks one of these dialog buttons,
456 457 458 459 460 461
 * #GtkDialog will emit the #GtkDialog::response signal with the corresponding
 * response ID. If a #GtkDialog receives the #GtkWidget::delete-event signal, 
 * it will emit ::response with a response ID of #GTK_RESPONSE_DELETE_EVENT.
 * However, destroying a dialog does not emit the ::response signal;
 * so be careful relying on ::response when using the 
 * #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
462 463 464
 * 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
465
 * <informalexample><programlisting>
466 467 468 469 470 471 472 473
 *  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
474
 * </programlisting></informalexample>
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
 * 
 * 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);
}

501 502 503 504 505 506
static void 
response_data_free (gpointer data)
{
  g_slice_free (ResponseData, data);
}

507
static ResponseData*
508 509
get_response_data (GtkWidget *widget,
		   gboolean   create)
510
{
Manish Singh's avatar
Manish Singh committed
511 512
  ResponseData *ad = g_object_get_data (G_OBJECT (widget),
                                        "gtk-dialog-response-data");
513

514
  if (ad == NULL && create)
515
    {
516
      ad = g_slice_new (ResponseData);
517
      
Manish Singh's avatar
Manish Singh committed
518
      g_object_set_data_full (G_OBJECT (widget),
519
                              I_("gtk-dialog-response-data"),
Manish Singh's avatar
Manish Singh committed
520
                              ad,
521
			      response_data_free);
522 523 524 525 526 527 528 529 530 531
    }

  return ad;
}

static void
action_widget_activated (GtkWidget *widget, GtkDialog *dialog)
{
  gint response_id;
  
532
  response_id = gtk_dialog_get_response_for_widget (dialog, widget);
533 534 535

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

537 538 539 540 541 542 543
/**
 * 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,
544 545 546 547 548
 * connecting a signal handler that will emit the #GtkDialog::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 @action_area field 
 * of the #GtkDialog struct.
549 550
 **/
void
Manish Singh's avatar
Manish Singh committed
551 552 553
gtk_dialog_add_action_widget (GtkDialog *dialog,
                              GtkWidget *child,
                              gint       response_id)
554 555
{
  ResponseData *ad;
556
  guint signal_id;
557 558 559 560
  
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  g_return_if_fail (GTK_IS_WIDGET (child));

561
  ad = get_response_data (child, TRUE);
562 563 564

  ad->response_id = response_id;

565
  if (GTK_IS_BUTTON (child))
Manish Singh's avatar
Manish Singh committed
566
    signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
567
  else
568
    signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
569 570 571

  if (signal_id)
    {
Manish Singh's avatar
Manish Singh committed
572 573 574 575 576 577 578 579 580
      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);
581 582 583 584 585 586
    }
  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,
587 588 589 590
                    FALSE, TRUE, 0);
  
  if (response_id == GTK_RESPONSE_HELP)
    gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
591 592 593 594 595 596 597 598 599 600
}

/**
 * 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
601 602 603
 * #GtkDialog::response signal with the given @response_id. The button is 
 * appended to the end of the dialog's action area. The button widget is 
 * returned, but usually you don't need it.
604 605
 *
 * Return value: the button widget that was added
606
 **/
607
GtkWidget*
608 609 610 611 612 613
gtk_dialog_add_button (GtkDialog   *dialog,
                       const gchar *button_text,
                       gint         response_id)
{
  GtkWidget *button;
  
614 615
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
  g_return_val_if_fail (button_text != NULL, NULL);
616

617
  button = gtk_button_new_from_stock (button_text);
618

619 620
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
  
621 622 623 624 625
  gtk_widget_show (button);
  
  gtk_dialog_add_action_widget (dialog,
                                button,
                                response_id);
626 627

  return button;
628 629 630
}

static void
Chema Celorio's avatar
Chema Celorio committed
631 632 633
gtk_dialog_add_buttons_valist (GtkDialog      *dialog,
                               const gchar    *first_button_text,
                               va_list         args)
634 635 636 637
{
  const gchar* text;
  gint response_id;

638 639
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  
640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
  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()
664
 * repeatedly.  The variable argument list should be %NULL-terminated
665 666 667 668 669 670 671
 * 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,
                        ...)
672
{  
673 674 675 676 677 678 679 680 681 682 683
  va_list args;

  va_start (args, first_button_text);

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

684 685 686 687 688 689
/**
 * gtk_dialog_set_response_sensitive:
 * @dialog: a #GtkDialog
 * @response_id: a response ID
 * @setting: %TRUE for sensitive
 *
Matthias Clasen's avatar
Matthias Clasen committed
690 691
 * Calls <literal>gtk_widget_set_sensitive (widget, @setting)</literal> 
 * for each widget in the dialog's action area with the given @response_id.
692 693 694 695 696 697 698 699 700 701
 * 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
702 703
  g_return_if_fail (GTK_IS_DIALOG (dialog));

704
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
705 706 707 708 709

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
710
      ResponseData *rd = get_response_data (widget, FALSE);
711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736

      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
737 738
  g_return_if_fail (GTK_IS_DIALOG (dialog));

739
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
740 741 742 743 744

  tmp_list = children;
  while (tmp_list != NULL)
    {
      GtkWidget *widget = tmp_list->data;
745
      ResponseData *rd = get_response_data (widget, FALSE);
746 747

      if (rd && rd->response_id == response_id)
748
	gtk_widget_grab_default (widget);
Owen Taylor's avatar
Owen Taylor committed
749
	    
750 751 752 753 754 755
      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

756 757 758 759 760 761 762 763
/**
 * 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.
 **/
764 765 766 767
void
gtk_dialog_set_has_separator (GtkDialog *dialog,
                              gboolean   setting)
{
Federico Mena Quintero's avatar
Federico Mena Quintero committed
768 769
  GtkDialogPrivate *priv;

770 771
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Federico Mena Quintero's avatar
Federico Mena Quintero committed
772 773
  priv = GET_PRIVATE (dialog);

774 775
  /* this might fail if we get called before _init() somehow */
  g_assert (dialog->vbox != NULL);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
776 777 778 779 780 781

  if (priv->ignore_separator)
    {
      g_warning ("Ignoring the separator setting");
      return;
    }
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
  
  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;
    }

800
  g_object_notify (G_OBJECT (dialog), "has-separator");
801 802
}

803 804 805 806 807 808 809 810
/**
 * 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
 **/
811 812 813 814 815 816 817 818
gboolean
gtk_dialog_get_has_separator (GtkDialog *dialog)
{
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);

  return dialog->separator != NULL;
}

819 820 821 822 823
/**
 * gtk_dialog_response:
 * @dialog: a #GtkDialog
 * @response_id: response ID 
 * 
824 825
 * Emits the #GtkDialog::response signal with the given response ID. 
 * Used to indicate that the user has responded to the dialog in some way;
826
 * typically either you or gtk_dialog_run() will be monitoring the
827
 * ::response signal and take appropriate action.
828 829 830 831 832 833 834
 **/
void
gtk_dialog_response (GtkDialog *dialog,
                     gint       response_id)
{
  g_return_if_fail (GTK_IS_DIALOG (dialog));

Manish Singh's avatar
Manish Singh committed
835 836 837 838
  g_signal_emit (dialog,
		 dialog_signals[RESPONSE],
		 0,
		 response_id);
839 840 841 842 843 844 845
}

typedef struct
{
  GtkDialog *dialog;
  gint response_id;
  GMainLoop *loop;
846
  gboolean destroyed;
847 848 849 850 851
} RunInfo;

static void
shutdown_loop (RunInfo *ri)
{
852 853
  if (g_main_loop_is_running (ri->loop))
    g_main_loop_quit (ri->loop);
854 855 856
}

static void
857
run_unmap_handler (GtkDialog *dialog, gpointer data)
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
{
  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 */
}

890 891 892 893 894 895 896 897 898 899
static void
run_destroy_handler (GtkDialog *dialog, gpointer data)
{
  RunInfo *ri = data;

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

900 901 902 903 904
/**
 * gtk_dialog_run:
 * @dialog: a #GtkDialog
 * 
 * Blocks in a recursive main loop until the @dialog either emits the
905 906 907 908 909
 * #GtkDialog::response signal, or is destroyed. If the dialog is 
 * destroyed during the call to gtk_dialog_run(), gtk_dialog_run() returns 
 * #GTK_RESPONSE_NONE. Otherwise, it returns the response ID from the 
 * ::response signal emission.
 *
Soeren Sandmann's avatar
Soeren Sandmann committed
910
 * Before entering the recursive main loop, gtk_dialog_run() calls
911 912 913
 * gtk_widget_show() on the dialog for you. Note that you still
 * need to show any children of the dialog yourself.
 *
914 915
 * During gtk_dialog_run(), the default behavior of #GtkWidget::delete-event 
 * is disabled; if the dialog receives ::delete_event, it will not be
916
 * destroyed as windows usually are, and gtk_dialog_run() will return
917 918 919 920 921
 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog 
 * will be 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.
922 923 924 925 926
 *
 * 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
927
 * <informalexample><programlisting>
928 929 930 931 932 933 934 935 936 937 938
 *   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
939
 * </programlisting></informalexample>
940
 * 
941 942
 * Note that even though the recursive main loop gives the effect of a
 * modal dialog (it prevents the user from interacting with other 
943 944 945
 * windows in the same window group 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.
946
 * 
947 948 949 950 951
 * Return value: response ID
 **/
gint
gtk_dialog_run (GtkDialog *dialog)
{
952
  RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL, FALSE };
953
  gboolean was_modal;
954 955 956 957
  gulong response_handler;
  gulong unmap_handler;
  gulong destroy_handler;
  gulong delete_handler;
958 959 960
  
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);

Manish Singh's avatar
Manish Singh committed
961
  g_object_ref (dialog);
962 963 964 965 966

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

967 968 969
  if (!GTK_WIDGET_VISIBLE (dialog))
    gtk_widget_show (GTK_WIDGET (dialog));
  
970
  response_handler =
Manish Singh's avatar
Manish Singh committed
971 972 973 974
    g_signal_connect (dialog,
                      "response",
                      G_CALLBACK (run_response_handler),
                      &ri);
975
  
976
  unmap_handler =
Manish Singh's avatar
Manish Singh committed
977 978 979 980
    g_signal_connect (dialog,
                      "unmap",
                      G_CALLBACK (run_unmap_handler),
                      &ri);
981 982
  
  delete_handler =
Manish Singh's avatar
Manish Singh committed
983
    g_signal_connect (dialog,
984
                      "delete-event",
Manish Singh's avatar
Manish Singh committed
985 986
                      G_CALLBACK (run_delete_handler),
                      &ri);
987
  
988
  destroy_handler =
Manish Singh's avatar
Manish Singh committed
989 990 991 992
    g_signal_connect (dialog,
                      "destroy",
                      G_CALLBACK (run_destroy_handler),
                      &ri);
993
  
Manish Singh's avatar
Manish Singh committed
994
  ri.loop = g_main_loop_new (NULL, FALSE);
995

996
  GDK_THREADS_LEAVE ();  
997
  g_main_loop_run (ri.loop);
998
  GDK_THREADS_ENTER ();  
999 1000 1001 1002

  g_main_loop_unref (ri.loop);

  ri.loop = NULL;
1003
  
1004
  if (!ri.destroyed)
1005 1006 1007 1008
    {
      if (!was_modal)
        gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
      
Manish Singh's avatar
Manish Singh committed
1009 1010 1011 1012
      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);
1013 1014
    }

Manish Singh's avatar
Manish Singh committed
1015
  g_object_unref (dialog);
1016 1017 1018

  return ri.response_id;
}
Federico Mena Quintero's avatar
Federico Mena Quintero committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

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

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

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
/**
 * 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
 */
1043
gint
1044 1045
gtk_dialog_get_response_for_widget (GtkDialog *dialog,
				    GtkWidget *widget)
1046 1047 1048 1049 1050 1051 1052 1053 1054
{
  ResponseData *rd;

  rd = get_response_data (widget, FALSE);
  if (!rd)
    return GTK_RESPONSE_NONE;
  else
    return rd->response_id;
}
1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 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

/**
 * 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
 *
1119 1120 1121 1122
 * Sets an alternative button order. If the 
 * #GtkSettings: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.
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136
 *
 * 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);
1137
 *  
1138 1139 1140
 * ok_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
 *                                    GTK_STOCK_OK,
 *                                    GTK_RESPONSE_OK);
1141
 *   
1142
 * gtk_widget_grab_default (ok_button);
1143
 *   
1144 1145 1146
 * help_button = gtk_dialog_add_button (GTK_DIALOG (dialog),
 *                                      GTK_STOCK_HELP,
 *                                      GTK_RESPONSE_HELP);
1147
 *  
1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177
 * 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);
}
1178 1179 1180 1181 1182 1183
/**
 * 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
 *
1184 1185 1186 1187
 * Sets an alternative button order. If the 
 * #GtkSettings: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.
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
 *
 * 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);
    }
}
1218

1219 1220
#define __GTK_DIALOG_C__
#include "gtkaliasdef.c"