gtkmessagedialog.c 15 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* GTK - The GIMP Toolkit
 * 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.
 */

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

#include "gtkmessagedialog.h"
#include "gtklabel.h"
#include "gtkhbox.h"
#include "gtkimage.h"
#include "gtkstock.h"
#include "gtkiconfactory.h"
33
#include "gtkintl.h"
34
#include <string.h>
35 36 37

static void gtk_message_dialog_class_init (GtkMessageDialogClass *klass);
static void gtk_message_dialog_init       (GtkMessageDialog      *dialog);
38 39
static void gtk_message_dialog_style_set  (GtkWidget             *widget,
                                           GtkStyle              *prev_style);
40

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
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);


enum {
  PROP_0,
  PROP_MESSAGE_TYPE,
  PROP_BUTTONS
};

59
static gpointer parent_class;
60

Manish Singh's avatar
Manish Singh committed
61
GType
62 63
gtk_message_dialog_get_type (void)
{
Manish Singh's avatar
Manish Singh committed
64
  static GType dialog_type = 0;
65 66 67

  if (!dialog_type)
    {
Manish Singh's avatar
Manish Singh committed
68
      static const GTypeInfo dialog_info =
69 70
      {
	sizeof (GtkMessageDialogClass),
Manish Singh's avatar
Manish Singh committed
71 72 73 74 75 76 77 78
	NULL,		/* base_init */
	NULL,		/* base_finalize */
	(GClassInitFunc) gtk_message_dialog_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	sizeof (GtkMessageDialog),
	0,		/* n_preallocs */
	(GInstanceInitFunc) gtk_message_dialog_init,
79 80
      };

Manish Singh's avatar
Manish Singh committed
81 82
      dialog_type = g_type_register_static (GTK_TYPE_DIALOG, "GtkMessageDialog",
					    &dialog_info, 0);
83 84 85 86 87 88 89 90
    }

  return dialog_type;
}

static void
gtk_message_dialog_class_init (GtkMessageDialogClass *class)
{
91
  GtkWidgetClass *widget_class;
92
  GObjectClass *gobject_class;
93 94

  widget_class = GTK_WIDGET_CLASS (class);
95
  gobject_class = G_OBJECT_CLASS (class);
96 97 98 99

  parent_class = g_type_class_peek_parent (class);
  
  widget_class->style_set = gtk_message_dialog_style_set;
100 101 102

  gobject_class->set_property = gtk_message_dialog_set_property;
  gobject_class->get_property = gtk_message_dialog_get_property;
103 104 105 106 107 108 109 110 111
  
  gtk_widget_class_install_style_property (widget_class,
					   g_param_spec_int ("message_border",
                                                             _("Image/label border"),
                                                             _("Width of border around the label and image in the message dialog"),
                                                             0,
                                                             G_MAXINT,
                                                             8,
                                                             G_PARAM_READABLE));
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
  g_object_class_install_property (gobject_class,
                                   PROP_MESSAGE_TYPE,
                                   g_param_spec_enum ("message_type",
						      _("Message Type"),
						      _("The type of message"),
						      GTK_TYPE_MESSAGE_TYPE,
                                                      GTK_MESSAGE_INFO,
                                                      G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT));
  g_object_class_install_property (gobject_class,
                                   PROP_BUTTONS,
                                   g_param_spec_enum ("buttons",
						      _("Message Buttons"),
						      _("The buttons shown in the message dialog"),
						      GTK_TYPE_BUTTONS_TYPE,
                                                      GTK_BUTTONS_NONE,
                                                      G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));

129 130 131 132 133 134 135 136 137
}

static void
gtk_message_dialog_init (GtkMessageDialog *dialog)
{
  GtkWidget *hbox;
  
  dialog->label = gtk_label_new (NULL);
  dialog->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
138
  gtk_misc_set_alignment (GTK_MISC (dialog->image), 0.5, 0.0);
139 140
  
  gtk_label_set_line_wrap (GTK_LABEL (dialog->label), TRUE);
Havoc Pennington's avatar
Havoc Pennington committed
141 142
  gtk_label_set_selectable (GTK_LABEL (dialog->label), TRUE);
  
143
  hbox = gtk_hbox_new (FALSE, 6);
144 145

  gtk_box_pack_start (GTK_BOX (hbox), dialog->image,
146
                      FALSE, FALSE, 0);
147 148

  gtk_box_pack_start (GTK_BOX (hbox), dialog->label,
149
                      TRUE, TRUE, 0);
150 151 152

  gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
                      hbox,
153
                      FALSE, FALSE, 0);
154 155 156 157

  gtk_widget_show_all (hbox);
}

158 159
static GtkMessageType
gtk_message_dialog_get_message_type (GtkMessageDialog *dialog)
160
{
161 162 163 164 165 166 167 168 169 170
  const gchar* stock_id = NULL;

  g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (dialog), GTK_MESSAGE_INFO);
  g_return_val_if_fail (GTK_IS_IMAGE(dialog->image), GTK_MESSAGE_INFO);

  stock_id = GTK_IMAGE(dialog->image)->data.stock.stock_id;

  /* Look at the stock id of the image to guess the
   * GtkMessageType value that was used to choose it
   * in setup_type()
171
   */
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190
  if (strcmp (stock_id, GTK_STOCK_DIALOG_INFO) == 0)
    return GTK_MESSAGE_INFO;
  else if (strcmp (stock_id, GTK_STOCK_DIALOG_QUESTION) == 0)
    return GTK_MESSAGE_QUESTION;
  else if (strcmp (stock_id, GTK_STOCK_DIALOG_WARNING) == 0)
    return GTK_MESSAGE_WARNING;
  else if (strcmp (stock_id, GTK_STOCK_DIALOG_ERROR) == 0)
    return GTK_MESSAGE_ERROR;
  else
    {
      g_assert_not_reached (); 
      return GTK_MESSAGE_INFO;
    }
}

static void
setup_type (GtkMessageDialog *dialog,
	    GtkMessageType    type)
{
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
  const gchar *stock_id = NULL;
  GtkStockItem item;
  
  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;
      
    default:
      g_warning ("Unknown GtkMessageType %d", type);
      break;
    }

  if (stock_id == NULL)
    stock_id = GTK_STOCK_DIALOG_INFO;

  if (gtk_stock_lookup (stock_id, &item))
    {
      gtk_image_set_from_stock (GTK_IMAGE (dialog->image), stock_id,
                                GTK_ICON_SIZE_DIALOG);
      
      gtk_window_set_title (GTK_WINDOW (dialog), item.label);
    }
  else
    g_warning ("Stock dialog ID doesn't exist?");  
}

231 232 233 234 235 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
static void 
gtk_message_dialog_set_property (GObject      *object,
				 guint         prop_id,
				 const GValue *value,
				 GParamSpec   *pspec)
{
  GtkMessageDialog *dialog;
  
  dialog = GTK_MESSAGE_DIALOG (object);
  
  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;
    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)
{
  GtkMessageDialog *dialog;
  
  dialog = GTK_MESSAGE_DIALOG (object);
  
  switch (prop_id)
    {
    case PROP_MESSAGE_TYPE:
      g_value_set_enum (value, gtk_message_dialog_get_message_type (dialog));
269
      break;
270 271 272 273 274 275 276
    default:
      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
      break;
    }
}


277 278 279 280 281 282 283 284 285 286 287
/**
 * gtk_message_dialog_new:
 * @parent: transient parent, or NULL for none 
 * @flags: flags
 * @type: type of message
 * @buttons: set of buttons to use
 * @message_format: printf()-style format string, or NULL
 * @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 the
288 289 290
 * 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.
291 292 293 294 295 296 297 298 299 300 301 302 303
 * 
 * Return value: a new #GtkMessageDialog
 **/
GtkWidget*
gtk_message_dialog_new (GtkWindow     *parent,
                        GtkDialogFlags flags,
                        GtkMessageType type,
                        GtkButtonsType buttons,
                        const gchar   *message_format,
                        ...)
{
  GtkWidget *widget;
  GtkDialog *dialog;
304
  gchar* msg = 0;
305
  va_list args;
306 307 308 309

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

Manish Singh's avatar
Manish Singh committed
310 311 312 313
  widget = g_object_new (GTK_TYPE_MESSAGE_DIALOG,
			 "message_type", type,
			 "buttons", buttons,
			 NULL);
314 315
  dialog = GTK_DIALOG (widget);

Owen Taylor's avatar
Warn  
Owen Taylor committed
316 317 318 319 320 321
  if (flags & GTK_DIALOG_NO_SEPARATOR)
    {
      g_warning ("The GTK_DIALOG_NO_SEPARATOR flag cannot be used for GtkMessageDialog");
      flags &= ~GTK_DIALOG_NO_SEPARATOR;
    }

322 323 324
  if (message_format)
    {
      va_start (args, message_format);
Manish Singh's avatar
Manish Singh committed
325
      msg = g_strdup_vprintf (message_format, args);
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
      va_end (args);
      
      
      gtk_label_set_text (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->label),
                          msg);
      
      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);
Havoc Pennington's avatar
Havoc Pennington committed
344 345 346

  if (flags & GTK_DIALOG_NO_SEPARATOR)
    gtk_dialog_set_has_separator (dialog, FALSE);
347 348 349 350

  return widget;
}

351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 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
/**
 * gtk_message_dialog_new_with_markup:
 * @parent: transient parent, or %NULL for none 
 * @flags: flags
 * @type: type of message
 * @buttons: set of buttons to use
 * @message_format: printf()-style format string, or %NULL
 * @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.
 *
 * Please note that if you have strings in the printf() arguments
 * passed to this function, you might need to protect against
 * them being interpreted as markup. You can do this using
 * g_markup_escape_text() as in the following example:
 * <informalexample><programlisting>
 *   const gchar *error_text =
 *     "&lt;span weight=\"bold\" size=\"larger\"&gt;"
 *     "Could not open document '%s'."
 *     "&lt;/span&gt;\n\n"
 *     "You do not have appropriate permission to access this file.";
 *   gchar *tmp;
 *   GtkWidget *dialog;
 *   
 *   tmp = g_markup_escape_text (filename, -1);
 *   dialog = gtk_message_dialog_new_with_markup (main_application_window,
 *                                                GTK_DIALOG_DESTROY_WITH_PARENT,
 *                                                GTK_MESSAGE_ERROR,
 *                                                GTK_BUTTONS_CLOSE,
 *                                                error_text, tmp);
 *   g_free (tmp);
 * </programlisting></informalexample>
 * 
 * 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;
  gchar* msg = 0;
  va_list args;

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

  widget = gtk_message_dialog_new (parent, flags, type, buttons, "");

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

      gtk_label_set_markup (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->label),
                            msg);

      g_free (msg);
    }

  return widget;
}

424 425 426 427 428 429
static void
gtk_message_dialog_add_buttons (GtkMessageDialog* message_dialog,
				GtkButtonsType buttons)
{
  GtkDialog* dialog = GTK_DIALOG (message_dialog);

430 431 432 433 434 435 436 437
  switch (buttons)
    {
    case GTK_BUTTONS_NONE:
      /* nothing */
      break;

    case GTK_BUTTONS_OK:
      gtk_dialog_add_button (dialog,
438
                             GTK_STOCK_OK,
439
                             GTK_RESPONSE_OK);
440 441 442 443
      break;

    case GTK_BUTTONS_CLOSE:
      gtk_dialog_add_button (dialog,
444
                             GTK_STOCK_CLOSE,
445
                             GTK_RESPONSE_CLOSE);
446 447 448 449
      break;

    case GTK_BUTTONS_CANCEL:
      gtk_dialog_add_button (dialog,
450
                             GTK_STOCK_CANCEL,
451
                             GTK_RESPONSE_CANCEL);
452 453 454 455
      break;

    case GTK_BUTTONS_YES_NO:
      gtk_dialog_add_button (dialog,
456
                             GTK_STOCK_NO,
457
                             GTK_RESPONSE_NO);
458 459 460
      gtk_dialog_add_button (dialog,
                             GTK_STOCK_YES,
                             GTK_RESPONSE_YES);
461 462 463 464
      break;

    case GTK_BUTTONS_OK_CANCEL:
      gtk_dialog_add_button (dialog,
465
                             GTK_STOCK_CANCEL,
466
                             GTK_RESPONSE_CANCEL);
467 468 469
      gtk_dialog_add_button (dialog,
                             GTK_STOCK_OK,
                             GTK_RESPONSE_OK);
470 471 472 473 474
      break;
      
    default:
      g_warning ("Unknown GtkButtonsType");
      break;
475
    } 
476 477

  g_object_notify (G_OBJECT (message_dialog), "buttons");
478
}
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

static void
gtk_message_dialog_style_set (GtkWidget *widget,
                              GtkStyle  *prev_style)
{
  GtkWidget *parent;
  gint border_width = 0;

  parent = GTK_WIDGET (GTK_MESSAGE_DIALOG (widget)->image->parent);

  if (parent)
    {
      gtk_widget_style_get (widget, "message_border",
                            &border_width, NULL);
      
      gtk_container_set_border_width (GTK_CONTAINER (parent),
                                      border_width);
    }

  if (GTK_WIDGET_CLASS (parent_class)->style_set)
    (GTK_WIDGET_CLASS (parent_class)->style_set) (widget, prev_style);
}