GitLab repository storage has been migrated to hashed layout. Please contact Infrastructure team if you notice any issues with repositories or hooks.

gtkdialog.c 27.2 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/. 
 */

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

static void gtk_dialog_class_init (GtkDialogClass *klass);
static void gtk_dialog_init       (GtkDialog      *dialog);
41 42 43 44 45 46 47 48 49

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

50 51 52 53 54 55 56 57
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);
58 59
static void gtk_dialog_style_set         (GtkWidget        *widget,
                                          GtkStyle         *prev_style);
60

61 62
static void gtk_dialog_close             (GtkDialog        *dialog);

63 64 65 66
enum {
  PROP_0,
  PROP_HAS_SEPARATOR
};
67 68 69

enum {
  RESPONSE,
70
  CLOSE,
71 72
  LAST_SIGNAL
};
Elliot Lee's avatar
Elliot Lee committed
73

74 75
static gpointer parent_class;
static guint dialog_signals[LAST_SIGNAL];
Elliot Lee's avatar
Elliot Lee committed
76

Tim Janik's avatar
Tim Janik committed
77
GtkType
78
gtk_dialog_get_type (void)
Elliot Lee's avatar
Elliot Lee committed
79
{
Tim Janik's avatar
Tim Janik committed
80
  static GtkType dialog_type = 0;
Elliot Lee's avatar
Elliot Lee committed
81 82 83

  if (!dialog_type)
    {
84
      static const GtkTypeInfo dialog_info =
Elliot Lee's avatar
Elliot Lee committed
85 86 87 88 89 90
      {
	"GtkDialog",
	sizeof (GtkDialog),
	sizeof (GtkDialogClass),
	(GtkClassInitFunc) gtk_dialog_class_init,
	(GtkObjectInitFunc) gtk_dialog_init,
91 92
	/* reserved_1 */ NULL,
        /* reserved_2 */ NULL,
93
        (GtkClassInitFunc) NULL,
Elliot Lee's avatar
Elliot Lee committed
94 95
      };

Tim Janik's avatar
Tim Janik committed
96
      dialog_type = gtk_type_unique (GTK_TYPE_WINDOW, &dialog_info);
Elliot Lee's avatar
Elliot Lee committed
97 98 99 100 101 102 103 104
    }

  return dialog_type;
}

static void
gtk_dialog_class_init (GtkDialogClass *class)
{
105
  GObjectClass *gobject_class;
106 107
  GtkObjectClass *object_class;
  GtkWidgetClass *widget_class;
108 109
  GtkBindingSet *binding_set;
  
110 111 112
  gobject_class = G_OBJECT_CLASS (class);
  object_class = GTK_OBJECT_CLASS (class);
  widget_class = GTK_WIDGET_CLASS (class);
113
  
114
  parent_class = g_type_class_peek_parent (class);
115 116 117

  gobject_class->set_property = gtk_dialog_set_property;
  gobject_class->get_property = gtk_dialog_get_property;
118
  
119
  widget_class->style_set = gtk_dialog_style_set;
120 121

  class->close = gtk_dialog_close;
122
  
123 124 125 126 127 128 129 130
  g_object_class_install_property (gobject_class,
                                   PROP_HAS_SEPARATOR,
                                   g_param_spec_boolean ("has_separator",
							 _("Has separator"),
							 _("The dialog has a separator bar above its buttons"),
                                                         TRUE,
                                                         G_PARAM_READWRITE));
  
131 132 133 134 135
  dialog_signals[RESPONSE] =
    gtk_signal_new ("response",
                    GTK_RUN_LAST,
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkDialogClass, response),
136
                    _gtk_marshal_NONE__INT,
137 138
		    GTK_TYPE_NONE, 1,
                    GTK_TYPE_INT);
139

140 141 142 143 144
  dialog_signals[CLOSE] =
    gtk_signal_new ("close",
                    GTK_RUN_LAST | GTK_RUN_ACTION,
                    GTK_CLASS_TYPE (object_class),
                    GTK_SIGNAL_OFFSET (GtkDialogClass, close),
145
                    _gtk_marshal_NONE__NONE,
146 147
		    GTK_TYPE_NONE, 0);
  
148 149 150 151 152 153 154 155 156 157 158 159 160 161
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("content_area_border",
                                                             _("Content area border"),
                                                             _("Width of border around the main dialog area"),
                                                             0,
                                                             G_MAXINT,
                                                             2,
                                                             G_PARAM_READABLE));
  gtk_widget_class_install_style_property (widget_class,
                                           g_param_spec_int ("button_spacing",
                                                             _("Button spacing"),
                                                             _("Spacing between buttons"),
                                                             0,
                                                             G_MAXINT,
162
                                                             10,
163 164 165 166 167 168 169 170
                                                             G_PARAM_READABLE));
  
  gtk_widget_class_install_style_property (widget_class,
                                           g_param_spec_int ("action_area_border",
                                                             _("Action area border"),
                                                             _("Width of border around the button area at the bottom of the dialog"),
                                                             0,
                                                             G_MAXINT,
171
                                                             5,
172
                                                             G_PARAM_READABLE));
173 174 175 176 177

  binding_set = gtk_binding_set_by_class (class);
  
  gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0,
                                "close", 0);
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
}

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
205 206 207 208 209
}

static void
gtk_dialog_init (GtkDialog *dialog)
{
210 211 212 213 214 215 216 217 218
  /* 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.
   */
  gtk_signal_connect (GTK_OBJECT (dialog),
                      "delete_event",
                      GTK_SIGNAL_FUNC (gtk_dialog_delete_event_handler),
                      NULL);
  
Elliot Lee's avatar
Elliot Lee committed
219
  dialog->vbox = gtk_vbox_new (FALSE, 0);
220
  
Elliot Lee's avatar
Elliot Lee committed
221 222 223
  gtk_container_add (GTK_CONTAINER (dialog), dialog->vbox);
  gtk_widget_show (dialog->vbox);

224 225 226
  dialog->action_area = gtk_hbutton_box_new ();

  gtk_button_box_set_layout (GTK_BUTTON_BOX (dialog->action_area),
227
                             GTK_BUTTONBOX_END);  
228

229 230
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->action_area,
                    FALSE, TRUE, 0);
Elliot Lee's avatar
Elliot Lee committed
231 232
  gtk_widget_show (dialog->action_area);

233 234 235
  dialog->separator = gtk_hseparator_new ();
  gtk_box_pack_end (GTK_BOX (dialog->vbox), dialog->separator, FALSE, TRUE, 0);
  gtk_widget_show (dialog->separator);
236 237 238

  gtk_window_set_type_hint (GTK_WINDOW (dialog),
			    GDK_WINDOW_TYPE_HINT_DIALOG);
239
  gtk_window_set_position (GTK_WINDOW (dialog), GTK_WIN_POS_CENTER_ON_PARENT);
Elliot Lee's avatar
Elliot Lee committed
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 283 284 285 286

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

287 288 289 290 291 292
static gint
gtk_dialog_delete_event_handler (GtkWidget   *widget,
                                 GdkEventAny *event,
                                 gpointer     user_data)
{
  /* emit response signal */
293
  gtk_dialog_response (GTK_DIALOG (widget), GTK_RESPONSE_DELETE_EVENT);
294 295 296 297 298

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

299 300 301 302 303 304 305 306 307
static void
gtk_dialog_style_set (GtkWidget *widget,
                      GtkStyle  *prev_style)
{
  update_spacings (GTK_DIALOG (widget));
}

static void
gtk_dialog_close (GtkDialog *dialog)
308
{
309 310
  /* Synthesize delete_event to close dialog. */
  
311
  GdkEventAny event;
312
  GtkWidget *widget;
313

314 315
  widget = GTK_WIDGET (dialog);
  
316 317 318
  event.type = GDK_DELETE;
  event.window = widget->window;
  event.send_event = TRUE;
319
  
320 321 322 323 324
  g_object_ref (G_OBJECT (event.window));
  
  gtk_main_do_event ((GdkEvent*)&event);
  
  g_object_unref (G_OBJECT (event.window));
325 326
}

Elliot Lee's avatar
Elliot Lee committed
327
GtkWidget*
328
gtk_dialog_new (void)
Elliot Lee's avatar
Elliot Lee committed
329
{
Tim Janik's avatar
Tim Janik committed
330
  return GTK_WIDGET (gtk_type_new (GTK_TYPE_DIALOG));
Elliot Lee's avatar
Elliot Lee committed
331
}
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349

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

  dialog = GTK_DIALOG (g_object_new (GTK_TYPE_DIALOG, NULL));

  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);
350
  
351 352 353
  if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
    gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);

354 355 356
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    gtk_dialog_set_has_separator (dialog, FALSE);
  
357 358 359 360 361
  return GTK_WIDGET (dialog);
}

/**
 * gtk_dialog_new_with_buttons:
362 363
 * @title: Title of the dialog, or %NULL
 * @parent: Transient parent of the dialog, or %NULL
364
 * @flags: from #GtkDialogFlags
365 366
 * @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
367
 * 
368
 * Creates a new #GtkDialog with title @title (or %NULL for the default
369
 * title; see gtk_window_set_title()) and transient parent @parent (or
370 371
 * %NULL for none; see gtk_window_set_transient_for()). The @flags
 * argument can be used to make the dialog modal (#GTK_DIALOG_MODAL)
372
 * and/or to have it destroyed along with its transient parent
373 374
 * (#GTK_DIALOG_DESTROY_WITH_PARENT). After @flags, button
 * text/response ID pairs should be listed, with a %NULL pointer ending
375
 * the list. Button text can be either a stock ID such as
376
 * #GTK_STOCK_OK, or some arbitrary text.  A response ID can be
377 378 379 380
 * 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
381
 * will emit "response" with a response ID of #GTK_RESPONSE_DELETE_EVENT.
382 383
 * However, destroying a dialog does not emit the "response" signal;
 * so be careful relying on "response" when using
384
 * the #GTK_DIALOG_DESTROY_WITH_PARENT flag. Buttons are from left to right,
385 386 387 388 389 390 391
 * so the first button in the list will be the leftmost button in the dialog.
 *
 * Here's a simple example:
 * <programlisting>
 *  GtkWidget *dialog = gtk_dialog_new_with_buttons ("My dialog",
 *                                                   main_app_window,
 *                                                   GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
392
 *                                                   GTK_STOCK_OK,
393
 *                                                   GTK_RESPONSE_ACCEPT,
394
 *                                                   GTK_STOCK_CANCEL,
395
 *                                                   GTK_RESPONSE_REJECT,
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
 *                                                   NULL);
 * </programlisting>
 * 
 * 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);
}

typedef struct _ResponseData ResponseData;

struct _ResponseData
{
  gint response_id;
};

static ResponseData*
get_response_data (GtkWidget *widget)
{
  ResponseData *ad = gtk_object_get_data (GTK_OBJECT (widget),
                                          "gtk-dialog-response-data");

  if (ad == NULL)
    {
      ad = g_new (ResponseData, 1);
      
      gtk_object_set_data_full (GTK_OBJECT (widget),
                                "gtk-dialog-response-data",
                                ad,
                                g_free);
    }

  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);
}
/**
 * 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
gtk_dialog_add_action_widget  (GtkDialog *dialog,
                               GtkWidget *child,
                               gint       response_id)
{
  ResponseData *ad;
487
  gint signal_id = 0;
488 489 490 491 492 493 494 495
  
  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;

496
  if (GTK_IS_BUTTON (child))
497
    {
498 499 500 501 502 503 504 505
      signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
    }
  else
    signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal != 0;

  if (signal_id)
    {
      const gchar* name = gtk_signal_name (signal_id);
506 507 508 509 510 511 512 513 514 515 516 517

      gtk_signal_connect_while_alive (GTK_OBJECT (child),
                                      name,
                                      GTK_SIGNAL_FUNC (action_widget_activated),
                                      dialog,
                                      GTK_OBJECT (dialog));
    }
  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,
518 519 520 521
                    FALSE, TRUE, 0);
  
  if (response_id == GTK_RESPONSE_HELP)
    gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (dialog->action_area), child, TRUE);
522 523 524 525 526 527 528 529 530 531 532
}

/**
 * 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
533 534 535 536
 * 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
537
 **/
538
GtkWidget*
539 540 541 542 543 544
gtk_dialog_add_button (GtkDialog   *dialog,
                       const gchar *button_text,
                       gint         response_id)
{
  GtkWidget *button;
  
545 546
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), NULL);
  g_return_val_if_fail (button_text != NULL, NULL);
547

548
  button = gtk_button_new_from_stock (button_text);
549

550 551
  GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
  
552 553 554 555 556
  gtk_widget_show (button);
  
  gtk_dialog_add_action_widget (dialog,
                                button,
                                response_id);
557 558

  return button;
559 560 561 562 563 564 565 566 567 568
}

static void
gtk_dialog_add_buttons_valist(GtkDialog      *dialog,
                              const gchar    *first_button_text,
                              va_list         args)
{
  const gchar* text;
  gint response_id;

569 570
  g_return_if_fail (GTK_IS_DIALOG (dialog));
  
571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
  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()
595
 * repeatedly.  The variable argument list should be %NULL-terminated
596 597 598 599 600 601 602
 * 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,
                        ...)
603
{  
604 605 606 607 608 609 610 611 612 613 614
  va_list args;

  va_start (args, first_button_text);

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

615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632
/**
 * gtk_dialog_set_response_sensitive:
 * @dialog: a #GtkDialog
 * @response_id: a response ID
 * @setting: %TRUE for sensitive
 *
 * Calls gtk_widget_set_sensitive (widget, @setting) for each
 * widget in the dialog's action area with the given @response_id.
 * 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
633 634
  g_return_if_fail (GTK_IS_DIALOG (dialog));

635
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

  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
669 670
  g_return_if_fail (GTK_IS_DIALOG (dialog));

671
  children = gtk_container_get_children (GTK_CONTAINER (dialog->action_area));
672 673 674 675 676 677 678 679 680

  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)
Owen Taylor's avatar
Owen Taylor committed
681 682 683 684 685 686 687
	{
	  gtk_widget_grab_default (widget);
	  
	  if (!GTK_WINDOW (dialog)->focus_widget)
	    gtk_widget_grab_focus (widget);
	}
	    
688 689 690 691 692 693
      tmp_list = g_list_next (tmp_list);
    }

  g_list_free (children);
}

694 695 696 697 698 699 700 701
/**
 * 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.
 **/
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
void
gtk_dialog_set_has_separator (GtkDialog *dialog,
                              gboolean   setting)
{
  g_return_if_fail (GTK_IS_DIALOG (dialog));

  /* this might fail if we get called before _init() somehow */
  g_assert (dialog->vbox != NULL);
  
  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");
}

731 732 733 734 735 736 737 738
/**
 * 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
 **/
739 740 741 742 743 744 745 746
gboolean
gtk_dialog_get_has_separator (GtkDialog *dialog)
{
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), FALSE);

  return dialog->separator != NULL;
}

747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
/**
 * 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));

  gtk_signal_emit (GTK_OBJECT (dialog),
                   dialog_signals[RESPONSE],
                   response_id);
}

typedef struct
{
  GtkDialog *dialog;
  gint response_id;
  GMainLoop *loop;
} RunInfo;

static void
shutdown_loop (RunInfo *ri)
{
778 779
  if (g_main_loop_is_running (ri->loop))
    g_main_loop_quit (ri->loop);
780 781 782
}

static void
783
run_unmap_handler (GtkDialog *dialog, gpointer data)
784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
{
  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 */
}

/**
 * gtk_dialog_run:
 * @dialog: a #GtkDialog
 * 
 * Blocks in a recursive main loop until the @dialog either emits the
 * response signal, or is destroyed. If the dialog is destroyed,
822
 * gtk_dialog_run() returns #GTK_RESPONSE_NONE. Otherwise, it returns
823 824 825 826 827 828 829 830
 * the response ID from the "response" signal emission. Before
 * entering the recursive main loop, gtk_dialog_run() calls
 * 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
831
 * #GTK_RESPONSE_DELETE_EVENT. Also, during gtk_dialog_run() the dialog will be
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 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
 * 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:
 * <programlisting>
 *   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);
 * </programlisting>
 * 
 * Return value: response ID
 **/
gint
gtk_dialog_run (GtkDialog *dialog)
{
  RunInfo ri = { NULL, GTK_RESPONSE_NONE, NULL };
  gboolean was_modal;
  guint response_handler;
  guint destroy_handler;
  guint delete_handler;
  
  g_return_val_if_fail (GTK_IS_DIALOG (dialog), -1);

  gtk_object_ref (GTK_OBJECT (dialog));

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

  response_handler =
    gtk_signal_connect (GTK_OBJECT (dialog),
                        "response",
                        GTK_SIGNAL_FUNC (run_response_handler),
                        &ri);
  
  destroy_handler =
    gtk_signal_connect (GTK_OBJECT (dialog),
886 887
                        "unmap",
                        GTK_SIGNAL_FUNC (run_unmap_handler),
888 889 890 891 892 893 894 895 896 897
                        &ri);
  
  delete_handler =
    gtk_signal_connect (GTK_OBJECT (dialog),
                        "delete_event",
                        GTK_SIGNAL_FUNC (run_delete_handler),
                        &ri);
  
  ri.loop = g_main_new (FALSE);

898
  GDK_THREADS_LEAVE ();  
899
  g_main_loop_run (ri.loop);
900
  GDK_THREADS_ENTER ();  
901 902 903 904

  g_main_loop_unref (ri.loop);

  ri.loop = NULL;
905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
  
  if (!GTK_OBJECT_DESTROYED (dialog))
    {
      if (!was_modal)
        gtk_window_set_modal (GTK_WINDOW(dialog), FALSE);
      
      gtk_signal_disconnect (GTK_OBJECT (dialog), destroy_handler);
      gtk_signal_disconnect (GTK_OBJECT (dialog), response_handler);
      gtk_signal_disconnect (GTK_OBJECT (dialog), delete_handler);
    }

  gtk_object_unref (GTK_OBJECT (dialog));

  return ri.response_id;
}