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/.
30 #include "gtkmessagedialog.h"
35 #include "gtkiconfactory.h"
39 #define GTK_MESSAGE_DIALOG_GET_PRIVATE(obj) (G_TYPE_INSTANCE_GET_PRIVATE ((obj), GTK_TYPE_MESSAGE_DIALOG, GtkMessageDialogPrivate))
41 typedef struct _GtkMessageDialogPrivate GtkMessageDialogPrivate;
43 struct _GtkMessageDialogPrivate
45 GtkWidget *secondary_label;
46 gboolean has_primary_markup;
47 gboolean has_secondary_text;
50 static void gtk_message_dialog_class_init (GtkMessageDialogClass *klass);
51 static void gtk_message_dialog_init (GtkMessageDialog *dialog);
52 static void gtk_message_dialog_style_set (GtkWidget *widget,
53 GtkStyle *prev_style);
55 static void gtk_message_dialog_set_property (GObject *object,
59 static void gtk_message_dialog_get_property (GObject *object,
63 static void gtk_message_dialog_add_buttons (GtkMessageDialog *message_dialog,
64 GtkButtonsType buttons);
66 static void gtk_message_dialog_font_size_change (GtkWidget *widget,
76 static gpointer parent_class;
79 gtk_message_dialog_get_type (void)
81 static GType dialog_type = 0;
85 static const GTypeInfo dialog_info =
87 sizeof (GtkMessageDialogClass),
89 NULL, /* base_finalize */
90 (GClassInitFunc) gtk_message_dialog_class_init,
91 NULL, /* class_finalize */
92 NULL, /* class_data */
93 sizeof (GtkMessageDialog),
95 (GInstanceInitFunc) gtk_message_dialog_init,
98 dialog_type = g_type_register_static (GTK_TYPE_DIALOG, "GtkMessageDialog",
106 gtk_message_dialog_class_init (GtkMessageDialogClass *class)
108 GtkWidgetClass *widget_class;
109 GObjectClass *gobject_class;
111 widget_class = GTK_WIDGET_CLASS (class);
112 gobject_class = G_OBJECT_CLASS (class);
114 parent_class = g_type_class_peek_parent (class);
116 widget_class->style_set = gtk_message_dialog_style_set;
118 gobject_class->set_property = gtk_message_dialog_set_property;
119 gobject_class->get_property = gtk_message_dialog_get_property;
121 gtk_widget_class_install_style_property (widget_class,
122 g_param_spec_int ("message_border",
123 P_("Image/label border"),
124 P_("Width of border around the label and image in the message dialog"),
130 * GtkMessageDialog::use_separator
132 * Whether to draw a separator line between the message label and the buttons
137 gtk_widget_class_install_style_property (widget_class,
138 g_param_spec_boolean ("use_separator",
140 P_("Whether to put a separator between the message dialog's text and the buttons"),
143 g_object_class_install_property (gobject_class,
145 g_param_spec_enum ("message_type",
147 P_("The type of message"),
148 GTK_TYPE_MESSAGE_TYPE,
150 G_PARAM_READABLE | G_PARAM_WRITABLE | G_PARAM_CONSTRUCT));
151 g_object_class_install_property (gobject_class,
153 g_param_spec_enum ("buttons",
154 P_("Message Buttons"),
155 P_("The buttons shown in the message dialog"),
156 GTK_TYPE_BUTTONS_TYPE,
158 G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
159 g_type_class_add_private (gobject_class,
160 sizeof (GtkMessageDialogPrivate));
164 gtk_message_dialog_init (GtkMessageDialog *dialog)
166 GtkWidget *hbox, *vbox;
167 GtkMessageDialogPrivate *priv;
169 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (dialog);
171 gtk_window_set_resizable (GTK_WINDOW (dialog), FALSE);
173 priv->has_primary_markup = FALSE;
174 priv->has_secondary_text = FALSE;
175 priv->secondary_label = gtk_label_new (NULL);
177 dialog->label = gtk_label_new (NULL);
178 dialog->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
179 gtk_misc_set_alignment (GTK_MISC (dialog->image), 0.5, 0.0);
181 gtk_label_set_line_wrap (GTK_LABEL (dialog->label), TRUE);
182 gtk_label_set_selectable (GTK_LABEL (dialog->label), TRUE);
183 gtk_misc_set_alignment (GTK_MISC (dialog->label), 0.0, 0.0);
185 gtk_label_set_line_wrap (GTK_LABEL (priv->secondary_label), TRUE);
186 gtk_label_set_selectable (GTK_LABEL (priv->secondary_label), TRUE);
187 gtk_misc_set_alignment (GTK_MISC (priv->secondary_label), 0.0, 0.0);
189 hbox = gtk_hbox_new (FALSE, 12);
190 vbox = gtk_vbox_new (FALSE, 12);
192 gtk_box_pack_start (GTK_BOX (vbox), dialog->label,
195 gtk_box_pack_start (GTK_BOX (vbox), priv->secondary_label,
198 gtk_box_pack_start (GTK_BOX (hbox), dialog->image,
201 gtk_box_pack_start (GTK_BOX (hbox), vbox,
204 gtk_box_pack_start (GTK_BOX (GTK_DIALOG (dialog)->vbox),
208 gtk_widget_show_all (hbox);
210 _gtk_dialog_set_ignore_separator (GTK_DIALOG (dialog), TRUE);
212 g_signal_connect (G_OBJECT (dialog), "style-set",
213 G_CALLBACK (gtk_message_dialog_font_size_change), NULL);
216 static GtkMessageType
217 gtk_message_dialog_get_message_type (GtkMessageDialog *dialog)
219 const gchar* stock_id = NULL;
221 g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (dialog), GTK_MESSAGE_INFO);
222 g_return_val_if_fail (GTK_IS_IMAGE(dialog->image), GTK_MESSAGE_INFO);
224 stock_id = GTK_IMAGE(dialog->image)->data.stock.stock_id;
226 /* Look at the stock id of the image to guess the
227 * GtkMessageType value that was used to choose it
230 if (strcmp (stock_id, GTK_STOCK_DIALOG_INFO) == 0)
231 return GTK_MESSAGE_INFO;
232 else if (strcmp (stock_id, GTK_STOCK_DIALOG_QUESTION) == 0)
233 return GTK_MESSAGE_QUESTION;
234 else if (strcmp (stock_id, GTK_STOCK_DIALOG_WARNING) == 0)
235 return GTK_MESSAGE_WARNING;
236 else if (strcmp (stock_id, GTK_STOCK_DIALOG_ERROR) == 0)
237 return GTK_MESSAGE_ERROR;
240 g_assert_not_reached ();
241 return GTK_MESSAGE_INFO;
246 setup_primary_label_font (GtkMessageDialog *dialog)
249 PangoFontDescription *font_desc;
250 GtkMessageDialogPrivate *priv;
252 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (dialog);
254 if (priv->has_primary_markup)
257 /* unset the font settings */
258 gtk_widget_modify_font (dialog->label, NULL);
260 if (priv->has_secondary_text)
262 size = pango_font_description_get_size (dialog->label->style->font_desc);
263 font_desc = pango_font_description_new ();
264 pango_font_description_set_weight (font_desc, PANGO_WEIGHT_BOLD);
265 pango_font_description_set_size (font_desc, size * PANGO_SCALE_LARGE);
266 gtk_widget_modify_font (dialog->label, font_desc);
271 setup_type (GtkMessageDialog *dialog,
274 const gchar *stock_id = NULL;
279 case GTK_MESSAGE_INFO:
280 stock_id = GTK_STOCK_DIALOG_INFO;
283 case GTK_MESSAGE_QUESTION:
284 stock_id = GTK_STOCK_DIALOG_QUESTION;
287 case GTK_MESSAGE_WARNING:
288 stock_id = GTK_STOCK_DIALOG_WARNING;
291 case GTK_MESSAGE_ERROR:
292 stock_id = GTK_STOCK_DIALOG_ERROR;
296 g_warning ("Unknown GtkMessageType %d", type);
300 if (stock_id == NULL)
301 stock_id = GTK_STOCK_DIALOG_INFO;
303 if (gtk_stock_lookup (stock_id, &item))
305 gtk_image_set_from_stock (GTK_IMAGE (dialog->image), stock_id,
306 GTK_ICON_SIZE_DIALOG);
308 gtk_window_set_title (GTK_WINDOW (dialog), item.label);
311 g_warning ("Stock dialog ID doesn't exist?");
315 gtk_message_dialog_set_property (GObject *object,
320 GtkMessageDialog *dialog;
322 dialog = GTK_MESSAGE_DIALOG (object);
326 case PROP_MESSAGE_TYPE:
327 setup_type (dialog, g_value_get_enum (value));
330 gtk_message_dialog_add_buttons (dialog, g_value_get_enum (value));
333 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
339 gtk_message_dialog_get_property (GObject *object,
344 GtkMessageDialog *dialog;
346 dialog = GTK_MESSAGE_DIALOG (object);
350 case PROP_MESSAGE_TYPE:
351 g_value_set_enum (value, gtk_message_dialog_get_message_type (dialog));
354 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
360 gtk_message_dialog_font_size_change (GtkWidget *widget,
361 GtkStyle *prev_style,
364 setup_primary_label_font (GTK_MESSAGE_DIALOG (widget));
369 * gtk_message_dialog_new:
370 * @parent: transient parent, or NULL for none
372 * @type: type of message
373 * @buttons: set of buttons to use
374 * @message_format: printf()-style format string, or NULL
375 * @Varargs: arguments for @message_format
377 * Creates a new message dialog, which is a simple dialog with an icon
378 * indicating the dialog type (error, warning, etc.) and some text the
379 * user may want to see. When the user clicks a button a "response"
380 * signal is emitted with response IDs from #GtkResponseType. See
381 * #GtkDialog for more details.
383 * Return value: a new #GtkMessageDialog
386 gtk_message_dialog_new (GtkWindow *parent,
387 GtkDialogFlags flags,
389 GtkButtonsType buttons,
390 const gchar *message_format,
398 g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
400 widget = g_object_new (GTK_TYPE_MESSAGE_DIALOG,
401 "message_type", type,
404 dialog = GTK_DIALOG (widget);
406 if (flags & GTK_DIALOG_NO_SEPARATOR)
408 g_warning ("The GTK_DIALOG_NO_SEPARATOR flag cannot be used for GtkMessageDialog");
409 flags &= ~GTK_DIALOG_NO_SEPARATOR;
414 va_start (args, message_format);
415 msg = g_strdup_vprintf (message_format, args);
418 gtk_label_set_text (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->label),
425 gtk_window_set_transient_for (GTK_WINDOW (widget),
426 GTK_WINDOW (parent));
428 if (flags & GTK_DIALOG_MODAL)
429 gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
431 if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
432 gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
434 if (flags & GTK_DIALOG_NO_SEPARATOR)
435 gtk_dialog_set_has_separator (dialog, FALSE);
441 * gtk_message_dialog_new_with_markup:
442 * @parent: transient parent, or %NULL for none
444 * @type: type of message
445 * @buttons: set of buttons to use
446 * @message_format: printf()-style format string, or %NULL
447 * @Varargs: arguments for @message_format
449 * Creates a new message dialog, which is a simple dialog with an icon
450 * indicating the dialog type (error, warning, etc.) and some text which
451 * is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
452 * When the user clicks a button a "response" signal is emitted with
453 * response IDs from #GtkResponseType. See #GtkDialog for more details.
455 * Special XML characters in the printf() arguments passed to this
456 * function will automatically be escaped as necessary.
457 * (See g_markup_printf_escaped() for how this is implemented.)
458 * Usually this is what you want, but if you have an existing
459 * Pango markup string that you want to use literally as the
460 * label, then you need to use gtk_message_dialog_set_markup()
461 * instead, since you can't pass the markup string either
462 * as the format (it might contain '%' characters) or as a string
465 * <informalexample><programlisting>
467 * dialog = gtk_message_dialog_new (main_application_window,
468 * GTK_DIALOG_DESTROY_WITH_PARENT,
472 * gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
474 * </programlisting></informalexample>
476 * Return value: a new #GtkMessageDialog
481 gtk_message_dialog_new_with_markup (GtkWindow *parent,
482 GtkDialogFlags flags,
484 GtkButtonsType buttons,
485 const gchar *message_format,
492 g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
494 widget = gtk_message_dialog_new (parent, flags, type, buttons, NULL);
498 va_start (args, message_format);
499 msg = g_markup_vprintf_escaped (message_format, args);
502 gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (widget), msg);
511 * gtk_message_dialog_set_markup:
512 * @message_dialog: a #GtkMessageDialog
513 * @str: markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
515 * Sets the text of the message dialog to be @str, which is marked
516 * up with the <link linkend="PangoMarkupFormat">Pango text markup
522 gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
525 GtkMessageDialogPrivate *priv;
527 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
529 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
530 priv->has_primary_markup = TRUE;
531 gtk_label_set_markup (GTK_LABEL (message_dialog->label), str);
535 * gtk_message_dialog_format_secondary_text:
536 * @message_dialog: a #GtkMessageDialog
537 * @message_format: printf()-style format string, or %NULL
538 * @Varargs: arguments for @message_format
540 * Sets the secondary text of the message dialog to be @message_format
541 * (with printf()-style).
543 * Note that setting a secondary text makes the primary text become
544 * bold, unless you have provided explicit markup.
549 gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
550 const gchar *message_format,
555 GtkMessageDialogPrivate *priv;
557 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
559 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
563 priv->has_secondary_text = TRUE;
565 va_start (args, message_format);
566 msg = g_strdup_vprintf (message_format, args);
569 gtk_widget_show (priv->secondary_label);
570 gtk_label_set_text (GTK_LABEL (priv->secondary_label), msg);
576 priv->has_secondary_text = FALSE;
577 gtk_widget_hide (priv->secondary_label);
580 setup_primary_label_font (message_dialog);
584 * gtk_message_dialog_format_secondary_markup:
585 * @message_dialog: a #GtkMessageDialog
586 * @message_format: printf()-style markup string (see
587 <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
588 * @Varargs: arguments for @message_format
590 * Sets the secondary text of the message dialog to be @message_format (with
591 * printf()-style), which is marked up with the
592 * <link linkend="PangoMarkupFormat">Pango text markup language</link>.
594 * Note that setting a secondary text makes the primary text become
595 * bold, unless you have provided explicit markup.
600 gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
601 const gchar *message_format,
606 GtkMessageDialogPrivate *priv;
608 g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
610 priv = GTK_MESSAGE_DIALOG_GET_PRIVATE (message_dialog);
614 priv->has_secondary_text = TRUE;
616 va_start (args, message_format);
617 msg = g_strdup_vprintf (message_format, args);
620 gtk_widget_show (priv->secondary_label);
621 gtk_label_set_markup (GTK_LABEL (priv->secondary_label), msg);
627 priv->has_secondary_text = FALSE;
628 gtk_widget_hide (priv->secondary_label);
631 setup_primary_label_font (message_dialog);
635 gtk_message_dialog_add_buttons (GtkMessageDialog* message_dialog,
636 GtkButtonsType buttons)
638 GtkDialog* dialog = GTK_DIALOG (message_dialog);
642 case GTK_BUTTONS_NONE:
647 gtk_dialog_add_button (dialog,
652 case GTK_BUTTONS_CLOSE:
653 gtk_dialog_add_button (dialog,
658 case GTK_BUTTONS_CANCEL:
659 gtk_dialog_add_button (dialog,
661 GTK_RESPONSE_CANCEL);
664 case GTK_BUTTONS_YES_NO:
665 gtk_dialog_add_button (dialog,
668 gtk_dialog_add_button (dialog,
671 gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
677 case GTK_BUTTONS_OK_CANCEL:
678 gtk_dialog_add_button (dialog,
680 GTK_RESPONSE_CANCEL);
681 gtk_dialog_add_button (dialog,
684 gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
691 g_warning ("Unknown GtkButtonsType");
695 g_object_notify (G_OBJECT (message_dialog), "buttons");
699 gtk_message_dialog_style_set (GtkWidget *widget,
700 GtkStyle *prev_style)
703 gint border_width = 0;
704 gboolean use_separator;
706 parent = GTK_WIDGET (GTK_MESSAGE_DIALOG (widget)->image->parent);
710 gtk_widget_style_get (widget, "message_border",
711 &border_width, NULL);
713 gtk_container_set_border_width (GTK_CONTAINER (parent),
717 gtk_widget_style_get (widget,
718 "use_separator", &use_separator,
720 _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), FALSE);
721 gtk_dialog_set_has_separator (GTK_DIALOG (widget), use_separator);
722 _gtk_dialog_set_ignore_separator (GTK_DIALOG (widget), TRUE);
724 if (GTK_WIDGET_CLASS (parent_class)->style_set)
725 (GTK_WIDGET_CLASS (parent_class)->style_set) (widget, prev_style);