1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 2 -*- */
2 /* GTK - The GIMP Toolkit
3 * Copyright (C) 2000 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Library General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Library General Public License for more details.
15 * You should have received a copy of the GNU Library General Public
16 * License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Boston, MA 02111-1307, USA.
22 * Modified by the GTK+ Team and others 1997-2003. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkmessagedialog.h"
37 #include "gtkiconfactory.h"
39 #include "gtkprivate.h"
42 #define GTK_MESSAGE_DIALOG_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogPrivate))
44 typedef struct _GtkMessageDialogPrivate GtkMessageDialogPrivate;
46 struct _GtkMessageDialogPrivate
48 GtkWidget *secondary_label;
49 gboolean has_primary_markup;
50 gboolean has_secondary_text;
53 static void gtk_message_dialog_class_init (GtkMessageDialogClass *klass);
54 static void gtk_message_dialog_init (GtkMessageDialog *dialog);
55 static void gtk_message_dialog_style_set (GtkWidget *widget,
56 GtkStyle *prev_style);
58 static void gtk_message_dialog_set_property (GObject *object,
62 static void gtk_message_dialog_get_property (GObject *object,
66 static void gtk_message_dialog_add_buttons (GtkMessageDialog *message_dialog,
67 GtkButtonsType buttons);
69 static void gtk_message_dialog_font_size_change (GtkWidget *widget,
79 static gpointer parent_class;
82 gtk_message_dialog_get_type (void)
84 static GType dialog_type = 0;
88 static const GTypeInfo dialog_info =
90 sizeof (GtkMessageDialogClass),
92 NULL, /* base_finalize */
93 (GClassInitFunc) gtk_message_dialog_class_init,
94 NULL, /* class_finalize */
95 NULL, /* class_data */
96 sizeof (GtkMessageDialog),
98 (GInstanceInitFunc) gtk_message_dialog_init,
101 dialog_type = g_type_register_static (GTK_TYPE_DIALOG, "GtkMessageDialog",
109 gtk_message_dialog_class_init (GtkMessageDialogClass *class)
111 GtkWidgetClass *widget_class;
112 GObjectClass *gobject_class;
114 widget_class = GTK_WIDGET_CLASS (class);
115 gobject_class = G_OBJECT_CLASS (class);
117 parent_class = g_type_class_peek_parent (class);
119 widget_class->style_set = gtk_message_dialog_style_set;
121 gobject_class->set_property = gtk_message_dialog_set_property;
122 gobject_class->get_property = gtk_message_dialog_get_property;
124 gtk_widget_class_install_style_property (widget_class,
125 g_param_spec_int ("message-border",
126 P_("Image/label border"),
127 P_("Width of border around the label and image in the message dialog"),
131 GTK_PARAM_READABLE));
133 * GtkMessageDialog::use_separator
135 * Whether to draw a separator line between the message label and the buttons
140 gtk_widget_class_install_style_property (widget_class,
141 g_param_spec_boolean ("use-separator",
143 P_("Whether to put a separator between the message dialog's text and the buttons"),
145 GTK_PARAM_READABLE));
146 g_object_class_install_property (gobject_class,
148 g_param_spec_enum ("message-type",
150 P_("The type of message"),
151 GTK_TYPE_MESSAGE_TYPE,
153 GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
154 g_object_class_install_property (gobject_class,
156 g_param_spec_enum ("buttons",
157 P_("Message Buttons"),
158 P_("The buttons shown in the message dialog"),
159 GTK_TYPE_BUTTONS_TYPE,
161 GTK_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
162 g_type_class_add_private (gobject_class,
163 sizeof (GtkMessageDialogPrivate));
167 gtk_message_dialog_init (GtkMessageDialog *dialog)
169 GtkWidget *hbox, *vbox;
170 GtkMessageDialogPrivate *priv;
172 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (dialog);
174 gtk_window_set_resizable (GTK_WINDOW (dialog), FALSE);
176 priv->has_primary_markup = FALSE;
177 priv->has_secondary_text = FALSE;
178 priv->secondary_label = gtk_label_new (NULL);
179 gtk_widget_set_no_show_all (priv->secondary_label, TRUE);
181 dialog->label = gtk_label_new (NULL);
182 dialog->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
183 gtk_misc_set_alignment (GTK_MISC (dialog->image), 0.5, 0.0);
185 gtk_label_set_line_wrap (GTK_LABEL (dialog->label), TRUE);
186 gtk_label_set_selectable (GTK_LABEL (dialog->label), TRUE);
187 gtk_misc_set_alignment (GTK_MISC (dialog->label), 0.0, 0.0);
189 gtk_label_set_line_wrap (GTK_LABEL (priv->secondary_label), TRUE);
190 gtk_label_set_selectable (GTK_LABEL (priv->secondary_label), TRUE);
191 gtk_misc_set_alignment (GTK_MISC (priv->secondary_label), 0.0, 0.0);
193 hbox = gtk_hbox_new (FALSE, 12);
194 vbox = gtk_vbox_new (FALSE, 12);
196 gtk_box_pack_start (GTK_BOX (vbox), dialog->label,
199 gtk_box_pack_start (GTK_BOX (vbox), priv->secondary_label,
202 gtk_box_pack_start (GTK_BOX (hbox), dialog->image,
205 gtk_box_pack_start (GTK_BOX (hbox), vbox,
208 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
212 gtk_widget_show_all (hbox);
214 _gtk_dialog_set_ignore_separator (GTK_DIALOG (dialog), TRUE);
216 g_signal_connect (G_OBJECT (dialog), "style-set",
217 G_CALLBACK (gtk_message_dialog_font_size_change), NULL);
220 static GtkMessageType
221 gtk_message_dialog_get_message_type (GtkMessageDialog *dialog)
223 const gchar* stock_id = NULL;
225 g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (dialog), GTK_MESSAGE_INFO);
226 g_return_val_if_fail (GTK_IS_IMAGE(dialog->image), GTK_MESSAGE_INFO);
228 stock_id = GTK_IMAGE(dialog->image)->data.stock.stock_id;
230 /* Look at the stock id of the image to guess the
231 * GtkMessageType value that was used to choose it
234 if (strcmp (stock_id, GTK_STOCK_DIALOG_INFO) == 0)
235 return GTK_MESSAGE_INFO;
236 else if (strcmp (stock_id, GTK_STOCK_DIALOG_QUESTION) == 0)
237 return GTK_MESSAGE_QUESTION;
238 else if (strcmp (stock_id, GTK_STOCK_DIALOG_WARNING) == 0)
239 return GTK_MESSAGE_WARNING;
240 else if (strcmp (stock_id, GTK_STOCK_DIALOG_ERROR) == 0)
241 return GTK_MESSAGE_ERROR;
244 g_assert_not_reached ();
245 return GTK_MESSAGE_INFO;
250 setup_primary_label_font (GtkMessageDialog *dialog)
253 PangoFontDescription *font_desc;
254 GtkMessageDialogPrivate *priv;
256 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (dialog);
258 if (priv->has_primary_markup)
261 /* unset the font settings */
262 gtk_widget_modify_font (dialog->label, NULL);
264 if (priv->has_secondary_text)
266 size = pango_font_description_get_size (dialog->label->style->font_desc);
267 font_desc = pango_font_description_new ();
268 pango_font_description_set_weight (font_desc, PANGO_WEIGHT_BOLD);
269 pango_font_description_set_size (font_desc, size * PANGO_SCALE_LARGE);
270 gtk_widget_modify_font (dialog->label, font_desc);
271 pango_font_description_free (font_desc);
276 setup_type (GtkMessageDialog *dialog,
279 const gchar *stock_id = NULL;
284 case GTK_MESSAGE_INFO:
285 stock_id = GTK_STOCK_DIALOG_INFO;
288 case GTK_MESSAGE_QUESTION:
289 stock_id = GTK_STOCK_DIALOG_QUESTION;
292 case GTK_MESSAGE_WARNING:
293 stock_id = GTK_STOCK_DIALOG_WARNING;
296 case GTK_MESSAGE_ERROR:
297 stock_id = GTK_STOCK_DIALOG_ERROR;
301 g_warning ("Unknown GtkMessageType %d", type);
305 if (stock_id == NULL)
306 stock_id = GTK_STOCK_DIALOG_INFO;
308 if (gtk_stock_lookup (stock_id, &item))
310 gtk_image_set_from_stock (GTK_IMAGE (dialog->image), stock_id,
311 GTK_ICON_SIZE_DIALOG);
313 gtk_window_set_title (GTK_WINDOW (dialog), item.label);
316 g_warning ("Stock dialog ID doesn't exist?");
320 gtk_message_dialog_set_property (GObject *object,
325 GtkMessageDialog *dialog;
327 dialog = GTK_MESSAGE_DIALOG (object);
331 case PROP_MESSAGE_TYPE:
332 setup_type (dialog, g_value_get_enum (value));
335 gtk_message_dialog_add_buttons (dialog, g_value_get_enum (value));
338 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
344 gtk_message_dialog_get_property (GObject *object,
349 GtkMessageDialog *dialog;
351 dialog = GTK_MESSAGE_DIALOG (object);
355 case PROP_MESSAGE_TYPE:
356 g_value_set_enum (value, gtk_message_dialog_get_message_type (dialog));
359 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
365 gtk_message_dialog_font_size_change (GtkWidget *widget,
366 GtkStyle *prev_style,
369 setup_primary_label_font (GTK_MESSAGE_DIALOG (widget));
374 * gtk_message_dialog_new:
375 * @parent: transient parent, or NULL for none
377 * @type: type of message
378 * @buttons: set of buttons to use
379 * @message_format: printf()-style format string, or NULL
380 * @Varargs: arguments for @message_format
382 * Creates a new message dialog, which is a simple dialog with an icon
383 * indicating the dialog type (error, warning, etc.) and some text the
384 * user may want to see. When the user clicks a button a "response"
385 * signal is emitted with response IDs from #GtkResponseType. See
386 * #GtkDialog for more details.
388 * Return value: a new #GtkMessageDialog
391 gtk_message_dialog_new (GtkWindow *parent,
392 GtkDialogFlags flags,
394 GtkButtonsType buttons,
395 const gchar *message_format,
403 g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
405 widget = g_object_new (GTK_TYPE_MESSAGE_DIALOG,
406 "message_type", type,
409 dialog = GTK_DIALOG (widget);
411 if (flags & GTK_DIALOG_NO_SEPARATOR)
413 g_warning ("The GTK_DIALOG_NO_SEPARATOR flag cannot be used for GtkMessageDialog");
414 flags &= ~GTK_DIALOG_NO_SEPARATOR;
419 va_start (args, message_format);
420 msg = g_strdup_vprintf (message_format, args);
423 gtk_label_set_text (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->label),
430 gtk_window_set_transient_for (GTK_WINDOW (widget),
431 GTK_WINDOW (parent));
433 if (flags & GTK_DIALOG_MODAL)
434 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
436 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
437 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
439 if (flags & GTK_DIALOG_NO_SEPARATOR)
440 gtk_dialog_set_has_separator (dialog, FALSE);
446 * gtk_message_dialog_new_with_markup:
447 * @parent: transient parent, or %NULL for none
449 * @type: type of message
450 * @buttons: set of buttons to use
451 * @message_format: printf()-style format string, or %NULL
452 * @Varargs: arguments for @message_format
454 * Creates a new message dialog, which is a simple dialog with an icon
455 * indicating the dialog type (error, warning, etc.) and some text which
456 * is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
457 * When the user clicks a button a "response" signal is emitted with
458 * response IDs from #GtkResponseType. See #GtkDialog for more details.
460 * Special XML characters in the printf() arguments passed to this
461 * function will automatically be escaped as necessary.
462 * (See g_markup_printf_escaped() for how this is implemented.)
463 * Usually this is what you want, but if you have an existing
464 * Pango markup string that you want to use literally as the
465 * label, then you need to use gtk_message_dialog_set_markup()
466 * instead, since you can't pass the markup string either
467 * as the format (it might contain '%' characters) or as a string
470 * <informalexample><programlisting>
472 * dialog = gtk_message_dialog_new (main_application_window,
473 * GTK_DIALOG_DESTROY_WITH_PARENT,
477 * gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
479 * </programlisting></informalexample>
481 * Return value: a new #GtkMessageDialog
486 gtk_message_dialog_new_with_markup (GtkWindow *parent,
487 GtkDialogFlags flags,
489 GtkButtonsType buttons,
490 const gchar *message_format,
497 g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
499 widget = gtk_message_dialog_new (parent, flags, type, buttons, NULL);
503 va_start (args, message_format);
504 msg = g_markup_vprintf_escaped (message_format, args);
507 gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (widget), msg);
516 * gtk_message_dialog_set_markup:
517 * @message_dialog: a #GtkMessageDialog
518 * @str: markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
520 * Sets the text of the message dialog to be @str, which is marked
521 * up with the <link linkend="PangoMarkupFormat">Pango text markup
527 gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
530 GtkMessageDialogPrivate *priv;
532 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
534 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
535 priv->has_primary_markup = TRUE;
536 gtk_label_set_markup (GTK_LABEL (message_dialog->label), str);
540 * gtk_message_dialog_format_secondary_text:
541 * @message_dialog: a #GtkMessageDialog
542 * @message_format: printf()-style format string, or %NULL
543 * @Varargs: arguments for @message_format
545 * Sets the secondary text of the message dialog to be @message_format
546 * (with printf()-style).
548 * Note that setting a secondary text makes the primary text become
549 * bold, unless you have provided explicit markup.
554 gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
555 const gchar *message_format,
560 GtkMessageDialogPrivate *priv;
562 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
564 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
568 priv->has_secondary_text = TRUE;
570 va_start (args, message_format);
571 msg = g_strdup_vprintf (message_format, args);
574 gtk_widget_show (priv->secondary_label);
575 gtk_label_set_text (GTK_LABEL (priv->secondary_label), msg);
581 priv->has_secondary_text = FALSE;
582 gtk_widget_hide (priv->secondary_label);
585 setup_primary_label_font (message_dialog);
589 * gtk_message_dialog_format_secondary_markup:
590 * @message_dialog: a #GtkMessageDialog
591 * @message_format: printf()-style markup string (see
592 <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
593 * @Varargs: arguments for @message_format
595 * Sets the secondary text of the message dialog to be @message_format (with
596 * printf()-style), which is marked up with the
597 * <link linkend="PangoMarkupFormat">Pango text markup language</link>.
599 * Note that setting a secondary text makes the primary text become
600 * bold, unless you have provided explicit markup.
605 gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
606 const gchar *message_format,
611 GtkMessageDialogPrivate *priv;
613 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
615 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
619 priv->has_secondary_text = TRUE;
621 va_start (args, message_format);
622 msg = g_strdup_vprintf (message_format, args);
625 gtk_widget_show (priv->secondary_label);
626 gtk_label_set_markup (GTK_LABEL (priv->secondary_label), msg);
632 priv->has_secondary_text = FALSE;
633 gtk_widget_hide (priv->secondary_label);
636 setup_primary_label_font (message_dialog);
640 gtk_message_dialog_add_buttons (GtkMessageDialog* message_dialog,
641 GtkButtonsType buttons)
643 GtkDialog* dialog = GTK_DIALOG (message_dialog);
647 case GTK_BUTTONS_NONE:
652 gtk_dialog_add_button (dialog,
657 case GTK_BUTTONS_CLOSE:
658 gtk_dialog_add_button (dialog,
663 case GTK_BUTTONS_CANCEL:
664 gtk_dialog_add_button (dialog,
666 GTK_RESPONSE_CANCEL);
669 case GTK_BUTTONS_YES_NO:
670 gtk_dialog_add_button (dialog,
673 gtk_dialog_add_button (dialog,
676 gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
682 case GTK_BUTTONS_OK_CANCEL:
683 gtk_dialog_add_button (dialog,
685 GTK_RESPONSE_CANCEL);
686 gtk_dialog_add_button (dialog,
689 gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
696 g_warning ("Unknown GtkButtonsType");
700 g_object_notify (G_OBJECT (message_dialog), "buttons");
704 gtk_message_dialog_style_set (GtkWidget *widget,
705 GtkStyle *prev_style)
708 gint border_width = 0;
709 gboolean use_separator;
711 parent = GTK_WIDGET (GTK_MESSAGE_DIALOG (widget)->image->parent);
715 gtk_widget_style_get (widget, "message_border",
716 &border_width, NULL);
718 gtk_container_set_border_width (GTK_CONTAINER (parent),
722 gtk_widget_style_get (widget,
723 "use_separator", &use_separator,
725 _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), FALSE);
726 gtk_dialog_set_has_separator (GTK_DIALOG (widget), use_separator);
727 _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), TRUE);
729 if (GTK_WIDGET_CLASS (parent_class)->style_set)
730 (GTK_WIDGET_CLASS (parent_class)->style_set) (widget, prev_style);
733 #define __GTK_MESSAGE_DIALOG_C__
734 #include "gtkaliasdef.c"