]> Pileus Git - ~andy/gtk/blob - gtk/gtkinfobar.c
Merge branch 'button-box-orientable-584598'
[~andy/gtk] / gtk / gtkinfobar.c
1 /*
2  * gtkinfobar.c
3  * This file is part of GTK+
4  *
5  * Copyright (C) 2005 - Paolo Maggi
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 /*
24  * Modified by the gedit Team, 2005. See the AUTHORS file for a
25  * list of people on the gtk Team.
26  * See the gedit ChangeLog files for a list of changes.
27  *
28  * Modified by the GTK+ team, 2008-2009.
29  */
30
31
32 #include "config.h"
33
34 #include <stdlib.h>
35
36 #include "gtkinfobar.h"
37 #include "gtkaccessible.h"
38 #include "gtkbuildable.h"
39 #include "gtkbox.h"
40 #include "gtkvbbox.h"
41 #include "gtklabel.h"
42 #include "gtkbutton.h"
43 #include "gtkenums.h"
44 #include "gtkbindings.h"
45 #include "gtkdialog.h"
46 #include "gtkintl.h"
47 #include "gtkprivate.h"
48 #include "gtkstock.h"
49 #include "gdkkeysyms.h"
50 #include "gtkalias.h"
51
52
53 /**
54  * SECTION:gtkinfobar
55  * @short_description: Report important messages to the user
56  * @include: gtk/gtk.h
57  * @see_also: #GtkStatusbar, #GtkMessageDialog
58  *
59  * #GtkInfoBar is a widget that can be used to show messages to
60  * the user without showing a dialog. It is often temporarily shown
61  * at the top or bottom of a document. In contrast to #GtkDialog, which
62  * has a horizontal action area at the bottom, #GtkInfoBar has a
63  * vertical action area at the side.
64  *
65  * The API of #GtkInfoBar is very similar to #GtkDialog, allowing you
66  * to add buttons to the action area with gtk_info_bar_add_button() or
67  * gtk_info_bar_new_with_buttons(). The sensitivity of action widgets
68  * can be controlled with gtk_info_bar_set_response_sensitive().
69  * To add widgets to the main content area of a #GtkInfoBar, use
70  * gtk_info_bar_get_content_area() and add your widgets to the container.
71  *
72  * Similar to #GtkMessageDialog, the contents of a #GtkInfoBar can by
73  * classified as error message, warning, informational message, etc,
74  * by using gtk_info_bar_set_message_type(). GTK+ uses the message type
75  * to determine the background color of the message area.
76  *
77  * <example>
78  * <title>Simple GtkInfoBar usage.</title>
79  * <programlisting>
80  * /&ast; set up info bar &ast;/
81  * info_bar = gtk_info_bar_new ();
82  * gtk_widget_set_no_show_all (info_bar, TRUE);
83  * message_label = gtk_label_new ("");
84  * gtk_widget_show (message_label);
85  * content_area = gtk_info_bar_get_content_area (GTK_INFO_BAR (info_bar));
86  * gtk_container_add (GTK_CONTAINER (content_area), message_label);
87  * gtk_info_bar_add_button (GTK_INFO_BAR (info_bar),
88  *                          GTK_STOCK_OK, GTK_RESPONSE_OK);
89  * g_signal_connect (info_bar, "response",
90  *                   G_CALLBACK (gtk_widget_hide), NULL);
91  * gtk_table_attach (GTK_TABLE (table),
92  *                   info_bar,
93  *                   0, 1, 2, 3,
94  *                   GTK_EXPAND | GTK_FILL,  0,
95  *                   0,                      0);
96  *
97  * /&ast; ... &ast;/
98  *
99  * /&ast; show an error message &ast;/
100  * gtk_label_set_text (GTK_LABEL (message_label), error_message);
101  * gtk_info_bar_set_message_type (GTK_INFO_BAR (info_bar),
102  *                                GTK_MESSAGE_ERROR);
103  * gtk_widget_show (info_bar);
104  * </programlisting>
105  * </example>
106  *
107  * <refsect2 id="GtkInfoBar-BUILDER-UI">
108  * <title>GtkInfoBar as GtkBuildable</title>
109  * <para>
110  * The GtkInfoBar implementation of the GtkBuildable interface exposes
111  * the content area and action area as internal children with the names
112  * "content_area" and "action_area".
113  * </para>
114  * <para>
115  * GtkInfoBar supports a custom &lt;action-widgets&gt; element, which
116  * can contain multiple &lt;action-widget&gt; elements. The "response"
117  * attribute specifies a numeric response, and the content of the element
118  * is the id of widget (which should be a child of the dialogs @action_area).
119  * </para>
120  * </refsect2>
121  */
122
123 #define GTK_INFO_BAR_GET_PRIVATE(object) \
124   (G_TYPE_INSTANCE_GET_PRIVATE ((object), \
125                                 GTK_TYPE_INFO_BAR, \
126                                 GtkInfoBarPrivate))
127
128 enum
129 {
130   PROP_0,
131   PROP_MESSAGE_TYPE
132 };
133
134 struct _GtkInfoBarPrivate
135 {
136   GtkWidget *content_area;
137   GtkWidget *action_area;
138
139   GtkMessageType message_type;
140 };
141
142 typedef struct _ResponseData ResponseData;
143
144 struct _ResponseData
145 {
146   gint response_id;
147 };
148
149 enum
150 {
151   RESPONSE,
152   CLOSE,
153   LAST_SIGNAL
154 };
155
156 static guint signals[LAST_SIGNAL];
157
158
159 static void     gtk_info_bar_set_property (GObject        *object,
160                                            guint           prop_id,
161                                            const GValue   *value,
162                                            GParamSpec     *pspec);
163 static void     gtk_info_bar_get_property (GObject        *object,
164                                            guint           prop_id,
165                                            GValue         *value,
166                                            GParamSpec     *pspec);
167 static void     gtk_info_bar_style_set    (GtkWidget      *widget,
168                                            GtkStyle       *prev_style);
169 static gboolean gtk_info_bar_expose       (GtkWidget      *widget,
170                                            GdkEventExpose *event);
171 static void     gtk_info_bar_buildable_interface_init     (GtkBuildableIface *iface);
172 static GObject *gtk_info_bar_buildable_get_internal_child (GtkBuildable  *buildable,
173                                                            GtkBuilder    *builder,
174                                                            const gchar   *childname);
175 static gboolean  gtk_info_bar_buildable_custom_tag_start   (GtkBuildable  *buildable,
176                                                             GtkBuilder    *builder,
177                                                             GObject       *child,
178                                                             const gchar   *tagname,
179                                                             GMarkupParser *parser,
180                                                             gpointer      *data);
181 static void      gtk_info_bar_buildable_custom_finished    (GtkBuildable  *buildable,
182                                                             GtkBuilder    *builder,
183                                                             GObject       *child,
184                                                             const gchar   *tagname,
185                                                             gpointer       user_data);
186
187
188 G_DEFINE_TYPE_WITH_CODE (GtkInfoBar, gtk_info_bar, GTK_TYPE_HBOX,
189                          G_IMPLEMENT_INTERFACE (GTK_TYPE_BUILDABLE,
190                                                 gtk_info_bar_buildable_interface_init))
191
192 static void
193 gtk_info_bar_set_property (GObject      *object,
194                            guint         prop_id,
195                            const GValue *value,
196                            GParamSpec   *pspec)
197 {
198   GtkInfoBar *info_bar;
199   GtkInfoBarPrivate *priv;
200
201   info_bar = GTK_INFO_BAR (object);
202   priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
203
204   switch (prop_id)
205     {
206     case PROP_MESSAGE_TYPE:
207       gtk_info_bar_set_message_type (info_bar, g_value_get_enum (value));
208       break;
209     default:
210       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
211       break;
212     }
213 }
214
215 static void
216 gtk_info_bar_get_property (GObject    *object,
217                            guint       prop_id,
218                            GValue     *value,
219                            GParamSpec *pspec)
220 {
221   GtkInfoBar *info_bar;
222   GtkInfoBarPrivate *priv;
223
224   info_bar = GTK_INFO_BAR (object);
225   priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
226
227   switch (prop_id)
228     {
229     case PROP_MESSAGE_TYPE:
230       g_value_set_enum (value, gtk_info_bar_get_message_type (info_bar));
231       break;
232     default:
233       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
234       break;
235     }
236 }
237
238 static void
239 gtk_info_bar_finalize (GObject *object)
240 {
241   G_OBJECT_CLASS (gtk_info_bar_parent_class)->finalize (object);
242 }
243
244 static void
245 response_data_free (gpointer data)
246 {
247   g_slice_free (ResponseData, data);
248 }
249
250 static ResponseData *
251 get_response_data (GtkWidget *widget,
252                    gboolean   create)
253 {
254   ResponseData *ad = g_object_get_data (G_OBJECT (widget),
255                                         "gtk-info-bar-response-data");
256
257   if (ad == NULL && create)
258     {
259       ad = g_slice_new (ResponseData);
260
261       g_object_set_data_full (G_OBJECT (widget),
262                               I_("gtk-info-bar-response-data"),
263                               ad,
264                               response_data_free);
265     }
266
267   return ad;
268 }
269
270 static GtkWidget *
271 find_button (GtkInfoBar *info_bar,
272              gint        response_id)
273 {
274   GList *children, *list;
275   GtkWidget *child = NULL;
276
277   children = gtk_container_get_children (GTK_CONTAINER (info_bar->priv->action_area));
278
279   for (list = children; list; list = list->next)
280     {
281       ResponseData *rd = get_response_data (list->data, FALSE);
282
283       if (rd && rd->response_id == response_id)
284         {
285           child = list->data;
286           break;
287         }
288     }
289
290   g_list_free (children);
291
292   return child;
293 }
294
295 static void
296 gtk_info_bar_close (GtkInfoBar *info_bar)
297 {
298   if (!find_button (info_bar, GTK_RESPONSE_CANCEL))
299     return;
300
301   gtk_info_bar_response (GTK_INFO_BAR (info_bar),
302                          GTK_RESPONSE_CANCEL);
303 }
304
305 static gboolean
306 gtk_info_bar_expose (GtkWidget      *widget,
307                      GdkEventExpose *event)
308 {
309   GtkInfoBarPrivate *priv = GTK_INFO_BAR_GET_PRIVATE (widget);
310   gboolean use_tooltip_style;
311   const char* type_detail[] = {
312     "infobar-info",
313     "infobar-warning",
314     "infobar-question",
315     "infobar-error",
316     "infobar"
317   };
318   const char *detail;
319
320   gtk_widget_style_get (widget,
321                         "use-tooltip-style", &use_tooltip_style,
322                         NULL);
323
324   if (use_tooltip_style)
325     detail = "toolbar";
326   else
327     detail = type_detail[priv->message_type];
328
329   gtk_paint_flat_box (widget->style,
330                       widget->window,
331                       GTK_STATE_NORMAL,
332                       GTK_SHADOW_OUT,
333                       NULL,
334                       widget,
335                       detail,
336                       widget->allocation.x,
337                       widget->allocation.y,
338                       widget->allocation.width + 1,
339                       widget->allocation.height + 1);
340
341   if (GTK_WIDGET_CLASS (gtk_info_bar_parent_class)->expose_event)
342     GTK_WIDGET_CLASS (gtk_info_bar_parent_class)->expose_event (widget, event);
343
344   return FALSE;
345 }
346
347 static void
348 gtk_info_bar_class_init (GtkInfoBarClass *klass)
349 {
350   GtkWidgetClass *widget_class;
351   GObjectClass *object_class;
352   GtkBindingSet *binding_set;
353
354   widget_class = GTK_WIDGET_CLASS (klass);
355   object_class = G_OBJECT_CLASS (klass);
356
357   object_class->get_property = gtk_info_bar_get_property;
358   object_class->set_property = gtk_info_bar_set_property;
359   object_class->finalize = gtk_info_bar_finalize;
360
361   widget_class->style_set = gtk_info_bar_style_set;
362   widget_class->expose_event = gtk_info_bar_expose;
363
364   klass->close = gtk_info_bar_close;
365
366   /**
367    * GtkInfoBar:message-type:
368    *
369    * The type of the message.
370    *
371    * The type is used to determine the colors to use in the info bar.
372    * The following symbolic color names can by used to customize
373    * these colors:
374    * "info_fg_color", "info_bg_color",
375    * "warning_fg_color", "warning_bg_color",
376    * "question_fg_color", "question_bg_color",
377    * "error_fg_color", "error_bg_color",
378    * "other_fg_color", "other_bg_color".
379    *
380    * Since: 2.18
381    */
382   g_object_class_install_property (object_class,
383                                    PROP_MESSAGE_TYPE,
384                                    g_param_spec_enum ("message-type",
385                                                       P_("Message Type"),
386                                                       P_("The type of message"),
387                                                       GTK_TYPE_MESSAGE_TYPE,
388                                                       GTK_MESSAGE_OTHER,
389                                                       GTK_PARAM_READWRITE | G_PARAM_CONSTRUCT));
390   /**
391    * GtkInfoBar::response:
392    * @info_bar: the object on which the signal is emitted
393    * @response_id: the response ID
394    *
395    * Emitted when an action widget is clicked or the application programmer
396    * calls gtk_dialog_response(). The @response_id depends on which action
397    * widget was clicked.
398    *
399    * Since: 2.18
400    */
401   signals[RESPONSE] = g_signal_new (I_("response"),
402                                     G_OBJECT_CLASS_TYPE (klass),
403                                     G_SIGNAL_RUN_LAST,
404                                     G_STRUCT_OFFSET (GtkInfoBarClass, response),
405                                     NULL, NULL,
406                                     g_cclosure_marshal_VOID__INT,
407                                     G_TYPE_NONE, 1,
408                                     G_TYPE_INT);
409
410   /**
411    * GtkInfoBar::close:
412    *
413    * The ::close signal is a
414    * <link linkend="keybinding-signals">keybinding signal</link>
415    * which gets emitted when the user uses a keybinding to dismiss
416    * the info bar.
417    *
418    * The default binding for this signal is the Escape key.
419    *
420    * Since: 2.18
421    */
422   signals[CLOSE] =  g_signal_new (I_("close"),
423                                   G_OBJECT_CLASS_TYPE (klass),
424                                   G_SIGNAL_RUN_LAST | G_SIGNAL_ACTION,
425                                   G_STRUCT_OFFSET (GtkInfoBarClass, close),
426                                   NULL, NULL,
427                                   g_cclosure_marshal_VOID__VOID,
428                                   G_TYPE_NONE, 0);
429
430   /**
431    * GtkInfoBar:content-area-border:
432    *
433    * The width of the border around the content
434    * content area of the info bar.
435    *
436    * Since: 2.18
437    */
438   gtk_widget_class_install_style_property (widget_class,
439                                            g_param_spec_int ("content-area-border",
440                                                              P_("Content area border"),
441                                                              P_("Width of border around the content area"),
442                                                              0,
443                                                              G_MAXINT,
444                                                              8,
445                                                              GTK_PARAM_READABLE));
446
447   /**
448    * GtkInfoBar:content-area-spacing:
449    *
450    * The default spacing used between elements of the
451    * content area of the info bar.
452    *
453    * Since: 2.18
454    */
455   gtk_widget_class_install_style_property (widget_class,
456                                            g_param_spec_int ("content-area-spacing",
457                                                              P_("Content area spacing"),
458                                                              P_("Spacing between elements of the area"),
459                                                              0,
460                                                              G_MAXINT,
461                                                              16,
462                                                              GTK_PARAM_READABLE));
463
464   /**
465    * GtkInfoBar:button-spacing:
466    *
467    * Spacing between buttons in the action area of the info bar.
468    *
469    * Since: 2.18
470    */
471   gtk_widget_class_install_style_property (widget_class,
472                                            g_param_spec_int ("button-spacing",
473                                                              P_("Button spacing"),
474                                                              P_("Spacing between buttons"),
475                                                              0,
476                                                              G_MAXINT,
477                                                              6,
478                                                              GTK_PARAM_READABLE));
479
480   /**
481    * GtkInfoBar:action-area-border:
482    *
483    * Width of the border around the action area of the info bar.
484    *
485    * Since: 2.18
486    */
487   gtk_widget_class_install_style_property (widget_class,
488                                            g_param_spec_int ("action-area-border",
489                                                              P_("Action area border"),
490                                                              P_("Width of border around the action area"),
491                                                              0,
492                                                              G_MAXINT,
493                                                              5,
494                                                              GTK_PARAM_READABLE));
495
496   /**
497    * GtkInfoBar:use-tooltip-style:
498    *
499    * When %TRUE, use the same background/foreground color as #GtkTooltip.
500    * Otherwise, GTK+ uses #GtkInfoBar::message-type to determine which
501    * symbolic colors to use.
502    *
503    * Since: 2.18
504    */
505   gtk_widget_class_install_style_property (widget_class,
506                                            g_param_spec_boolean ("use-tooltip-style",
507                                                                  P_("Use tooltip style"),
508                                                                  P_("Wether to use the same style as GtkTooltip for drawing"),
509                                                                  TRUE,
510                                                                  GTK_PARAM_READABLE));
511
512   binding_set = gtk_binding_set_by_class (klass);
513
514   gtk_binding_entry_add_signal (binding_set, GDK_Escape, 0, "close", 0);
515
516   g_type_class_add_private (object_class, sizeof (GtkInfoBarPrivate));
517 }
518
519 static void
520 gtk_info_bar_update_colors (GtkInfoBar *info_bar)
521 {
522   GtkWidget *widget = (GtkWidget*)info_bar;
523   GtkInfoBarPrivate *priv;
524   GdkColor default_border_color = { 0, 0xb800, 0xad00, 0x9d00 };
525   GdkColor default_fill_color = { 0, 0xff00, 0xff00, 0xbf00 };
526   GdkColor *fg, *bg;
527   GdkColor sym_fg, sym_bg;
528   gboolean use_tooltip_style;
529   GtkStyle *style;
530   const char* fg_color_name[] = {
531     "info_fg_color",
532     "warning_fg_color",
533     "question_fg_color",
534     "error_fg_color",
535     "other_fg_color"
536   };
537   const char* bg_color_name[] = {
538     "info_bg_color",
539     "warning_bg_color",
540     "question_bg_color",
541     "error_bg_color",
542     "other_bg_color"
543   };
544   gboolean has_color;
545
546   priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
547   style = gtk_widget_get_style (widget);
548
549   gtk_widget_style_get (widget,
550                         "use-tooltip-style", &use_tooltip_style, NULL);
551
552   has_color = FALSE;
553
554   if (gtk_style_lookup_color (style, fg_color_name[priv->message_type], &sym_fg) &&
555       gtk_style_lookup_color (style, bg_color_name[priv->message_type], &sym_bg))
556     {
557       fg = &sym_fg;
558       bg = &sym_bg;
559       has_color = TRUE;
560     }
561   else if (use_tooltip_style)
562     {
563       style = gtk_rc_get_style_by_paths (gtk_widget_get_settings (widget),
564                                          "gtk-tooltip", "GtkTooltip", G_TYPE_NONE);
565       if (style)
566         {
567           fg = &style->fg[GTK_STATE_NORMAL];
568           bg = &style->bg[GTK_STATE_NORMAL];
569         }
570       else
571         {
572           fg = &default_border_color;
573           bg = &default_fill_color;
574         }
575
576       has_color = TRUE;
577     }
578
579   if (has_color)
580     {
581       if (!gdk_color_equal (bg, &widget->style->bg[GTK_STATE_NORMAL]))
582         gtk_widget_modify_bg (widget, GTK_STATE_NORMAL, bg);
583       if (!gdk_color_equal (fg, &widget->style->fg[GTK_STATE_NORMAL]))
584         gtk_widget_modify_fg (widget, GTK_STATE_NORMAL, fg);
585     }
586 }
587
588 static void
589 gtk_info_bar_style_set (GtkWidget *widget,
590                         GtkStyle  *prev_style)
591 {
592   GtkInfoBar *info_bar = GTK_INFO_BAR (widget);
593   gint button_spacing;
594   gint action_area_border;
595   gint content_area_spacing;
596   gint content_area_border;
597
598   gtk_widget_style_get (widget,
599                         "button-spacing", &button_spacing,
600                         "action-area-border", &action_area_border,
601                         "content-area-spacing", &content_area_spacing,
602                         "content-area-border", &content_area_border,
603                         NULL);
604
605   gtk_box_set_spacing (GTK_BOX (info_bar->priv->action_area), button_spacing);
606   gtk_container_set_border_width (GTK_CONTAINER (info_bar->priv->action_area),
607                                   action_area_border);
608   gtk_box_set_spacing (GTK_BOX (info_bar->priv->content_area), content_area_spacing);
609   gtk_container_set_border_width (GTK_CONTAINER (info_bar->priv->content_area),
610                                   content_area_border);
611
612   gtk_info_bar_update_colors (info_bar);
613 }
614
615 static void
616 gtk_info_bar_init (GtkInfoBar *info_bar)
617 {
618   GtkWidget *content_area;
619   GtkWidget *action_area;
620
621   gtk_widget_push_composite_child ();
622
623   info_bar->priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
624
625   content_area = gtk_hbox_new (FALSE, 0);
626   gtk_widget_show (content_area);
627   gtk_box_pack_start (GTK_BOX (info_bar), content_area, TRUE, TRUE, 0);
628
629   action_area = gtk_vbutton_box_new ();
630   gtk_widget_show (action_area);
631   gtk_button_box_set_layout (GTK_BUTTON_BOX (action_area), GTK_BUTTONBOX_END);
632   gtk_box_pack_start (GTK_BOX (info_bar), action_area, FALSE, TRUE, 0);
633
634   gtk_widget_set_app_paintable (GTK_WIDGET (info_bar), TRUE);
635
636   info_bar->priv->content_area = content_area;
637   info_bar->priv->action_area = action_area;
638
639   gtk_widget_pop_composite_child ();
640 }
641
642 static GtkBuildableIface *parent_buildable_iface;
643
644 static void
645 gtk_info_bar_buildable_interface_init (GtkBuildableIface *iface)
646 {
647   parent_buildable_iface = g_type_interface_peek_parent (iface);
648   iface->get_internal_child = gtk_info_bar_buildable_get_internal_child;
649   iface->custom_tag_start = gtk_info_bar_buildable_custom_tag_start;
650   iface->custom_finished = gtk_info_bar_buildable_custom_finished;
651 }
652
653 static GObject *
654 gtk_info_bar_buildable_get_internal_child (GtkBuildable *buildable,
655                                            GtkBuilder   *builder,
656                                            const gchar  *childname)
657 {
658   if (strcmp (childname, "content_area") == 0)
659     return G_OBJECT (GTK_INFO_BAR (buildable)->priv->content_area);
660   else if (strcmp (childname, "action_area") == 0)
661     return G_OBJECT (GTK_INFO_BAR (buildable)->priv->action_area);
662
663   return parent_buildable_iface->get_internal_child (buildable,
664                                                      builder,
665                                                      childname);
666 }
667
668 static gint
669 get_response_for_widget (GtkInfoBar *info_bar,
670                          GtkWidget  *widget)
671 {
672   ResponseData *rd;
673
674   rd = get_response_data (widget, FALSE);
675   if (!rd)
676     return GTK_RESPONSE_NONE;
677   else
678     return rd->response_id;
679 }
680
681 static void
682 action_widget_activated (GtkWidget  *widget,
683                          GtkInfoBar *info_bar)
684 {
685   gint response_id;
686
687   response_id = get_response_for_widget (info_bar, widget);
688   gtk_info_bar_response (info_bar, response_id);
689 }
690
691 /**
692  * gtk_info_bar_add_action_widget:
693  * @info_bar: a #GtkInfoBar
694  * @child: an activatable widget
695  * @response_id: response ID for @child
696  *
697  * Add an activatable widget to the action area of a #GtkInfoBar,
698  * connecting a signal handler that will emit the #GtkInfoBar::response
699  * signal on the message area when the widget is activated. The widget
700  * is appended to the end of the message areas action area.
701  *
702  * Since: 2.18
703  */
704 void
705 gtk_info_bar_add_action_widget (GtkInfoBar *info_bar,
706                                 GtkWidget  *child,
707                                 gint        response_id)
708 {
709   ResponseData *ad;
710   guint signal_id;
711
712   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
713   g_return_if_fail (GTK_IS_WIDGET (child));
714
715   ad = get_response_data (child, TRUE);
716
717   ad->response_id = response_id;
718
719   if (GTK_IS_BUTTON (child))
720     signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
721   else
722     signal_id = GTK_WIDGET_GET_CLASS (child)->activate_signal;
723
724   if (signal_id)
725     {
726       GClosure *closure;
727
728       closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
729                                        G_OBJECT (info_bar));
730       g_signal_connect_closure_by_id (child, signal_id, 0, closure, FALSE);
731     }
732   else
733     g_warning ("Only 'activatable' widgets can be packed into the action area of a GtkInfoBar");
734
735   gtk_box_pack_end (GTK_BOX (info_bar->priv->action_area),
736                     child, FALSE, FALSE, 0);
737   if (response_id == GTK_RESPONSE_HELP)
738     gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (info_bar->priv->action_area),
739                                         child, TRUE);
740 }
741
742 /**
743  * gtk_info_bar_get_action_area:
744  * @info_bar: a #GtkInfoBar
745  *
746  * Returns the action area of @info_bar.
747  *
748  * Returns: the action area.
749  *
750  * Since: 2.18
751  */
752 GtkWidget*
753 gtk_info_bar_get_action_area (GtkInfoBar *info_bar)
754 {
755   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
756
757   return info_bar->priv->action_area;
758 }
759
760 /**
761  * gtk_info_bar_get_content_area:
762  * @info_bar: a #GtkInfoBar
763  *
764  * Returns the content area of @info_bar.
765  *
766  * Returns: the content area.
767  *
768  * Since: 2.18
769  */
770 GtkWidget*
771 gtk_info_bar_get_content_area (GtkInfoBar *info_bar)
772 {
773   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
774
775   return info_bar->priv->content_area;
776 }
777
778 /**
779  * gtk_info_bar_add_button:
780  * @info_bar: a #GtkInfoBar
781  * @button_text: text of button, or stock ID
782  * @response_id: response ID for the button
783  *
784  * Adds a button with the given text (or a stock button, if button_text
785  * is a stock ID) and sets things up so that clicking the button will emit
786  * the "response" signal with the given response_id. The button is appended
787  * to the end of the info bars's action area. The button widget is
788  * returned, but usually you don't need it.
789  *
790  * Returns: the button widget that was added
791  *
792  * Since: 2.18
793  */
794 GtkWidget*
795 gtk_info_bar_add_button (GtkInfoBar  *info_bar,
796                          const gchar *button_text,
797                          gint         response_id)
798 {
799   GtkWidget *button;
800
801   g_return_val_if_fail (GTK_IS_INFO_BAR (info_bar), NULL);
802   g_return_val_if_fail (button_text != NULL, NULL);
803
804   button = gtk_button_new_from_stock (button_text);
805
806   GTK_WIDGET_SET_FLAGS (button, GTK_CAN_DEFAULT);
807
808   gtk_widget_show (button);
809
810   gtk_info_bar_add_action_widget (info_bar, button, response_id);
811
812   return button;
813 }
814
815 static void
816 add_buttons_valist (GtkInfoBar  *info_bar,
817                     const gchar *first_button_text,
818                     va_list      args)
819 {
820   const gchar* text;
821   gint response_id;
822
823   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
824
825   if (first_button_text == NULL)
826     return;
827
828   text = first_button_text;
829   response_id = va_arg (args, gint);
830
831   while (text != NULL)
832     {
833       gtk_info_bar_add_button (info_bar, text, response_id);
834
835       text = va_arg (args, gchar*);
836       if (text == NULL)
837         break;
838
839       response_id = va_arg (args, int);
840     }
841 }
842
843 /**
844  * gtk_info_bar_add_buttons:
845  * @info_bar: a #GtkInfoBar
846  * @first_button_text: button text or stock ID
847  * @...: response ID for first button, then more text-response_id pairs,
848  *     ending with %NULL
849  *
850  * Adds more buttons, same as calling gtk_info_bar_add_button()
851  * repeatedly. The variable argument list should be %NULL-terminated
852  * as with gtk_info_bar_new_with_buttons(). Each button must have both
853  * text and response ID.
854  *
855  * Since: 2.18
856  */
857 void
858 gtk_info_bar_add_buttons (GtkInfoBar  *info_bar,
859                           const gchar *first_button_text,
860                           ...)
861 {
862   va_list args;
863
864   va_start (args, first_button_text);
865   add_buttons_valist (info_bar, first_button_text, args);
866   va_end (args);
867 }
868
869 /**
870  * gtk_info_bar_new:
871  *
872  * Creates a new #GtkInfoBar object.
873  *
874  * Returns: a new #GtkInfoBar object
875  *
876  * Since: 2.18
877  */
878 GtkWidget *
879 gtk_info_bar_new (void)
880 {
881    return g_object_new (GTK_TYPE_INFO_BAR, NULL);
882 }
883
884 /**
885  * gtk_info_bar_new_with_buttons:
886  * @first_button_text: stock ID or text to go in first button, or %NULL
887  * @...: response ID for first button, then additional buttons, ending
888  *    with %NULL
889  *
890  * Creates a new #GtkInfoBar with buttons. Button text/response ID
891  * pairs should be listed, with a %NULL pointer ending the list.
892  * Button text can be either a stock ID such as %GTK_STOCK_OK, or
893  * some arbitrary text. A response ID can be any positive number,
894  * or one of the values in the #GtkResponseType enumeration. If the
895  * user clicks one of these dialog buttons, GtkInfoBar will emit
896  * the "response" signal with the corresponding response ID.
897  *
898  * Returns: a new #GtkInfoBar
899  */
900 GtkWidget*
901 gtk_info_bar_new_with_buttons (const gchar *first_button_text,
902                                ...)
903 {
904   GtkInfoBar *info_bar;
905   va_list args;
906
907   info_bar = GTK_INFO_BAR (gtk_info_bar_new ());
908
909   va_start (args, first_button_text);
910   add_buttons_valist (info_bar, first_button_text, args);
911   va_end (args);
912
913   return GTK_WIDGET (info_bar);
914 }
915
916 /**
917  * gtk_info_bar_set_response_sensitive:
918  * @info_bar: a #GtkInfoBar
919  * @response_id: a response ID
920  * @setting: TRUE for sensitive
921  *
922  * Calls gtk_widget_set_sensitive (widget, setting) for each
923  * widget in the info bars's action area with the given response_id.
924  * A convenient way to sensitize/desensitize dialog buttons.
925  *
926  * Since: 2.18
927  */
928 void
929 gtk_info_bar_set_response_sensitive (GtkInfoBar *info_bar,
930                                      gint        response_id,
931                                      gboolean    setting)
932 {
933   GList *children, *list;
934
935   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
936
937   children = gtk_container_get_children (GTK_CONTAINER (info_bar->priv->action_area));
938
939   for (list = children; list; list = list->next)
940     {
941       GtkWidget *widget = list->data;
942       ResponseData *rd = get_response_data (widget, FALSE);
943
944       if (rd && rd->response_id == response_id)
945         gtk_widget_set_sensitive (widget, setting);
946     }
947
948   g_list_free (children);
949 }
950
951 /**
952  * gtk_info_bar_set_default_response:
953  * @info_bar: a #GtkInfoBar
954  * @response_id: a response ID
955  *
956  * Sets the last widget in the info bar's action area with
957  * the given response_id as the default widget for the dialog.
958  * Pressing "Enter" normally activates the default widget.
959  *
960  * Since: 2.18
961  */
962 void
963 gtk_info_bar_set_default_response (GtkInfoBar *info_bar,
964                                    gint        response_id)
965 {
966   GList *children, *list;
967
968   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
969
970   children = gtk_container_get_children (GTK_CONTAINER (info_bar->priv->action_area));
971
972   for (list = children; list; list = list->next)
973     {
974       GtkWidget *widget = list->data;
975       ResponseData *rd = get_response_data (widget, FALSE);
976
977       if (rd && rd->response_id == response_id)
978         gtk_widget_grab_default (widget);
979     }
980
981   g_list_free (children);
982 }
983
984 /**
985  * gtk_info_bar_set_default_response:
986  * @info_bar: a #GtkInfoBar
987  * @response_id: a response ID
988  *
989  * Emits the 'response' signal with the given @response_id.
990  *
991  * Since: 2.18
992  */
993 void
994 gtk_info_bar_response (GtkInfoBar *info_bar,
995                        gint        response_id)
996 {
997   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
998
999   g_signal_emit (info_bar, signals[RESPONSE], 0, response_id);
1000 }
1001
1002 typedef struct
1003 {
1004   gchar *widget_name;
1005   gchar *response_id;
1006 } ActionWidgetInfo;
1007
1008 typedef struct
1009 {
1010   GtkInfoBar *info_bar;
1011   GtkBuilder *builder;
1012   GSList *items;
1013   gchar *response;
1014 } ActionWidgetsSubParserData;
1015
1016 static void
1017 attributes_start_element (GMarkupParseContext  *context,
1018                           const gchar          *element_name,
1019                           const gchar         **names,
1020                           const gchar         **values,
1021                           gpointer              user_data,
1022                           GError              **error)
1023 {
1024   ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1025   guint i;
1026
1027   if (strcmp (element_name, "action-widget") == 0)
1028     {
1029       for (i = 0; names[i]; i++)
1030         if (strcmp (names[i], "response") == 0)
1031           parser_data->response = g_strdup (values[i]);
1032     }
1033   else if (strcmp (element_name, "action-widgets") == 0)
1034     return;
1035   else
1036     g_warning ("Unsupported tag for GtkInfoBar: %s\n", element_name);
1037 }
1038
1039 static void
1040 attributes_text_element (GMarkupParseContext  *context,
1041                          const gchar          *text,
1042                          gsize                 text_len,
1043                          gpointer              user_data,
1044                          GError              **error)
1045 {
1046   ActionWidgetsSubParserData *parser_data = (ActionWidgetsSubParserData*)user_data;
1047   ActionWidgetInfo *item;
1048
1049   if (!parser_data->response)
1050     return;
1051
1052   item = g_new (ActionWidgetInfo, 1);
1053   item->widget_name = g_strndup (text, text_len);
1054   item->response_id = parser_data->response;
1055   parser_data->items = g_slist_prepend (parser_data->items, item);
1056   parser_data->response = NULL;
1057 }
1058
1059 static const GMarkupParser attributes_parser =
1060 {
1061   attributes_start_element,
1062   NULL,
1063   attributes_text_element,
1064 };
1065
1066 gboolean
1067 gtk_info_bar_buildable_custom_tag_start (GtkBuildable  *buildable,
1068                                          GtkBuilder    *builder,
1069                                          GObject       *child,
1070                                          const gchar   *tagname,
1071                                          GMarkupParser *parser,
1072                                          gpointer      *data)
1073 {
1074   ActionWidgetsSubParserData *parser_data;
1075
1076   if (child)
1077     return FALSE;
1078
1079   if (strcmp (tagname, "action-widgets") == 0)
1080     {
1081       parser_data = g_slice_new0 (ActionWidgetsSubParserData);
1082       parser_data->info_bar = GTK_INFO_BAR (buildable);
1083       parser_data->items = NULL;
1084
1085       *parser = attributes_parser;
1086       *data = parser_data;
1087       return TRUE;
1088     }
1089
1090   return parent_buildable_iface->custom_tag_start (buildable, builder, child,
1091                                                    tagname, parser, data);
1092 }
1093
1094 static void
1095 gtk_info_bar_buildable_custom_finished (GtkBuildable *buildable,
1096                                         GtkBuilder   *builder,
1097                                         GObject      *child,
1098                                         const gchar  *tagname,
1099                                         gpointer      user_data)
1100 {
1101   GSList *l;
1102   ActionWidgetsSubParserData *parser_data;
1103   GObject *object;
1104   GtkInfoBar *info_bar;
1105   ResponseData *ad;
1106   guint signal_id;
1107
1108   if (strcmp (tagname, "action-widgets"))
1109     {
1110       parent_buildable_iface->custom_finished (buildable, builder, child,
1111                                                tagname, user_data);
1112       return;
1113     }
1114
1115   info_bar = GTK_INFO_BAR (buildable);
1116   parser_data = (ActionWidgetsSubParserData*)user_data;
1117   parser_data->items = g_slist_reverse (parser_data->items);
1118
1119   for (l = parser_data->items; l; l = l->next)
1120     {
1121       ActionWidgetInfo *item = l->data;
1122
1123       object = gtk_builder_get_object (builder, item->widget_name);
1124       if (!object)
1125         {
1126           g_warning ("Unknown object %s specified in action-widgets of %s",
1127                      item->widget_name,
1128                      gtk_buildable_get_name (GTK_BUILDABLE (buildable)));
1129           continue;
1130         }
1131
1132       ad = get_response_data (GTK_WIDGET (object), TRUE);
1133       ad->response_id = atoi (item->response_id);
1134
1135       if (GTK_IS_BUTTON (object))
1136         signal_id = g_signal_lookup ("clicked", GTK_TYPE_BUTTON);
1137       else
1138         signal_id = GTK_WIDGET_GET_CLASS (object)->activate_signal;
1139
1140       if (signal_id)
1141         {
1142           GClosure *closure;
1143
1144           closure = g_cclosure_new_object (G_CALLBACK (action_widget_activated),
1145                                            G_OBJECT (info_bar));
1146           g_signal_connect_closure_by_id (object,
1147                                           signal_id,
1148                                           0,
1149                                           closure,
1150                                           FALSE);
1151         }
1152
1153       if (ad->response_id == GTK_RESPONSE_HELP)
1154         gtk_button_box_set_child_secondary (GTK_BUTTON_BOX (info_bar->priv->action_area),
1155                                             GTK_WIDGET (object), TRUE);
1156
1157       g_free (item->widget_name);
1158       g_free (item->response_id);
1159       g_free (item);
1160     }
1161   g_slist_free (parser_data->items);
1162   g_slice_free (ActionWidgetsSubParserData, parser_data);
1163 }
1164
1165 /**
1166  * gtk_info_bar_set_message_type:
1167  * @info_bar: a #GtkInfoBar
1168  * @message_type: a #GtkMessageType
1169  *
1170  * Sets the message type of the message area.
1171  * GTK+ uses this type to determine what color to use
1172  * when drawing the message area.
1173  *
1174  * Since: 2.18
1175  */
1176 void
1177 gtk_info_bar_set_message_type (GtkInfoBar     *info_bar,
1178                                GtkMessageType  message_type)
1179 {
1180   GtkInfoBarPrivate *priv;
1181   AtkObject *atk_obj;
1182
1183   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
1184
1185   priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
1186
1187   if (priv->message_type != message_type)
1188     {
1189       priv->message_type = message_type;
1190
1191       gtk_info_bar_update_colors (info_bar);
1192       gtk_widget_queue_draw (GTK_WIDGET (info_bar));
1193
1194       atk_obj = gtk_widget_get_accessible (GTK_WIDGET (info_bar));
1195       if (GTK_IS_ACCESSIBLE (atk_obj))
1196         {
1197           GtkStockItem item;
1198           const char *stock_id = NULL;
1199
1200           atk_object_set_role (atk_obj, ATK_ROLE_ALERT);
1201
1202           switch (message_type)
1203             {
1204             case GTK_MESSAGE_INFO:
1205               stock_id = GTK_STOCK_DIALOG_INFO;
1206               break;
1207
1208             case GTK_MESSAGE_QUESTION:
1209               stock_id = GTK_STOCK_DIALOG_QUESTION;
1210               break;
1211
1212             case GTK_MESSAGE_WARNING:
1213               stock_id = GTK_STOCK_DIALOG_WARNING;
1214               break;
1215
1216             case GTK_MESSAGE_ERROR:
1217               stock_id = GTK_STOCK_DIALOG_ERROR;
1218               break;
1219
1220             case GTK_MESSAGE_OTHER:
1221               break;
1222
1223             default:
1224               g_warning ("Unknown GtkMessageType %u", message_type);
1225               break;
1226             }
1227
1228           if (stock_id)
1229             {
1230               gtk_stock_lookup (stock_id, &item);
1231               atk_object_set_name (atk_obj, item.label);
1232             }
1233         }
1234
1235       g_object_notify (G_OBJECT (info_bar), "message-type");
1236     }
1237 }
1238
1239 /**
1240  * gtk_info_bar_get_message_type:
1241  * @info_bar: a #GtkInfoBar
1242  *
1243  * Returns the message type of the message area.
1244  *
1245  * Returns: the message type of the message area.
1246  *
1247  * Since: 2.18
1248  */
1249 GtkMessageType
1250 gtk_info_bar_get_message_type (GtkInfoBar *info_bar)
1251 {
1252   GtkInfoBarPrivate *priv;
1253
1254   g_return_if_fail (GTK_IS_INFO_BAR (info_bar));
1255
1256   priv = GTK_INFO_BAR_GET_PRIVATE (info_bar);
1257
1258   return priv->message_type;
1259 }
1260
1261
1262 #define __GTK_INFO_BAR_C__
1263 #include "gtkaliasdef.c"