]> Pileus Git - ~andy/gtk/blob - gtk/gtkmessagedialog.c
Always chain up in ::style-updated
[~andy/gtk] / gtk / gtkmessagedialog.c
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.
4  *
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.
9  *
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.
14  *
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.
19  */
20
21 /*
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/. 
26  */
27
28 #include "config.h"
29
30 #include <string.h>
31
32 #include "gtkmessagedialog.h"
33 #include "gtkaccessible.h"
34 #include "gtkbuildable.h"
35 #include "gtklabel.h"
36 #include "gtkhbox.h"
37 #include "gtkvbox.h"
38 #include "gtkimage.h"
39 #include "gtkstock.h"
40 #include "gtkiconfactory.h"
41 #include "gtkintl.h"
42 #include "gtkprivate.h"
43 #include "gtktypebuiltins.h"
44
45 /**
46  * SECTION:gtkmessagedialog
47  * @Short_description: A convenient message window
48  * @Title: GtkMessageDialog
49  * @See_also:#GtkDialog
50  *
51  * #GtkMessageDialog presents a dialog with an image representing the type of
52  * message (Error, Question, etc.) alongside some message text. It's simply a
53  * convenience widget; you could construct the equivalent of #GtkMessageDialog
54  * from #GtkDialog without too much effort, but #GtkMessageDialog saves typing.
55  *
56  * The easiest way to do a modal message dialog is to use gtk_dialog_run(), though
57  * you can also pass in the %GTK_DIALOG_MODAL flag, gtk_dialog_run() automatically
58  * makes the dialog modal and waits for the user to respond to it. gtk_dialog_run()
59  * returns when any dialog button is clicked.
60  * <example>
61  * <title>A modal dialog.</title>
62  * <programlisting>
63  *  dialog = gtk_message_dialog_new (main_application_window,
64  *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
65  *                                   GTK_MESSAGE_ERROR,
66  *                                   GTK_BUTTONS_CLOSE,
67  *                                   "Error loading file '&percnt;s': &percnt;s",
68  *                                   filename, g_strerror (errno));
69  *  gtk_dialog_run (GTK_DIALOG (dialog));
70  *  gtk_widget_destroy (dialog);
71  * </programlisting>
72  * </example>
73  * You might do a non-modal #GtkMessageDialog as follows:
74  * <example>
75  * <title>A non-modal dialog.</title>
76  * <programlisting>
77  *  dialog = gtk_message_dialog_new (main_application_window,
78  *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
79  *                                   GTK_MESSAGE_ERROR,
80  *                                   GTK_BUTTONS_CLOSE,
81  *                                   "Error loading file '&percnt;s': &percnt;s",
82  *                                   filename, g_strerror (errno));
83  *
84  *  /&ast; Destroy the dialog when the user responds to it (e.g. clicks a button) &ast;/
85  *  g_signal_connect_swapped (dialog, "response",
86  *                            G_CALLBACK (gtk_widget_destroy),
87  *                            dialog);
88  * </programlisting>
89  * </example>
90  *
91  * <refsect2 id="GtkMessageDialog-BUILDER-UI">
92  * <title>GtkMessageDialog as GtkBuildable</title>
93  * <para>
94  * The GtkMessageDialog implementation of the GtkBuildable interface exposes
95  * the message area as an internal child with the name "message_area".
96  * </para>
97  * </refsect2>
98  */
99
100 struct _GtkMessageDialogPrivate
101 {
102   GtkWidget     *image;
103   GtkWidget     *label;
104   GtkWidget     *message_area; /* vbox for the primary and secondary labels, and any extra content from the caller */
105   GtkWidget     *secondary_label;
106
107   guint          has_primary_markup : 1;
108   guint          has_secondary_text : 1;
109   guint          message_type       : 3;
110 };
111
112 static void gtk_message_dialog_style_updated (GtkWidget             *widget);
113
114 static void gtk_message_dialog_set_property (GObject          *object,
115                                              guint             prop_id,
116                                              const GValue     *value,
117                                              GParamSpec       *pspec);
118 static void gtk_message_dialog_get_property (GObject          *object,
119                                              guint             prop_id,
120                                              GValue           *value,
121                                              GParamSpec       *pspec);
122 static void gtk_message_dialog_add_buttons  (GtkMessageDialog *message_dialog,
123                                              GtkButtonsType    buttons);
124 static void      gtk_message_dialog_buildable_interface_init     (GtkBuildableIface *iface);
125 static GObject * gtk_message_dialog_buildable_get_internal_child (GtkBuildable  *buildable,
126                                                                   GtkBuilder    *builder,
127                                                                   const gchar   *childname);
128
129
130 enum {
131   PROP_0,
132   PROP_MESSAGE_TYPE,
133   PROP_BUTTONS,
134   PROP_TEXT,
135   PROP_USE_MARKUP,
136   PROP_SECONDARY_TEXT,
137   PROP_SECONDARY_USE_MARKUP,
138   PROP_IMAGE,
139   PROP_MESSAGE_AREA
140 };
141
142 G_DEFINE_TYPE_WITH_CODE (GtkMessageDialog, gtk_message_dialog, GTK_TYPE_DIALOG,
143                          G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
144                                                 gtk_message_dialog_buildable_interface_init))
145
146 static GtkBuildableIface *parent_buildable_iface;
147
148 static void
149 gtk_message_dialog_buildable_interface_init (GtkBuildableIface *iface)
150 {
151   parent_buildable_iface = g_type_interface_peek_parent (iface);
152   iface->get_internal_child = gtk_message_dialog_buildable_get_internal_child;
153   iface->custom_tag_start = parent_buildable_iface->custom_tag_start;
154   iface->custom_finished = parent_buildable_iface->custom_finished;
155 }
156
157 static GObject *
158 gtk_message_dialog_buildable_get_internal_child (GtkBuildable *buildable,
159                                                  GtkBuilder   *builder,
160                                                  const gchar  *childname)
161 {
162   if (strcmp (childname, "message_area") == 0)
163     return G_OBJECT (gtk_message_dialog_get_message_area (GTK_MESSAGE_DIALOG (buildable)));
164
165   return parent_buildable_iface->get_internal_child (buildable, builder, childname);
166 }
167
168
169 static void
170 gtk_message_dialog_class_init (GtkMessageDialogClass *class)
171 {
172   GtkWidgetClass *widget_class;
173   GObjectClass *gobject_class;
174
175   widget_class = GTK_WIDGET_CLASS (class);
176   gobject_class = G_OBJECT_CLASS (class);
177   
178   widget_class->style_updated = gtk_message_dialog_style_updated;
179
180   gobject_class->set_property = gtk_message_dialog_set_property;
181   gobject_class->get_property = gtk_message_dialog_get_property;
182   
183   gtk_widget_class_install_style_property (widget_class,
184                                            g_param_spec_int ("message-border",
185                                                              P_("Image/label border"),
186                                                              P_("Width of border around the label and image in the message dialog"),
187                                                              0,
188                                                              G_MAXINT,
189                                                              12,
190                                                              GTK_PARAM_READABLE));
191
192   /**
193    * GtkMessageDialog:message-type:
194    *
195    * The type of the message. The type is used to determine
196    * the image that is shown in the dialog, unless the image is 
197    * explicitly set by the ::image property.
198    */
199   g_object_class_install_property (gobject_class,
200                                    PROP_MESSAGE_TYPE,
201                                    g_param_spec_enum ("message-type",
202                                                       P_("Message Type"),
203                                                       P_("The type of message"),
204                                                       GTK_TYPE_MESSAGE_TYPE,
205                                                       GTK_MESSAGE_INFO,
206                                                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
207   g_object_class_install_property (gobject_class,
208                                    PROP_BUTTONS,
209                                    g_param_spec_enum ("buttons",
210                                                       P_("Message Buttons"),
211                                                       P_("The buttons shown in the message dialog"),
212                                                       GTK_TYPE_BUTTONS_TYPE,
213                                                       GTK_BUTTONS_NONE,
214                                                       GTK_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
215
216   /**
217    * GtkMessageDialog:text:
218    * 
219    * The primary text of the message dialog. If the dialog has 
220    * a secondary text, this will appear as the title.
221    *
222    * Since: 2.10
223    */
224   g_object_class_install_property (gobject_class,
225                                    PROP_TEXT,
226                                    g_param_spec_string ("text",
227                                                         P_("Text"),
228                                                         P_("The primary text of the message dialog"),
229                                                         "",
230                                                         GTK_PARAM_READWRITE));
231
232   /**
233    * GtkMessageDialog:use-markup:
234    * 
235    * %TRUE if the primary text of the dialog includes Pango markup. 
236    * See pango_parse_markup(). 
237    *
238    * Since: 2.10
239    */
240   g_object_class_install_property (gobject_class,
241                                    PROP_USE_MARKUP,
242                                    g_param_spec_boolean ("use-markup",
243                                                          P_("Use Markup"),
244                                                          P_("The primary text of the title includes Pango markup."),
245                                                          FALSE,
246                                                          GTK_PARAM_READWRITE));
247   
248   /**
249    * GtkMessageDialog:secondary-text:
250    * 
251    * The secondary text of the message dialog. 
252    *
253    * Since: 2.10
254    */
255   g_object_class_install_property (gobject_class,
256                                    PROP_SECONDARY_TEXT,
257                                    g_param_spec_string ("secondary-text",
258                                                         P_("Secondary Text"),
259                                                         P_("The secondary text of the message dialog"),
260                                                         NULL,
261                                                         GTK_PARAM_READWRITE));
262
263   /**
264    * GtkMessageDialog:secondary-use-markup:
265    * 
266    * %TRUE if the secondary text of the dialog includes Pango markup. 
267    * See pango_parse_markup(). 
268    *
269    * Since: 2.10
270    */
271   g_object_class_install_property (gobject_class,
272                                    PROP_SECONDARY_USE_MARKUP,
273                                    g_param_spec_boolean ("secondary-use-markup",
274                                                          P_("Use Markup in secondary"),
275                                                          P_("The secondary text includes Pango markup."),
276                                                          FALSE,
277                                                          GTK_PARAM_READWRITE));
278
279   /**
280    * GtkMessageDialog:image:
281    * 
282    * The image for this dialog.
283    *
284    * Since: 2.10
285    */
286   g_object_class_install_property (gobject_class,
287                                    PROP_IMAGE,
288                                    g_param_spec_object ("image",
289                                                         P_("Image"),
290                                                         P_("The image"),
291                                                         GTK_TYPE_WIDGET,
292                                                         GTK_PARAM_READWRITE));
293
294   /**
295    * GtkMessageDialog:message-area
296    *
297    * The #GtkVBox that corresponds to the message area of this dialog.  See
298    * gtk_message_dialog_get_message_area() for a detailed description of this
299    * area.
300    *
301    * Since: 2.22
302    */
303   g_object_class_install_property (gobject_class,
304                                    PROP_MESSAGE_AREA,
305                                    g_param_spec_object ("message-area",
306                                                         P_("Message area"),
307                                                         P_("GtkVBox that holds the dialog's primary and secondary labels"),
308                                                         GTK_TYPE_WIDGET,
309                                                         GTK_PARAM_READABLE));
310
311   g_type_class_add_private (gobject_class, sizeof (GtkMessageDialogPrivate));
312 }
313
314 static void
315 gtk_message_dialog_init (GtkMessageDialog *dialog)
316 {
317   GtkWidget *hbox;
318   GtkDialog *message_dialog = GTK_DIALOG (dialog);
319   GtkWidget *action_area, *content_area;
320   GtkMessageDialogPrivate *priv;
321
322   dialog->priv = G_TYPE_INSTANCE_GET_PRIVATE (dialog,
323                                               GTK_TYPE_MESSAGE_DIALOG,
324                                               GtkMessageDialogPrivate);
325   priv = dialog->priv;
326
327   content_area = gtk_dialog_get_content_area (message_dialog);
328   action_area = gtk_dialog_get_action_area (message_dialog);
329
330   gtk_window_set_resizable (GTK_WINDOW (dialog), FALSE);
331   gtk_window_set_title (GTK_WINDOW (dialog), "");
332   gtk_window_set_skip_taskbar_hint (GTK_WINDOW (dialog), TRUE);
333
334   priv->has_primary_markup = FALSE;
335   priv->has_secondary_text = FALSE;
336   priv->secondary_label = gtk_label_new (NULL);
337   gtk_widget_set_no_show_all (priv->secondary_label, TRUE);
338
339   priv->label = gtk_label_new (NULL);
340   priv->image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
341   gtk_misc_set_alignment (GTK_MISC (priv->image), 0.5, 0.0);
342   
343   gtk_label_set_line_wrap  (GTK_LABEL (priv->label), TRUE);
344   gtk_label_set_selectable (GTK_LABEL (priv->label), TRUE);
345   gtk_misc_set_alignment   (GTK_MISC  (priv->label), 0.0, 0.0);
346   
347   gtk_label_set_line_wrap  (GTK_LABEL (priv->secondary_label), TRUE);
348   gtk_label_set_selectable (GTK_LABEL (priv->secondary_label), TRUE);
349   gtk_misc_set_alignment   (GTK_MISC  (priv->secondary_label), 0.0, 0.0);
350
351   hbox = gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 12);
352   priv->message_area = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);
353
354   gtk_box_pack_start (GTK_BOX (priv->message_area), priv->label,
355                       FALSE, FALSE, 0);
356
357   gtk_box_pack_start (GTK_BOX (priv->message_area), priv->secondary_label,
358                       TRUE, TRUE, 0);
359
360   gtk_box_pack_start (GTK_BOX (hbox), priv->image,
361                       FALSE, FALSE, 0);
362
363   gtk_box_pack_start (GTK_BOX (hbox), priv->message_area,
364                       TRUE, TRUE, 0);
365
366   gtk_box_pack_start (GTK_BOX (content_area),
367                       hbox,
368                       FALSE, FALSE, 0);
369
370   gtk_container_set_border_width (GTK_CONTAINER (dialog), 5);
371   gtk_container_set_border_width (GTK_CONTAINER (hbox), 5);
372   gtk_box_set_spacing (GTK_BOX (content_area), 14); /* 14 + 2 * 5 = 24 */
373   gtk_container_set_border_width (GTK_CONTAINER (action_area), 5);
374   gtk_box_set_spacing (GTK_BOX (action_area), 6);
375
376   gtk_widget_show_all (hbox);
377 }
378
379 static void
380 setup_primary_label_font (GtkMessageDialog *dialog)
381 {
382   GtkMessageDialogPrivate *priv = dialog->priv;
383   gint size;
384   PangoFontDescription *font_desc;
385   GtkStyleContext *context;
386   GtkStateFlags state;
387
388   /* unset the font settings */
389   gtk_widget_modify_font (priv->label, NULL);
390
391   if (priv->has_secondary_text && !priv->has_primary_markup)
392     {
393       context = gtk_widget_get_style_context (priv->label);
394       state = gtk_widget_get_state_flags (priv->label);
395
396       size = pango_font_description_get_size (gtk_style_context_get_font (context, state));
397       font_desc = pango_font_description_new ();
398       pango_font_description_set_weight (font_desc, PANGO_WEIGHT_BOLD);
399       pango_font_description_set_size (font_desc, size * PANGO_SCALE_LARGE);
400       gtk_widget_modify_font (priv->label, font_desc);
401       pango_font_description_free (font_desc);
402     }
403 }
404
405 static void
406 setup_type (GtkMessageDialog *dialog,
407             GtkMessageType    type)
408 {
409   GtkMessageDialogPrivate *priv = dialog->priv;
410   const gchar *stock_id = NULL;
411   AtkObject *atk_obj;
412  
413   priv->message_type = type;
414
415   switch (type)
416     {
417     case GTK_MESSAGE_INFO:
418       stock_id = GTK_STOCK_DIALOG_INFO;
419       break;
420
421     case GTK_MESSAGE_QUESTION:
422       stock_id = GTK_STOCK_DIALOG_QUESTION;
423       break;
424
425     case GTK_MESSAGE_WARNING:
426       stock_id = GTK_STOCK_DIALOG_WARNING;
427       break;
428       
429     case GTK_MESSAGE_ERROR:
430       stock_id = GTK_STOCK_DIALOG_ERROR;
431       break;
432
433     case GTK_MESSAGE_OTHER:
434       break;
435
436     default:
437       g_warning ("Unknown GtkMessageType %u", type);
438       break;
439     }
440
441   if (stock_id)
442     gtk_image_set_from_stock (GTK_IMAGE (priv->image), stock_id,
443                               GTK_ICON_SIZE_DIALOG);
444       
445   atk_obj = gtk_widget_get_accessible (GTK_WIDGET (dialog));
446   if (GTK_IS_ACCESSIBLE (atk_obj))
447     {
448       atk_object_set_role (atk_obj, ATK_ROLE_ALERT);
449       if (stock_id)
450         {
451           GtkStockItem item;
452
453           gtk_stock_lookup (stock_id, &item);
454           atk_object_set_name (atk_obj, item.label);
455         }
456     }
457 }
458
459 static void 
460 gtk_message_dialog_set_property (GObject      *object,
461                                  guint         prop_id,
462                                  const GValue *value,
463                                  GParamSpec   *pspec)
464 {
465   GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (object);
466   GtkMessageDialogPrivate *priv = dialog->priv;
467
468   switch (prop_id)
469     {
470     case PROP_MESSAGE_TYPE:
471       setup_type (dialog, g_value_get_enum (value));
472       break;
473     case PROP_BUTTONS:
474       gtk_message_dialog_add_buttons (dialog, g_value_get_enum (value));
475       break;
476     case PROP_TEXT:
477       if (priv->has_primary_markup)
478         gtk_label_set_markup (GTK_LABEL (priv->label),
479                               g_value_get_string (value));
480       else
481         gtk_label_set_text (GTK_LABEL (priv->label),
482                             g_value_get_string (value));
483       break;
484     case PROP_USE_MARKUP:
485       priv->has_primary_markup = g_value_get_boolean (value) != FALSE;
486       gtk_label_set_use_markup (GTK_LABEL (priv->label),
487                                 priv->has_primary_markup);
488       setup_primary_label_font (dialog);
489       break;
490     case PROP_SECONDARY_TEXT:
491       {
492         const gchar *txt = g_value_get_string (value);
493
494         if (gtk_label_get_use_markup (GTK_LABEL (priv->secondary_label)))
495           gtk_label_set_markup (GTK_LABEL (priv->secondary_label), txt);
496         else
497           gtk_label_set_text (GTK_LABEL (priv->secondary_label), txt);
498
499         if (txt)
500           {
501             priv->has_secondary_text = TRUE;
502             gtk_widget_show (priv->secondary_label);
503           }
504         else
505           {
506             priv->has_secondary_text = FALSE;
507             gtk_widget_hide (priv->secondary_label);
508           }
509         setup_primary_label_font (dialog);
510       }
511       break;
512     case PROP_SECONDARY_USE_MARKUP:
513       gtk_label_set_use_markup (GTK_LABEL (priv->secondary_label), 
514                                 g_value_get_boolean (value));
515       break;
516     case PROP_IMAGE:
517       gtk_message_dialog_set_image (dialog, g_value_get_object (value));
518       break;
519
520     default:
521       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
522       break;
523     }
524 }
525
526 static void 
527 gtk_message_dialog_get_property (GObject     *object,
528                                  guint        prop_id,
529                                  GValue      *value,
530                                  GParamSpec  *pspec)
531 {
532   GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (object);
533   GtkMessageDialogPrivate *priv = dialog->priv;
534
535   switch (prop_id)
536     {
537     case PROP_MESSAGE_TYPE:
538       g_value_set_enum (value, (GtkMessageType) priv->message_type);
539       break;
540     case PROP_TEXT:
541       g_value_set_string (value, gtk_label_get_label (GTK_LABEL (priv->label)));
542       break;
543     case PROP_USE_MARKUP:
544       g_value_set_boolean (value, priv->has_primary_markup);
545       break;
546     case PROP_SECONDARY_TEXT:
547       if (priv->has_secondary_text)
548       g_value_set_string (value, 
549                           gtk_label_get_label (GTK_LABEL (priv->secondary_label)));
550       else
551         g_value_set_string (value, NULL);
552       break;
553     case PROP_SECONDARY_USE_MARKUP:
554       if (priv->has_secondary_text)
555         g_value_set_boolean (value, 
556                              gtk_label_get_use_markup (GTK_LABEL (priv->secondary_label)));
557       else
558         g_value_set_boolean (value, FALSE);
559       break;
560     case PROP_IMAGE:
561       g_value_set_object (value, priv->image);
562       break;
563     case PROP_MESSAGE_AREA:
564       g_value_set_object (value, priv->message_area);
565       break;
566     default:
567       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
568       break;
569     }
570 }
571
572 /**
573  * gtk_message_dialog_new:
574  * @parent: (allow-none): transient parent, or %NULL for none
575  * @flags: flags
576  * @type: type of message
577  * @buttons: set of buttons to use
578  * @message_format: (allow-none): printf()-style format string, or %NULL
579  * @Varargs: arguments for @message_format
580  *
581  * Creates a new message dialog, which is a simple dialog with an icon
582  * indicating the dialog type (error, warning, etc.) and some text the
583  * user may want to see. When the user clicks a button a "response"
584  * signal is emitted with response IDs from #GtkResponseType. See
585  * #GtkDialog for more details.
586  *
587  * Return value: (transfer none): a new #GtkMessageDialog
588  **/
589 GtkWidget*
590 gtk_message_dialog_new (GtkWindow     *parent,
591                         GtkDialogFlags flags,
592                         GtkMessageType type,
593                         GtkButtonsType buttons,
594                         const gchar   *message_format,
595                         ...)
596 {
597   GtkWidget *widget;
598   GtkDialog *dialog;
599   gchar* msg = NULL;
600   va_list args;
601
602   g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
603
604   widget = g_object_new (GTK_TYPE_MESSAGE_DIALOG,
605                          "message-type", type,
606                          "buttons", buttons,
607                          NULL);
608   dialog = GTK_DIALOG (widget);
609
610   if (message_format)
611     {
612       va_start (args, message_format);
613       msg = g_strdup_vprintf (message_format, args);
614       va_end (args);
615
616       gtk_label_set_text (GTK_LABEL (GTK_MESSAGE_DIALOG (widget)->priv->label),
617                           msg);
618
619       g_free (msg);
620     }
621
622   if (parent != NULL)
623     gtk_window_set_transient_for (GTK_WINDOW (widget),
624                                   GTK_WINDOW (parent));
625   
626   if (flags & GTK_DIALOG_MODAL)
627     gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
628
629   if (flags & GTK_DIALOG_DESTROY_WITH_PARENT)
630     gtk_window_set_destroy_with_parent (GTK_WINDOW (dialog), TRUE);
631
632   return widget;
633 }
634
635 /**
636  * gtk_message_dialog_new_with_markup:
637  * @parent: (allow-none): transient parent, or %NULL for none 
638  * @flags: flags
639  * @type: type of message
640  * @buttons: set of buttons to use
641  * @message_format: (allow-none): printf()-style format string, or %NULL
642  * @Varargs: arguments for @message_format
643  * 
644  * Creates a new message dialog, which is a simple dialog with an icon
645  * indicating the dialog type (error, warning, etc.) and some text which
646  * is marked up with the <link linkend="PangoMarkupFormat">Pango text markup language</link>.
647  * When the user clicks a button a "response" signal is emitted with
648  * response IDs from #GtkResponseType. See #GtkDialog for more details.
649  *
650  * Special XML characters in the printf() arguments passed to this
651  * function will automatically be escaped as necessary.
652  * (See g_markup_printf_escaped() for how this is implemented.)
653  * Usually this is what you want, but if you have an existing
654  * Pango markup string that you want to use literally as the
655  * label, then you need to use gtk_message_dialog_set_markup()
656  * instead, since you can't pass the markup string either
657  * as the format (it might contain '%' characters) or as a string
658  * argument.
659  * |[
660  *  GtkWidget *dialog;
661  *  dialog = gtk_message_dialog_new (main_application_window,
662  *                                   GTK_DIALOG_DESTROY_WITH_PARENT,
663  *                                   GTK_MESSAGE_ERROR,
664  *                                   GTK_BUTTONS_CLOSE,
665  *                                   NULL);
666  *  gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (dialog),
667  *                                 markup);
668  * ]|
669  * 
670  * Return value: a new #GtkMessageDialog
671  *
672  * Since: 2.4
673  **/
674 GtkWidget*
675 gtk_message_dialog_new_with_markup (GtkWindow     *parent,
676                                     GtkDialogFlags flags,
677                                     GtkMessageType type,
678                                     GtkButtonsType buttons,
679                                     const gchar   *message_format,
680                                     ...)
681 {
682   GtkWidget *widget;
683   va_list args;
684   gchar *msg = NULL;
685
686   g_return_val_if_fail (parent == NULL || GTK_IS_WINDOW (parent), NULL);
687
688   widget = gtk_message_dialog_new (parent, flags, type, buttons, NULL);
689
690   if (message_format)
691     {
692       va_start (args, message_format);
693       msg = g_markup_vprintf_escaped (message_format, args);
694       va_end (args);
695
696       gtk_message_dialog_set_markup (GTK_MESSAGE_DIALOG (widget), msg);
697
698       g_free (msg);
699     }
700
701   return widget;
702 }
703
704 /**
705  * gtk_message_dialog_set_image:
706  * @dialog: a #GtkMessageDialog
707  * @image: the image
708  * 
709  * Sets the dialog's image to @image.
710  *
711  * Since: 2.10
712  **/
713 void
714 gtk_message_dialog_set_image (GtkMessageDialog *dialog,
715                               GtkWidget        *image)
716 {
717   GtkMessageDialogPrivate *priv;
718   GtkWidget *parent;
719
720   g_return_if_fail (GTK_IS_MESSAGE_DIALOG (dialog));
721   g_return_if_fail (image == NULL || GTK_IS_WIDGET (image));
722
723   priv = dialog->priv;
724
725   if (image == NULL)
726     {
727       image = gtk_image_new_from_stock (NULL, GTK_ICON_SIZE_DIALOG);
728       gtk_misc_set_alignment (GTK_MISC (image), 0.5, 0.0);
729     }
730
731   priv->message_type = GTK_MESSAGE_OTHER;
732
733   parent = gtk_widget_get_parent (priv->image);
734   gtk_container_add (GTK_CONTAINER (parent), image);
735   gtk_container_remove (GTK_CONTAINER (parent), priv->image);
736   gtk_box_reorder_child (GTK_BOX (parent), image, 0);
737
738   priv->image = image;
739
740   g_object_notify (G_OBJECT (dialog), "image");
741 }
742
743 /**
744  * gtk_message_dialog_get_image:
745  * @dialog: a #GtkMessageDialog
746  *
747  * Gets the dialog's image.
748  *
749  * Return value: (transfer none): the dialog's image
750  *
751  * Since: 2.14
752  **/
753 GtkWidget *
754 gtk_message_dialog_get_image (GtkMessageDialog *dialog)
755 {
756   g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (dialog), NULL);
757
758   return dialog->priv->image;
759 }
760
761 /**
762  * gtk_message_dialog_set_markup:
763  * @message_dialog: a #GtkMessageDialog
764  * @str: markup string (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
765  * 
766  * Sets the text of the message dialog to be @str, which is marked
767  * up with the <link linkend="PangoMarkupFormat">Pango text markup
768  * language</link>.
769  *
770  * Since: 2.4
771  **/
772 void
773 gtk_message_dialog_set_markup (GtkMessageDialog *message_dialog,
774                                const gchar      *str)
775 {
776   GtkMessageDialogPrivate *priv;
777
778   g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
779
780   priv = message_dialog->priv;
781
782   priv->has_primary_markup = TRUE;
783   gtk_label_set_markup (GTK_LABEL (priv->label), str);
784 }
785
786 /**
787  * gtk_message_dialog_format_secondary_text:
788  * @message_dialog: a #GtkMessageDialog
789  * @message_format: (allow-none): printf()-style format string, or %NULL
790  * @Varargs: arguments for @message_format
791  * 
792  * Sets the secondary text of the message dialog to be @message_format 
793  * (with printf()-style).
794  *
795  * Note that setting a secondary text makes the primary text become
796  * bold, unless you have provided explicit markup.
797  *
798  * Since: 2.6
799  **/
800 void
801 gtk_message_dialog_format_secondary_text (GtkMessageDialog *message_dialog,
802                                           const gchar      *message_format,
803                                           ...)
804 {
805   va_list args;
806   gchar *msg = NULL;
807   GtkMessageDialogPrivate *priv;
808
809   g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
810
811   priv = message_dialog->priv;
812
813   if (message_format)
814     {
815       priv->has_secondary_text = TRUE;
816
817       va_start (args, message_format);
818       msg = g_strdup_vprintf (message_format, args);
819       va_end (args);
820
821       gtk_widget_show (priv->secondary_label);
822       gtk_label_set_text (GTK_LABEL (priv->secondary_label), msg);
823
824       g_free (msg);
825     }
826   else
827     {
828       priv->has_secondary_text = FALSE;
829       gtk_widget_hide (priv->secondary_label);
830     }
831
832   setup_primary_label_font (message_dialog);
833 }
834
835 /**
836  * gtk_message_dialog_format_secondary_markup:
837  * @message_dialog: a #GtkMessageDialog
838  * @message_format: printf()-style markup string (see 
839      <link linkend="PangoMarkupFormat">Pango markup format</link>), or %NULL
840  * @Varargs: arguments for @message_format
841  * 
842  * Sets the secondary text of the message dialog to be @message_format (with 
843  * printf()-style), which is marked up with the 
844  * <link linkend="PangoMarkupFormat">Pango text markup language</link>.
845  *
846  * Note that setting a secondary text makes the primary text become
847  * bold, unless you have provided explicit markup.
848  *
849  * Due to an oversight, this function does not escape special XML characters
850  * like gtk_message_dialog_new_with_markup() does. Thus, if the arguments 
851  * may contain special XML characters, you should use g_markup_printf_escaped()
852  * to escape it.
853
854  * <informalexample><programlisting>
855  * gchar *msg;
856  *  
857  * msg = g_markup_printf_escaped (message_format, ...);
858  * gtk_message_dialog_format_secondary_markup (message_dialog, "&percnt;s", msg);
859  * g_free (msg);
860  * </programlisting></informalexample>
861  *
862  * Since: 2.6
863  **/
864 void
865 gtk_message_dialog_format_secondary_markup (GtkMessageDialog *message_dialog,
866                                             const gchar      *message_format,
867                                             ...)
868 {
869   va_list args;
870   gchar *msg = NULL;
871   GtkMessageDialogPrivate *priv;
872
873   g_return_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog));
874
875   priv = message_dialog->priv;
876
877   if (message_format)
878     {
879       priv->has_secondary_text = TRUE;
880
881       va_start (args, message_format);
882       msg = g_strdup_vprintf (message_format, args);
883       va_end (args);
884
885       gtk_widget_show (priv->secondary_label);
886       gtk_label_set_markup (GTK_LABEL (priv->secondary_label), msg);
887
888       g_free (msg);
889     }
890   else
891     {
892       priv->has_secondary_text = FALSE;
893       gtk_widget_hide (priv->secondary_label);
894     }
895
896   setup_primary_label_font (message_dialog);
897 }
898
899 /**
900  * gtk_message_dialog_get_message_area:
901  * @message_dialog: a #GtkMessageDialog
902  *
903  * Returns the message area of the dialog. This is the box where the
904  * dialog's primary and secondary labels are packed. You can add your
905  * own extra content to that box and it will appear below those labels,
906  * on the right side of the dialog's image (or on the left for right-to-left
907  * languages).  See gtk_dialog_get_content_area() for the corresponding
908  * function in the parent #GtkDialog.
909  *
910  * Return value: (transfer none): A #GtkVBox corresponding to the
911  *     "message area" in the @message_dialog.
912  *
913  * Since: 2.22
914  **/
915 GtkWidget *
916 gtk_message_dialog_get_message_area (GtkMessageDialog *message_dialog)
917 {
918   g_return_val_if_fail (GTK_IS_MESSAGE_DIALOG (message_dialog), NULL);
919
920   return message_dialog->priv->message_area;
921 }
922
923 static void
924 gtk_message_dialog_add_buttons (GtkMessageDialog* message_dialog,
925                                 GtkButtonsType buttons)
926 {
927   GtkDialog* dialog = GTK_DIALOG (message_dialog);
928
929   switch (buttons)
930     {
931     case GTK_BUTTONS_NONE:
932       /* nothing */
933       break;
934
935     case GTK_BUTTONS_OK:
936       gtk_dialog_add_button (dialog,
937                              GTK_STOCK_OK,
938                              GTK_RESPONSE_OK);
939       break;
940
941     case GTK_BUTTONS_CLOSE:
942       gtk_dialog_add_button (dialog,
943                              GTK_STOCK_CLOSE,
944                              GTK_RESPONSE_CLOSE);
945       break;
946
947     case GTK_BUTTONS_CANCEL:
948       gtk_dialog_add_button (dialog,
949                              GTK_STOCK_CANCEL,
950                              GTK_RESPONSE_CANCEL);
951       break;
952
953     case GTK_BUTTONS_YES_NO:
954       gtk_dialog_add_button (dialog,
955                              GTK_STOCK_NO,
956                              GTK_RESPONSE_NO);
957       gtk_dialog_add_button (dialog,
958                              GTK_STOCK_YES,
959                              GTK_RESPONSE_YES);
960       gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
961                                                GTK_RESPONSE_YES,
962                                                GTK_RESPONSE_NO,
963                                                -1);
964       break;
965
966     case GTK_BUTTONS_OK_CANCEL:
967       gtk_dialog_add_button (dialog,
968                              GTK_STOCK_CANCEL,
969                              GTK_RESPONSE_CANCEL);
970       gtk_dialog_add_button (dialog,
971                              GTK_STOCK_OK,
972                              GTK_RESPONSE_OK);
973       gtk_dialog_set_alternative_button_order (GTK_DIALOG (dialog),
974                                                GTK_RESPONSE_OK,
975                                                GTK_RESPONSE_CANCEL,
976                                                -1);
977       break;
978       
979     default:
980       g_warning ("Unknown GtkButtonsType");
981       break;
982     } 
983
984   g_object_notify (G_OBJECT (message_dialog), "buttons");
985 }
986
987 static void
988 gtk_message_dialog_style_updated (GtkWidget *widget)
989 {
990   GtkMessageDialog *dialog = GTK_MESSAGE_DIALOG (widget);
991   GtkWidget *parent;
992   gint border_width;
993
994   parent = gtk_widget_get_parent (gtk_message_dialog_get_image (dialog));
995
996   if (parent)
997     {
998       gtk_widget_style_get (widget, "message-border",
999                             &border_width, NULL);
1000
1001       gtk_container_set_border_width (GTK_CONTAINER (parent),
1002                                       MAX (0, border_width - 7));
1003     }
1004
1005   setup_primary_label_font (dialog);
1006
1007   GTK_WIDGET_CLASS (gtk_message_dialog_parent_class)->style_updated (widget);
1008 }