gtkmessagedialog.c 32.7 KB
Newer Older
1
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 2 -*- */
Cody Russell's avatar
Cody Russell committed
2
/* GTK - The GIMP Toolkit
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 * Copyright (C) 2000 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

/*
22
 * Modified by the GTK+ Team and others 1997-2003.  See the AUTHORS
23 24 25 26 27
 * 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/. 
 */

28
#include "config.h"
29 30
#include <string.h>

31
#include "gtkmessagedialog.h"
Matthias Clasen's avatar
Matthias Clasen committed
32
#include "gtkaccessible.h"
33
#include "gtkbuildable.h"
34 35
#include "gtklabel.h"
#include "gtkhbox.h"
36
#include "gtkvbox.h"
37 38 39
#include "gtkimage.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
40
#include "gtkintl.h"
41
#include "gtkprivate.h"
42

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
/**
 * SECTION:gtkmessagedialog
 * @Short_description: A convenient message window
 * @Title: GtkMessageDialog
 * @See_also:#GtkDialog
 *
 * #GtkMessageDialog presents a dialog with an image representing the type of
 * message (Error, Question, etc.) alongside some message text. It's simply a
 * convenience widget; you could construct the equivalent of #GtkMessageDialog
 * from #GtkDialog without too much effort, but #GtkMessageDialog saves typing.
 *
 * The easiest way to do a modal message dialog is to use gtk_dialog_run(), though
 * you can also pass in the %GTK_DIALOG_MODAL flag, gtk_dialog_run() automatically
 * makes the dialog modal and waits for the user to respond to it. gtk_dialog_run()
 * returns when any dialog button is clicked.
 * <example>
 * <title>A modal dialog.</title>
 * <programlisting>
 *  dialog = gtk_message_dialog_new (main_application_window,
 *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
 *                                   GTK_MESSAGE_ERROR,
 *                                   GTK_BUTTONS_CLOSE,
 *                                   "Error loading file '&percnt;s': &percnt;s",
 *                                   filename, g_strerror (errno));
 *  gtk_dialog_run (GTK_DIALOG (dialog));
 *  gtk_widget_destroy (dialog);
 * </programlisting>
 * </example>
 * You might do a non-modal #GtkMessageDialog as follows:
 * <example>
 * <title>A non-modal dialog.</title>
 * <programlisting>
 *  dialog = gtk_message_dialog_new (main_application_window,
 *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
 *                                   GTK_MESSAGE_ERROR,
 *                                   GTK_BUTTONS_CLOSE,
 *                                   "Error loading file '&percnt;s': &percnt;s",
 *                                   filename, g_strerror (errno));
 *
 *  /&ast; Destroy the dialog when the user responds to it (e.g. clicks a button) &ast;/
 *  g_signal_connect_swapped (dialog, "response",
 *                            G_CALLBACK (gtk_widget_destroy),
 *                            dialog);
 * </programlisting>
 * </example>
88 89 90 91 92 93 94 95
 *
 * <refsect2 id="GtkMessageDialog-BUILDER-UI">
 * <title>GtkMessageDialog as GtkBuildable</title>
 * <para>
 * The GtkMessageDialog implementation of the GtkBuildable interface exposes
 * the message area as an internal child with the name "message_area".
 * </para>
 * </refsect2>
96 97
 */

98
struct _GtkMessageDialogPriv
99
{
100 101 102 103 104 105 106 107
  GtkWidget     *image;
  GtkWidget     *label;
  GtkWidget     *message_area; /* vbox for the primary and secondary labels, and any extra content from the caller */
  GtkWidget     *secondary_label;

  guint          has_primary_markup : 1;
  guint          has_secondary_text : 1;
  guint          message_type       : 3;
108 109
};

110 111
static void gtk_message_dialog_style_set  (GtkWidget             *widget,
                                           GtkStyle              *prev_style);
112

113 114 115 116 117 118 119 120 121 122
static void gtk_message_dialog_set_property (GObject          *object,
					     guint             prop_id,
					     const GValue     *value,
					     GParamSpec       *pspec);
static void gtk_message_dialog_get_property (GObject          *object,
					     guint             prop_id,
					     GValue           *value,
					     GParamSpec       *pspec);
static void gtk_message_dialog_add_buttons  (GtkMessageDialog *message_dialog,
					     GtkButtonsType    buttons);
123 124 125 126 127
static void      gtk_message_dialog_buildable_interface_init     (GtkBuildableIface *iface);
static GObject * gtk_message_dialog_buildable_get_internal_child (GtkBuildable  *buildable,
                                                                  GtkBuilder    *builder,
                                                                  const gchar   *childname);

128 129 130 131

enum {
  PROP_0,
  PROP_MESSAGE_TYPE,
132 133 134 135
  PROP_BUTTONS,
  PROP_TEXT,
  PROP_USE_MARKUP,
  PROP_SECONDARY_TEXT,
Matthias Clasen's avatar
Matthias Clasen committed
136
  PROP_SECONDARY_USE_MARKUP,
137 138
  PROP_IMAGE,
  PROP_MESSAGE_AREA
139 140
};

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
G_DEFINE_TYPE_WITH_CODE (GtkMessageDialog, gtk_message_dialog, GTK_TYPE_DIALOG,
                         G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
                                                gtk_message_dialog_buildable_interface_init))

static GtkBuildableIface *parent_buildable_iface;

static void
gtk_message_dialog_buildable_interface_init (GtkBuildableIface *iface)
{
  parent_buildable_iface = g_type_interface_peek_parent (iface);
  iface->get_internal_child = gtk_message_dialog_buildable_get_internal_child;
  iface->custom_tag_start = parent_buildable_iface->custom_tag_start;
  iface->custom_finished = parent_buildable_iface->custom_finished;
}

static GObject *
gtk_message_dialog_buildable_get_internal_child (GtkBuildable *buildable,
                                                 GtkBuilder   *builder,
                                                 const gchar  *childname)
{
  if (strcmp (childname, "message_area") == 0)
    return G_OBJECT (gtk_message_dialog_get_message_area (GTK_MESSAGE_DIALOG (buildable)));

  return parent_buildable_iface->get_internal_child (buildable, builder, childname);
}

167 168 169 170

static void
gtk_message_dialog_class_init (GtkMessageDialogClass *class)
{
171
  GtkWidgetClass *widget_class;
172
  GObjectClass *gobject_class;
173 174

  widget_class = GTK_WIDGET_CLASS (class);
175
  gobject_class = G_OBJECT_CLASS (class);
176 177
  
  widget_class->style_set = gtk_message_dialog_style_set;
178 179 180

  gobject_class->set_property = gtk_message_dialog_set_property;
  gobject_class->get_property = gtk_message_dialog_get_property;
181 182
  
  gtk_widget_class_install_style_property (widget_class,
183
					   g_param_spec_int ("message-border",
184 185
                                                             P_("Image/label border"),
                                                             P_("Width of border around the label and image in the message dialog"),
186 187
                                                             0,
                                                             G_MAXINT,
188
                                                             12,
189
                                                             GTK_PARAM_READABLE));
190
  /**
Matthias Clasen's avatar
Matthias Clasen committed
191
   * GtkMessageDialog:use-separator:
192 193 194 195 196 197
   *
   * Whether to draw a separator line between the message label and the buttons
   * in the dialog.
   *
   * Since: 2.4
   */
Federico Mena Quintero's avatar
Federico Mena Quintero committed
198
  gtk_widget_class_install_style_property (widget_class,
199
					   g_param_spec_boolean ("use-separator",
Federico Mena Quintero's avatar
Federico Mena Quintero committed
200 201 202
								 P_("Use separator"),
								 P_("Whether to put a separator between the message dialog's text and the buttons"),
								 FALSE,
203
								 GTK_PARAM_READABLE));
Matthias Clasen's avatar
Matthias Clasen committed
204 205 206 207 208 209 210
  /**
   * GtkMessageDialog:message-type:
   *
   * The type of the message. The type is used to determine
   * the image that is shown in the dialog, unless the image is 
   * explicitly set by the ::image property.
   */
211 212
  g_object_class_install_property (gobject_class,
                                   PROP_MESSAGE_TYPE,
213
                                   g_param_spec_enum ("message-type",
214 215
						      P_("Message Type"),
						      P_("The type of message"),
216 217
						      GTK_TYPE_MESSAGE_TYPE,
                                                      GTK_MESSAGE_INFO,
218
                                                      GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
219 220 221
  g_object_class_install_property (gobject_class,
                                   PROP_BUTTONS,
                                   g_param_spec_enum ("buttons",
222 223
						      P_("Message Buttons"),
						      P_("The buttons shown in the message dialog"),
224 225
						      GTK_TYPE_BUTTONS_TYPE,
                                                      GTK_BUTTONS_NONE,
226
                                                      GTK_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
227 228 229 230 231 232 233 234 235 236 237 238 239 240

  /**
   * GtkMessageDialog:text:
   * 
   * The primary text of the message dialog. If the dialog has 
   * a secondary text, this will appear as the title.
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
                                   PROP_TEXT,
                                   g_param_spec_string ("text",
                                                        P_("Text"),
                                                        P_("The primary text of the message dialog"),
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 287 288 289 290
                                                        GTK_PARAM_READWRITE));

  /**
   * GtkMessageDialog:use-markup:
   * 
   * %TRUE if the primary text of the dialog includes Pango markup. 
   * See pango_parse_markup(). 
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
				   PROP_USE_MARKUP,
				   g_param_spec_boolean ("use-markup",
							 P_("Use Markup"),
							 P_("The primary text of the title includes Pango markup."),
							 FALSE,
							 GTK_PARAM_READWRITE));
  
  /**
   * GtkMessageDialog:secondary-text:
   * 
   * The secondary text of the message dialog. 
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
                                   PROP_SECONDARY_TEXT,
                                   g_param_spec_string ("secondary-text",
                                                        P_("Secondary Text"),
                                                        P_("The secondary text of the message dialog"),
                                                        NULL,
                                                        GTK_PARAM_READWRITE));

  /**
   * GtkMessageDialog:secondary-use-markup:
   * 
   * %TRUE if the secondary text of the dialog includes Pango markup. 
   * See pango_parse_markup(). 
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
				   PROP_SECONDARY_USE_MARKUP,
				   g_param_spec_boolean ("secondary-use-markup",
							 P_("Use Markup in secondary"),
							 P_("The secondary text includes Pango markup."),
							 FALSE,
							 GTK_PARAM_READWRITE));

Matthias Clasen's avatar
Matthias Clasen committed
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
  /**
   * GtkMessageDialog:image:
   * 
   * The image for this dialog.
   *
   * Since: 2.10
   */
  g_object_class_install_property (gobject_class,
                                   PROP_IMAGE,
                                   g_param_spec_object ("image",
                                                        P_("Image"),
                                                        P_("The image"),
                                                        GTK_TYPE_WIDGET,
                                                        GTK_PARAM_READWRITE));

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
  /**
   * GtkMessageDialog:message-area
   *
   * The #GtkVBox that corresponds to the message area of this dialog.  See
   * gtk_message_dialog_get_message_area() for a detailed description of this
   * area.
   *
   * Since: 2.22
   */
  g_object_class_install_property (gobject_class,
				   PROP_MESSAGE_AREA,
				   g_param_spec_object ("message-area",
							P_("Message area"),
							P_("GtkVBox that holds the dialog's primary and secondary labels"),
							GTK_TYPE_WIDGET,
							GTK_PARAM_READABLE));

323
  g_type_class_add_private (gobject_class, sizeof (GtkMessageDialogPriv));
324 325 326 327 328
}

static void
gtk_message_dialog_init (GtkMessageDialog *dialog)
{
Javier Jardón's avatar
Javier Jardón committed
329
  GtkWidget *hbox;
330 331
  GtkDialog *message_dialog = GTK_DIALOG (dialog);
  GtkWidget *action_area, *content_area;
332
  GtkMessageDialogPriv *priv;
333

334 335 336 337
  dialog->priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
                                              GTK_TYPE_MESSAGE_DIALOG,
                                              GtkMessageDialogPriv);
  priv = dialog->priv;
338

339 340 341
  content_area = gtk_dialog_get_content_area (message_dialog);
  action_area = gtk_dialog_get_action_area (message_dialog);

342
  gtk_window_set_resizable (GTK_WINDOW (dialog), FALSE);
343 344
  gtk_window_set_title (GTK_WINDOW (dialog), "");
  gtk_window_set_skip_taskbar_hint (GTK_WINDOW (dialog), TRUE);
345 346 347 348

  priv->has_primary_markup = FALSE;
  priv->has_secondary_text = FALSE;
  priv->secondary_label = gtk_label_new (NULL);
349
  gtk_widget_set_no_show_all (priv->secondary_label, TRUE);
350 351 352 353

  priv->label = gtk_label_new (NULL);
  priv->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
  gtk_misc_set_alignment (GTK_MISC (priv->image), 0.5, 0.0);
354
  
355 356 357
  gtk_label_set_line_wrap  (GTK_LABEL (priv->label), TRUE);
  gtk_label_set_selectable (GTK_LABEL (priv->label), TRUE);
  gtk_misc_set_alignment   (GTK_MISC  (priv->label), 0.0, 0.0);
Havoc Pennington's avatar
Havoc Pennington committed
358
  
359 360 361 362 363
  gtk_label_set_line_wrap  (GTK_LABEL (priv->secondary_label), TRUE);
  gtk_label_set_selectable (GTK_LABEL (priv->secondary_label), TRUE);
  gtk_misc_set_alignment   (GTK_MISC  (priv->secondary_label), 0.0, 0.0);

  hbox = gtk_hbox_new (FALSE, 12);
364
  priv->message_area = gtk_vbox_new (FALSE, 12);
365

366
  gtk_box_pack_start (GTK_BOX (priv->message_area), priv->label,
367 368
                      FALSE, FALSE, 0);

369
  gtk_box_pack_start (GTK_BOX (priv->message_area), priv->secondary_label,
370
                      TRUE, TRUE, 0);
371

372
  gtk_box_pack_start (GTK_BOX (hbox), priv->image,
373
                      FALSE, FALSE, 0);
374

375
  gtk_box_pack_start (GTK_BOX (hbox), priv->message_area,
376
                      TRUE, TRUE, 0);
377

378
  gtk_box_pack_start (GTK_BOX (content_area),
379
                      hbox,
380
                      FALSE, FALSE, 0);
381

382 383
  gtk_container_set_border_width (GTK_CONTAINER (dialog), 5);
  gtk_container_set_border_width (GTK_CONTAINER (hbox), 5);
384 385 386
  gtk_box_set_spacing (GTK_BOX (content_area), 14); /* 14 + 2 * 5 = 24 */
  gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
  gtk_box_set_spacing (GTK_BOX (action_area), 6);
387

388
  gtk_widget_show_all (hbox);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
389 390

  _gtk_dialog_set_ignore_separator (GTK_DIALOG (dialog), TRUE);
391 392
}

393 394 395
static void
setup_primary_label_font (GtkMessageDialog *dialog)
{
396
  GtkMessageDialogPriv *priv = dialog->priv;
397 398 399 400
  gint size;
  PangoFontDescription *font_desc;

  /* unset the font settings */
401
  gtk_widget_modify_font (priv->label, NULL);
402

403
  if (priv->has_secondary_text && !priv->has_primary_markup)
404
    {
405
      size = pango_font_description_get_size (gtk_widget_get_style (priv->label)->font_desc);
406 407 408
      font_desc = pango_font_description_new ();
      pango_font_description_set_weight (font_desc, PANGO_WEIGHT_BOLD);
      pango_font_description_set_size (font_desc, size * PANGO_SCALE_LARGE);
409
      gtk_widget_modify_font (priv->label, font_desc);
410
      pango_font_description_free (font_desc);
411 412 413
    }
}

414 415 416 417
static void
setup_type (GtkMessageDialog *dialog,
	    GtkMessageType    type)
{
418
  GtkMessageDialogPriv *priv = dialog->priv;
419
  const gchar *stock_id = NULL;
Matthias Clasen's avatar
Matthias Clasen committed
420
  AtkObject *atk_obj;
Matthias Clasen's avatar
Matthias Clasen committed
421 422 423
 
  priv->message_type = type;

424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
  switch (type)
    {
    case GTK_MESSAGE_INFO:
      stock_id = GTK_STOCK_DIALOG_INFO;
      break;

    case GTK_MESSAGE_QUESTION:
      stock_id = GTK_STOCK_DIALOG_QUESTION;
      break;

    case GTK_MESSAGE_WARNING:
      stock_id = GTK_STOCK_DIALOG_WARNING;
      break;
      
    case GTK_MESSAGE_ERROR:
      stock_id = GTK_STOCK_DIALOG_ERROR;
      break;
441

Matthias Clasen's avatar
Matthias Clasen committed
442 443 444
    case GTK_MESSAGE_OTHER:
      break;

445
    default:
446
      g_warning ("Unknown GtkMessageType %u", type);
447 448 449
      break;
    }

Matthias Clasen's avatar
Matthias Clasen committed
450
  if (stock_id)
451
    gtk_image_set_from_stock (GTK_IMAGE (priv->image), stock_id,
452
                              GTK_ICON_SIZE_DIALOG);
Matthias Clasen's avatar
Matthias Clasen committed
453 454 455 456 457 458 459 460 461 462 463 464 465
      
  atk_obj = gtk_widget_get_accessible (GTK_WIDGET (dialog));
  if (GTK_IS_ACCESSIBLE (atk_obj))
    {
      atk_object_set_role (atk_obj, ATK_ROLE_ALERT);
      if (stock_id)
        {
          GtkStockItem item;

          gtk_stock_lookup (stock_id, &item);
          atk_object_set_name (atk_obj, item.label);
        }
    }
466 467
}

468 469 470 471 472 473
static void 
gtk_message_dialog_set_property (GObject      *object,
				 guint         prop_id,
				 const GValue *value,
				 GParamSpec   *pspec)
{
474 475
  GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (object);
  GtkMessageDialogPriv *priv = dialog->priv;
476

477 478 479 480 481 482 483 484
  switch (prop_id)
    {
    case PROP_MESSAGE_TYPE:
      setup_type (dialog, g_value_get_enum (value));
      break;
    case PROP_BUTTONS:
      gtk_message_dialog_add_buttons (dialog, g_value_get_enum (value));
      break;
485 486
    case PROP_TEXT:
      if (priv->has_primary_markup)
487
	gtk_label_set_markup (GTK_LABEL (priv->label),
488 489
			      g_value_get_string (value));
      else
490
	gtk_label_set_text (GTK_LABEL (priv->label),
491 492 493
			    g_value_get_string (value));
      break;
    case PROP_USE_MARKUP:
Matthias Clasen's avatar
Matthias Clasen committed
494
      priv->has_primary_markup = g_value_get_boolean (value) != FALSE;
495
      gtk_label_set_use_markup (GTK_LABEL (priv->label),
496 497 498 499 500 501
				priv->has_primary_markup);
      setup_primary_label_font (dialog);
      break;
    case PROP_SECONDARY_TEXT:
      {
	const gchar *txt = g_value_get_string (value);
502

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524
	if (gtk_label_get_use_markup (GTK_LABEL (priv->secondary_label)))
	  gtk_label_set_markup (GTK_LABEL (priv->secondary_label), txt);
	else
	  gtk_label_set_text (GTK_LABEL (priv->secondary_label), txt);

	if (txt)
	  {
	    priv->has_secondary_text = TRUE;
	    gtk_widget_show (priv->secondary_label);
	  }
	else
	  {
	    priv->has_secondary_text = FALSE;
	    gtk_widget_hide (priv->secondary_label);
	  }
	setup_primary_label_font (dialog);
      }
      break;
    case PROP_SECONDARY_USE_MARKUP:
      gtk_label_set_use_markup (GTK_LABEL (priv->secondary_label), 
				g_value_get_boolean (value));
      break;
Matthias Clasen's avatar
Matthias Clasen committed
525
    case PROP_IMAGE:
526
      gtk_message_dialog_set_image (dialog, g_value_get_object (value));
Matthias Clasen's avatar
Matthias Clasen committed
527 528
      break;

529 530 531 532 533 534 535 536 537 538 539 540
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

static void 
gtk_message_dialog_get_property (GObject     *object,
				 guint        prop_id,
				 GValue      *value,
				 GParamSpec  *pspec)
{
541 542
  GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (object);
  GtkMessageDialogPriv *priv = dialog->priv;
543

544 545 546
  switch (prop_id)
    {
    case PROP_MESSAGE_TYPE:
Matthias Clasen's avatar
Matthias Clasen committed
547
      g_value_set_enum (value, (GtkMessageType) priv->message_type);
548
      break;
549
    case PROP_TEXT:
550
      g_value_set_string (value, gtk_label_get_label (GTK_LABEL (priv->label)));
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
      break;
    case PROP_USE_MARKUP:
      g_value_set_boolean (value, priv->has_primary_markup);
      break;
    case PROP_SECONDARY_TEXT:
      if (priv->has_secondary_text)
      g_value_set_string (value, 
			  gtk_label_get_label (GTK_LABEL (priv->secondary_label)));
      else
	g_value_set_string (value, NULL);
      break;
    case PROP_SECONDARY_USE_MARKUP:
      if (priv->has_secondary_text)
	g_value_set_boolean (value, 
			     gtk_label_get_use_markup (GTK_LABEL (priv->secondary_label)));
      else
	g_value_set_boolean (value, FALSE);
      break;
Matthias Clasen's avatar
Matthias Clasen committed
569
    case PROP_IMAGE:
570
      g_value_set_object (value, priv->image);
Matthias Clasen's avatar
Matthias Clasen committed
571
      break;
572 573 574
    case PROP_MESSAGE_AREA:
      g_value_set_object (value, priv->message_area);
      break;
575 576 577 578 579 580
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}

581 582
/**
 * gtk_message_dialog_new:
583
 * @parent: (allow-none): transient parent, or %NULL for none
584 585 586
 * @flags: flags
 * @type: type of message
 * @buttons: set of buttons to use
587
 * @message_format: (allow-none): printf()-style format string, or %NULL
588
 * @Varargs: arguments for @message_format
589
 *
590 591
 * Creates a new message dialog, which is a simple dialog with an icon
 * indicating the dialog type (error, warning, etc.) and some text the
592 593 594
 * user may want to see. When the user clicks a button a "response"
 * signal is emitted with response IDs from #GtkResponseType. See
 * #GtkDialog for more details.
595 596
 *
 * Return value: (transfer none): a new #GtkMessageDialog
597 598 599 600 601 602 603 604 605 606 607
 **/
GtkWidget*
gtk_message_dialog_new (GtkWindow     *parent,
                        GtkDialogFlags flags,
                        GtkMessageType type,
                        GtkButtonsType buttons,
                        const gchar   *message_format,
                        ...)
{
  GtkWidget *widget;
  GtkDialog *dialog;
608
  gchar* msg = NULL;
609
  va_list args;
610 611 612

  g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);

Manish Singh's avatar
Manish Singh committed
613
  widget = g_object_new (GTK_TYPE_MESSAGE_DIALOG,
614
			 "message-type", type,
Manish Singh's avatar
Manish Singh committed
615 616
			 "buttons", buttons,
			 NULL);
617 618
  dialog = GTK_DIALOG (widget);

Owen Taylor's avatar
Owen Taylor committed
619 620 621 622 623 624
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    {
      g_warning ("The GTK_DIALOG_NO_SEPARATOR flag cannot be used for GtkMessageDialog");
      flags &= ~GTK_DIALOG_NO_SEPARATOR;
    }

625 626 627
  if (message_format)
    {
      va_start (args, message_format);
Manish Singh's avatar
Manish Singh committed
628
      msg = g_strdup_vprintf (message_format, args);
629
      va_end (args);
630

631
      gtk_label_set_text (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->priv->label),
632
                          msg);
633

634 635 636 637 638 639 640 641 642 643 644 645
      g_free (msg);
    }

  if (parent != NULL)
    gtk_window_set_transient_for (GTK_WINDOW (widget),
                                  GTK_WINDOW (parent));
  
  if (flags & GTK_DIALOG_MODAL)
    gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);

  if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
    gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
646

647 648 649
  return widget;
}

650 651
/**
 * gtk_message_dialog_new_with_markup:
652
 * @parent: (allow-none): transient parent, or %NULL for none 
653 654 655
 * @flags: flags
 * @type: type of message
 * @buttons: set of buttons to use
656
 * @message_format: (allow-none): printf()-style format string, or %NULL
657 658 659 660 661 662 663 664
 * @Varargs: arguments for @message_format
 * 
 * Creates a new message dialog, which is a simple dialog with an icon
 * indicating the dialog type (error, warning, etc.) and some text which
 * is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
 * When the user clicks a button a "response" signal is emitted with
 * response IDs from #GtkResponseType. See #GtkDialog for more details.
 *
665 666 667 668 669 670 671 672 673
 * Special XML characters in the printf() arguments passed to this
 * function will automatically be escaped as necessary.
 * (See g_markup_printf_escaped() for how this is implemented.)
 * Usually this is what you want, but if you have an existing
 * Pango markup string that you want to use literally as the
 * label, then you need to use gtk_message_dialog_set_markup()
 * instead, since you can't pass the markup string either
 * as the format (it might contain '%' characters) or as a string
 * argument.
Matthias Clasen's avatar
Matthias Clasen committed
674
 * |[
675 676 677 678
 *  GtkWidget *dialog;
 *  dialog = gtk_message_dialog_new (main_application_window,
 *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
 *                                   GTK_MESSAGE_ERROR,
679
 *                                   GTK_BUTTONS_CLOSE,
680 681 682
 *                                   NULL);
 *  gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
 *                                 markup);
Matthias Clasen's avatar
Matthias Clasen committed
683
 * ]|
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
 * 
 * Return value: a new #GtkMessageDialog
 *
 * Since: 2.4
 **/
GtkWidget*
gtk_message_dialog_new_with_markup (GtkWindow     *parent,
                                    GtkDialogFlags flags,
                                    GtkMessageType type,
                                    GtkButtonsType buttons,
                                    const gchar   *message_format,
                                    ...)
{
  GtkWidget *widget;
  va_list args;
699
  gchar *msg = NULL;
700 701 702

  g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);

703
  widget = gtk_message_dialog_new (parent, flags, type, buttons, NULL);
704 705 706 707

  if (message_format)
    {
      va_start (args, message_format);
708
      msg = g_markup_vprintf_escaped (message_format, args);
709 710
      va_end (args);

711
      gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (widget), msg);
712 713 714 715 716 717 718

      g_free (msg);
    }

  return widget;
}

Matthias Clasen's avatar
Matthias Clasen committed
719 720 721 722 723 724 725 726 727 728 729 730 731
/**
 * gtk_message_dialog_set_image:
 * @dialog: a #GtkMessageDialog
 * @image: the image
 * 
 * Sets the dialog's image to @image.
 *
 * Since: 2.10
 **/
void
gtk_message_dialog_set_image (GtkMessageDialog *dialog,
			      GtkWidget        *image)
{
732
  GtkMessageDialogPriv *priv;
Matthias Clasen's avatar
Matthias Clasen committed
733 734 735
  GtkWidget *parent;

  g_return_if_fail (GTK_IS_MESSAGE_DIALOG (dialog));
736 737
  g_return_if_fail (image == NULL || GTK_IS_WIDGET (image));

738 739
  priv = dialog->priv;

740 741 742 743 744
  if (image == NULL)
    {
      image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
      gtk_misc_set_alignment (GTK_MISC (image), 0.5, 0.0);
    }
Matthias Clasen's avatar
Matthias Clasen committed
745 746

  priv->message_type = GTK_MESSAGE_OTHER;
747

748
  parent = gtk_widget_get_parent (priv->image);
Matthias Clasen's avatar
Matthias Clasen committed
749
  gtk_container_add (GTK_CONTAINER (parent), image);
750
  gtk_container_remove (GTK_CONTAINER (parent), priv->image);
Matthias Clasen's avatar
Matthias Clasen committed
751 752
  gtk_box_reorder_child (GTK_BOX (parent), image, 0);

753
  priv->image = image;
Matthias Clasen's avatar
Matthias Clasen committed
754 755 756 757

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

758 759 760 761
/**
 * gtk_message_dialog_get_image:
 * @dialog: a #GtkMessageDialog
 *
Matthias Clasen's avatar
Matthias Clasen committed
762 763
 * Gets the dialog's image.
 *
764 765 766 767 768 769 770
 * Return value: the dialog's image
 *
 * Since: 2.14
 **/
GtkWidget *
gtk_message_dialog_get_image (GtkMessageDialog *dialog)
{
771
  g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (dialog), NULL);
772

773
  return dialog->priv->image;
774 775
}

776 777 778 779 780 781 782 783 784 785 786 787 788
/**
 * gtk_message_dialog_set_markup:
 * @message_dialog: a #GtkMessageDialog
 * @str: markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
 * 
 * Sets the text of the message dialog to be @str, which is marked
 * up with the <link linkend="PangoMarkupFormat">Pango text markup
 * language</link>.
 *
 * Since: 2.4
 **/
void
gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
789
                               const gchar      *str)
790
{
791
  GtkMessageDialogPriv *priv;
792

793
  g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
794

795 796
  priv = message_dialog->priv;

797
  priv->has_primary_markup = TRUE;
798
  gtk_label_set_markup (GTK_LABEL (priv->label), str);
799 800
}

801 802 803
/**
 * gtk_message_dialog_format_secondary_text:
 * @message_dialog: a #GtkMessageDialog
804
 * @message_format: (allow-none): printf()-style format string, or %NULL
805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
 * @Varargs: arguments for @message_format
 * 
 * Sets the secondary text of the message dialog to be @message_format 
 * (with printf()-style).
 *
 * Note that setting a secondary text makes the primary text become
 * bold, unless you have provided explicit markup.
 *
 * Since: 2.6
 **/
void
gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
                                          const gchar      *message_format,
                                          ...)
{
  va_list args;
  gchar *msg = NULL;
822
  GtkMessageDialogPriv *priv;
823 824 825

  g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));

826
  priv = message_dialog->priv;
827 828 829 830 831 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

  if (message_format)
    {
      priv->has_secondary_text = TRUE;

      va_start (args, message_format);
      msg = g_strdup_vprintf (message_format, args);
      va_end (args);

      gtk_widget_show (priv->secondary_label);
      gtk_label_set_text (GTK_LABEL (priv->secondary_label), msg);

      g_free (msg);
    }
  else
    {
      priv->has_secondary_text = FALSE;
      gtk_widget_hide (priv->secondary_label);
    }

  setup_primary_label_font (message_dialog);
}

/**
 * gtk_message_dialog_format_secondary_markup:
 * @message_dialog: a #GtkMessageDialog
 * @message_format: printf()-style markup string (see 
     <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
 * @Varargs: arguments for @message_format
 * 
 * Sets the secondary text of the message dialog to be @message_format (with 
 * printf()-style), which is marked up with the 
 * <link linkend="PangoMarkupFormat">Pango text markup language</link>.
 *
 * Note that setting a secondary text makes the primary text become
 * bold, unless you have provided explicit markup.
 *
864 865 866 867
 * Due to an oversight, this function does not escape special XML characters
 * like gtk_message_dialog_new_with_markup() does. Thus, if the arguments 
 * may contain special XML characters, you should use g_markup_printf_escaped()
 * to escape it.
Matthias Clasen's avatar
Matthias Clasen committed
868

869 870
 * <informalexample><programlisting>
 * gchar *msg;
Matthias Clasen's avatar
Matthias Clasen committed
871
 *  
872 873 874 875 876
 * msg = g_markup_printf_escaped (message_format, ...);
 * gtk_message_dialog_format_secondary_markup (message_dialog, "&percnt;s", msg);
 * g_free (msg);
 * </programlisting></informalexample>
 *
877 878 879 880 881 882 883 884 885
 * Since: 2.6
 **/
void
gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
                                            const gchar      *message_format,
                                            ...)
{
  va_list args;
  gchar *msg = NULL;
886
  GtkMessageDialogPriv *priv;
887 888 889

  g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));

890
  priv = message_dialog->priv;
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913

  if (message_format)
    {
      priv->has_secondary_text = TRUE;

      va_start (args, message_format);
      msg = g_strdup_vprintf (message_format, args);
      va_end (args);

      gtk_widget_show (priv->secondary_label);
      gtk_label_set_markup (GTK_LABEL (priv->secondary_label), msg);

      g_free (msg);
    }
  else
    {
      priv->has_secondary_text = FALSE;
      gtk_widget_hide (priv->secondary_label);
    }

  setup_primary_label_font (message_dialog);
}

914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931
/**
 * gtk_message_dialog_get_message_area:
 * @message_dialog: a #GtkMessageDialog
 *
 * Return value: A #GtkVBox corresponding to the "message area" in the
 * @message_dialog.  This is the box where the dialog's primary and secondary
 * labels are packed.  You can add your own extra content to that box and it
 * will appear below those labels, on the right side of the dialog's image (or
 * on the left for right-to-left languages).  See gtk_dialog_get_content_area()
 * for the corresponding function in the parent #GtkDialog.
 *
 * Since: 2.22
 **/
GtkWidget *
gtk_message_dialog_get_message_area (GtkMessageDialog *message_dialog)
{
  g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog), NULL);

932
  return message_dialog->priv->message_area;
933 934
}

935 936 937 938 939 940
static void
gtk_message_dialog_add_buttons (GtkMessageDialog* message_dialog,
				GtkButtonsType buttons)
{
  GtkDialog* dialog = GTK_DIALOG (message_dialog);

941 942 943 944 945 946 947 948
  switch (buttons)
    {
    case GTK_BUTTONS_NONE:
      /* nothing */
      break;

    case GTK_BUTTONS_OK:
      gtk_dialog_add_button (dialog,
949
                             GTK_STOCK_OK,
950
                             GTK_RESPONSE_OK);
951 952 953 954
      break;

    case GTK_BUTTONS_CLOSE:
      gtk_dialog_add_button (dialog,
955
                             GTK_STOCK_CLOSE,
956
                             GTK_RESPONSE_CLOSE);
957 958 959 960
      break;

    case GTK_BUTTONS_CANCEL:
      gtk_dialog_add_button (dialog,
961
                             GTK_STOCK_CANCEL,
962
                             GTK_RESPONSE_CANCEL);
963 964 965 966
      break;

    case GTK_BUTTONS_YES_NO:
      gtk_dialog_add_button (dialog,
967
                             GTK_STOCK_NO,
968
                             GTK_RESPONSE_NO);
969 970 971
      gtk_dialog_add_button (dialog,
                             GTK_STOCK_YES,
                             GTK_RESPONSE_YES);
972 973 974 975
      gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
					       GTK_RESPONSE_YES,
					       GTK_RESPONSE_NO,
					       -1);
976 977 978 979
      break;

    case GTK_BUTTONS_OK_CANCEL:
      gtk_dialog_add_button (dialog,
980
                             GTK_STOCK_CANCEL,
981
                             GTK_RESPONSE_CANCEL);
982 983 984
      gtk_dialog_add_button (dialog,
                             GTK_STOCK_OK,
                             GTK_RESPONSE_OK);
985 986 987 988
      gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
					       GTK_RESPONSE_OK,
					       GTK_RESPONSE_CANCEL,
					       -1);
989 990 991 992 993
      break;
      
    default:
      g_warning ("Unknown GtkButtonsType");
      break;
994
    } 
995 996

  g_object_notify (G_OBJECT (message_dialog), "buttons");
997
}
998 999 1000 1001 1002

static void
gtk_message_dialog_style_set (GtkWidget *widget,
                              GtkStyle  *prev_style)
{
1003
  GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (widget);
Federico Mena Quintero's avatar
Federico Mena Quintero committed
1004
  gboolean use_separator;
1005 1006
  GtkWidget *parent;
  gint border_width;
1007

1008
  parent = gtk_widget_get_parent (gtk_message_dialog_get_image (dialog));
1009 1010 1011

  if (parent)
    {
1012
      gtk_widget_style_get (widget, "message-border",
1013 1014 1015
                            &border_width, NULL);
      
      gtk_container_set_border_width (GTK_CONTAINER (parent),
1016
                                      MAX (0, border_width - 7));
1017 1018
    }

Federico Mena Quintero's avatar
Federico Mena Quintero committed
1019
  gtk_widget_style_get (widget,
1020
			"use-separator", &use_separator,
Federico Mena Quintero's avatar
Federico Mena Quintero committed
1021
			NULL);
1022

Federico Mena Quintero's avatar
Federico Mena Quintero committed
1023 1024 1025 1026
  _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), FALSE);
  gtk_dialog_set_has_separator (GTK_DIALOG (widget), use_separator);
  _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), TRUE);

1027 1028
  setup_primary_label_font (dialog);

1029
  GTK_WIDGET_CLASS (gtk_message_dialog_parent_class)->style_set (widget, prev_style);
1030
}