2 * This file is a part of hildon
4 * Copyright (C) 2005, 2006, 2007 Nokia Corporation, all rights reserved.
6 * Contact: Rodrigo Novo <rodrigo.novo@nokia.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * as published by the Free Software Foundation; version 2.1 of
11 * the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful, but
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 * SECTION:hildon-banner
27 * @short_description: A widget used to display timed notifications.
29 * #HildonBanner is a small, pop-up window that can be used to display
30 * a short, timed notification or information to the user. It can
31 * communicate that a task has been finished or that the application
34 * Hildon provides convenient funtions to create and show banners. To
35 * create and show information banners you can use
36 * hildon_banner_show_information(), hildon_banner_show_informationf()
37 * or hildon_banner_show_information_with_markup().
39 * Two more kinds of banners are maintained for backward compatibility
40 * but are no longer recommended in Hildon 2.2. These are the animated
41 * banner (created with hildon_banner_show_animation()) and the
42 * progress banner (created with hildon_banner_show_progress()). See
43 * hildon_gtk_window_set_progress_indicator() for the preferred way of
44 * showing progress notifications in Hildon 2.2.
46 * Information banners dissapear automatically after a certain
47 * period. This is stored in the #HildonBanner:timeout property (in
48 * miliseconds), and can be changed using hildon_banner_set_timeout().
50 * Note that #HildonBanner<!-- -->s should only be used to display
51 * non-critical pieces of information.
59 #include <X11/Xatom.h>
62 #undef HILDON_DISABLE_DEPRECATED
64 #include "hildon-banner.h"
65 #include "hildon-banner-private.h"
66 #include "hildon-defines.h"
67 #include "hildon-gtk.h"
69 /* position relative to the screen */
71 #define HILDON_BANNER_WINDOW_X 0
73 #define HILDON_BANNER_WINDOW_Y HILDON_WINDOW_TITLEBAR_HEIGHT
77 #define HILDON_BANNER_PROGRESS_WIDTH 104
79 #define HILDON_BANNER_LABEL_MAX_TIMED \
80 (gdk_screen_width() - ((HILDON_MARGIN_TRIPLE) * 2))
82 #define HILDON_BANNER_LABEL_MAX_PROGRESS 375 /*265*/
86 #define HILDON_BANNER_DEFAULT_TIMEOUT 3000
90 #define HILDON_BANNER_DEFAULT_PROGRESS_ANIMATION "indicator_update"
92 /* animation related stuff */
94 #define HILDON_BANNER_ANIMATION_FRAMERATE ((float)1000/150)
96 #define HILDON_BANNER_ANIMATION_TMPL "indicator_update%d"
98 #define HILDON_BANNER_ANIMATION_NFRAMES 8
108 static GtkWidget* global_timed_banner = NULL;
111 hildon_banner_timed_quark (void);
114 hildon_banner_bind_style (HildonBanner *self,
118 hildon_banner_timeout (gpointer data);
121 hildon_banner_clear_timeout (HildonBanner *self);
124 hildon_banner_ensure_timeout (HildonBanner *self);
127 hildon_banner_set_property (GObject *object,
133 hildon_banner_get_property (GObject *object,
139 hildon_banner_destroy (GtkObject *object);
142 hildon_banner_real_get_instance (GObject *window,
146 hildon_banner_constructor (GType type,
147 guint n_construct_params,
148 GObjectConstructParam *construct_params);
151 hildon_banner_finalize (GObject *object);
154 hildon_banner_button_press_event (GtkWidget* widget,
155 GdkEventButton* event);
158 hildon_banner_map_event (GtkWidget *widget,
161 hildon_banner_reset_wrap_state (HildonBanner *banner);
164 force_to_wrap_truncated (HildonBanner *banner);
167 hildon_banner_check_position (GtkWidget *widget);
170 hildon_banner_realize (GtkWidget *widget);
173 hildon_banner_class_init (HildonBannerClass *klass);
176 hildon_banner_init (HildonBanner *self);
179 hildon_banner_ensure_child (HildonBanner *self,
180 GtkWidget *user_widget,
183 const gchar *first_property,
187 hildon_banner_get_instance_for_widget (GtkWidget *widget,
190 G_DEFINE_TYPE (HildonBanner, hildon_banner, GTK_TYPE_WINDOW)
193 hildon_banner_timed_quark (void)
195 static GQuark quark = 0;
197 if (G_UNLIKELY(quark == 0))
198 quark = g_quark_from_static_string ("hildon-banner-timed");
203 /* Set the widget and label name to make the correct rc-style attached into them */
205 hildon_banner_bind_style (HildonBanner *self,
206 const gchar *name_sufix)
208 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (self);
213 name = g_strconcat ("HildonBannerLabel-", name_sufix, NULL);
214 gtk_widget_set_name (priv->label, name);
217 name = g_strconcat ("HildonBanner-", name_sufix, NULL);
218 gtk_widget_set_name (GTK_WIDGET (self), name);
222 /* In timeout function we automatically destroy timed banners */
224 simulate_close (GtkWidget* widget)
226 gboolean result = FALSE;
228 /* If the banner is currently visible (it normally should),
229 we simulate clicking the close button of the window.
230 This allows applications to reuse the banner by prevent
232 if (GTK_WIDGET_DRAWABLE (widget))
234 GdkEvent *event = gdk_event_new (GDK_DELETE);
235 event->any.window = g_object_ref (widget->window);
236 event->any.send_event = FALSE;
237 result = gtk_widget_event (widget, event);
238 gdk_event_free (event);
245 hildon_banner_timeout (gpointer data)
248 gboolean continue_timeout = FALSE;
250 GDK_THREADS_ENTER ();
252 g_assert (HILDON_IS_BANNER (data));
254 widget = GTK_WIDGET (data);
255 g_object_ref (widget);
257 continue_timeout = simulate_close (widget);
259 if (! continue_timeout) {
260 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (data);
261 priv->timeout_id = 0;
262 gtk_widget_destroy (widget);
265 g_object_unref (widget);
267 GDK_THREADS_LEAVE ();
269 return continue_timeout;
273 hildon_banner_clear_timeout (HildonBanner *self)
275 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (self);
278 if (priv->timeout_id != 0) {
279 g_source_remove (priv->timeout_id);
280 priv->timeout_id = 0;
288 hildon_banner_ensure_timeout (HildonBanner *self)
290 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (self);
293 if (priv->timeout_id == 0 && priv->is_timed && priv->timeout > 0)
294 priv->timeout_id = g_timeout_add (priv->timeout,
295 hildon_banner_timeout, self);
299 hildon_banner_set_property (GObject *object,
305 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (object);
311 priv->timeout = g_value_get_uint (value);
315 priv->is_timed = g_value_get_boolean (value);
318 case PROP_PARENT_WINDOW:
319 window = g_value_get_object (value);
321 g_object_remove_weak_pointer(G_OBJECT (priv->parent), (gpointer) &priv->parent);
324 gtk_window_set_transient_for (GTK_WINDOW (object), (GtkWindow *) window);
325 priv->parent = (GtkWindow *) window;
328 gtk_window_set_destroy_with_parent (GTK_WINDOW (object), TRUE);
329 g_object_add_weak_pointer(G_OBJECT (window), (gpointer) &priv->parent);
335 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
341 hildon_banner_get_property (GObject *object,
346 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (object);
352 g_value_set_uint (value, priv->timeout);
356 g_value_set_boolean (value, priv->is_timed);
359 case PROP_PARENT_WINDOW:
360 g_value_set_object (value, gtk_window_get_transient_for (GTK_WINDOW (object)));
364 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
370 hildon_banner_destroy (GtkObject *object)
372 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (object);
376 GObject *parent_window = (GObject *) priv->parent;
378 g_assert (HILDON_IS_BANNER (object));
379 self = HILDON_BANNER (object);
381 /* Drop possible global pointer. That can hold reference to us */
382 if ((gpointer) object == (gpointer) global_timed_banner) {
383 global_timed_banner = NULL;
384 g_object_unref (object);
387 /* Remove the data from parent window for timed banners. Those hold reference */
388 if (priv->is_timed && parent_window != NULL) {
389 g_object_set_qdata (parent_window, hildon_banner_timed_quark (), NULL);
392 if (!priv->is_timed && priv->parent) {
393 hildon_gtk_window_set_progress_indicator (priv->parent, 0);
396 (void) hildon_banner_clear_timeout (self);
398 if (GTK_OBJECT_CLASS (hildon_banner_parent_class)->destroy)
399 GTK_OBJECT_CLASS (hildon_banner_parent_class)->destroy (object);
402 /* Search a previous banner instance */
404 hildon_banner_real_get_instance (GObject *window,
408 /* If we have a parent window, the previous instance is stored there */
410 return g_object_get_qdata(window, hildon_banner_timed_quark ());
413 /* System notification instance is stored into global pointer */
414 return (GObject *) global_timed_banner;
417 /* Non-timed banners are normal (non-singleton) objects */
421 /* By overriding constructor we force timed banners to be
422 singletons for each window */
424 hildon_banner_constructor (GType type,
425 guint n_construct_params,
426 GObjectConstructParam *construct_params)
428 GObject *banner, *window = NULL;
429 gboolean timed = FALSE;
432 /* Search banner type information from parameters in order
433 to locate the possible previous banner instance. */
434 for (i = 0; i < n_construct_params; i++)
436 if (strcmp(construct_params[i].pspec->name, "parent-window") == 0)
437 window = g_value_get_object (construct_params[i].value);
438 else if (strcmp(construct_params[i].pspec->name, "is-timed") == 0)
439 timed = g_value_get_boolean (construct_params[i].value);
442 /* Try to get a previous instance if such exists */
443 banner = hildon_banner_real_get_instance (window, timed);
446 /* We have to create a new banner */
447 banner = G_OBJECT_CLASS (hildon_banner_parent_class)->constructor (type, n_construct_params, construct_params);
449 /* Store the newly created singleton instance either into parent
450 window data or into global variables. */
453 g_object_set_qdata_full (G_OBJECT (window), hildon_banner_timed_quark (),
454 g_object_ref (banner), g_object_unref);
456 g_assert (global_timed_banner == NULL);
457 global_timed_banner = g_object_ref (banner);
462 /* FIXME: This is a hack! We have to manually freeze
463 notifications. This is normally done by g_object_init, but we
464 are not going to call that. g_object_newv will otherwise give
465 a critical like this:
467 GLIB CRITICAL ** GLib-GObject - g_object_notify_queue_thaw:
468 assertion `nqueue->freeze_count > 0' failed */
470 g_object_freeze_notify (banner);
471 hildon_banner_reset_wrap_state (HILDON_BANNER (banner));
474 /* We restart possible timeouts for each new timed banner request */
475 if (timed && hildon_banner_clear_timeout (HILDON_BANNER (banner)))
476 hildon_banner_ensure_timeout (HILDON_BANNER(banner));
482 hildon_banner_finalize (GObject *object)
484 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (object);
487 g_object_remove_weak_pointer(G_OBJECT (priv->parent), (gpointer) &priv->parent);
490 G_OBJECT_CLASS (hildon_banner_parent_class)->finalize (object);
494 hildon_banner_button_press_event (GtkWidget* widget,
495 GdkEventButton* event)
497 gboolean result = simulate_close (widget);
500 /* signal emission not stopped - basically behave like
501 * gtk_main_do_event() for a delete event, but just hide the
502 * banner instead of destroying it, as it is already meant to
503 * be destroyed by hildon_banner_timeout() (if it's timed) or
504 * the application (if it's not). */
505 gtk_widget_hide (widget);
511 #if defined(MAEMO_GTK)
513 hildon_banner_map (GtkWidget *widget)
515 if (GTK_WIDGET_CLASS (hildon_banner_parent_class)->map) {
516 /* Make the banner temporary _before_ mapping it, to avoid closing
517 * other temporary windows */
518 gtk_window_set_is_temporary (GTK_WINDOW (widget), TRUE);
520 GTK_WIDGET_CLASS (hildon_banner_parent_class)->map (widget);
522 /* Make the banner non-temporary _after_ mapping it, to avoid
523 * being closed by other non-temporary windows */
524 gtk_window_set_is_temporary (GTK_WINDOW (widget), FALSE);
526 hildon_banner_check_position (widget);
531 /* We start the timer for timed notifications after the window appears on screen */
533 hildon_banner_map_event (GtkWidget *widget,
536 gboolean result = FALSE;
538 if (GTK_WIDGET_CLASS (hildon_banner_parent_class)->map_event)
539 result = GTK_WIDGET_CLASS (hildon_banner_parent_class)->map_event (widget, event);
541 hildon_banner_ensure_timeout (HILDON_BANNER(widget));
547 hildon_banner_reset_wrap_state (HildonBanner *banner)
550 HildonBannerPrivate *priv;
552 priv = HILDON_BANNER_GET_PRIVATE (banner);
555 layout = gtk_label_get_layout (GTK_LABEL (priv->label));
557 pango_layout_set_width (layout, -1);
558 priv->has_been_wrapped = FALSE;
559 priv->has_been_truncated = FALSE;
561 gtk_widget_set_size_request (priv->label, -1, -1);
562 gtk_widget_set_size_request (GTK_WIDGET (banner), -1, -1);
565 /* force to wrap truncated label by setting explicit size request
566 * see N#27000 and G#329646 */
568 force_to_wrap_truncated (HildonBanner *banner)
572 int width_text, width_max;
575 PangoRectangle logical;
576 GtkRequisition requisition;
577 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (banner);
579 g_return_if_fail (priv);
581 label = GTK_LABEL (priv->label);
583 layout = gtk_label_get_layout (label);
585 pango_layout_get_extents (layout, NULL, &logical);
586 width_text = PANGO_PIXELS (logical.width);
588 width_max = priv->is_timed ? HILDON_BANNER_LABEL_MAX_TIMED
589 : HILDON_BANNER_LABEL_MAX_PROGRESS;
591 /* If the width of the label is going to exceed the maximum allowed
592 * width, enforce the maximum allowed width now.
594 if (priv->has_been_wrapped
595 || width_text >= width_max
596 || pango_layout_is_wrapped (layout)) {
597 /* Force wrapping by setting the maximum size */
600 priv->has_been_wrapped = TRUE;
603 /* Make the label update its layout; and update our layout pointer
604 * because the layout will be cleared and refreshed.
606 gtk_widget_set_size_request (GTK_WIDGET (label), width, height);
607 gtk_widget_size_request (GTK_WIDGET (label), &requisition);
609 layout = gtk_label_get_layout (label);
611 /* If the layout has now been wrapped and exceeds 3 lines, we truncate
612 * the rest of the label according to spec.
614 if (priv->has_been_truncated
615 || (pango_layout_is_wrapped (layout)
616 && pango_layout_get_line_count (layout) > 3)) {
619 pango_layout_get_extents (layout, NULL, &logical);
620 lines = pango_layout_get_line_count (layout);
622 /* This calculation assumes that the same font is used
623 * throughout the banner -- this is usually the case on maemo
625 * FIXME: Pango >= 1.20 has pango_layout_set_height().
627 height = (PANGO_PIXELS (logical.height) * 3) / lines + 1;
628 priv->has_been_truncated = TRUE;
631 /* Set the new width/height if applicable */
632 gtk_widget_set_size_request (GTK_WIDGET (label), width, height);
637 hildon_banner_check_position (GtkWidget *widget)
642 gtk_widget_set_size_request (widget, gdk_screen_width (), -1);
644 force_to_wrap_truncated (HILDON_BANNER(widget)); /* see N#27000 and G#329646 */
646 gtk_widget_size_request (widget, &req);
653 x = HILDON_BANNER_WINDOW_X;
655 y = HILDON_BANNER_WINDOW_Y;
657 gtk_window_move (GTK_WINDOW (widget), x, y);
661 hildon_banner_realize (GtkWidget *widget)
665 guint32 portrait = 1;
666 const gchar *notification_type = "_HILDON_NOTIFICATION_TYPE_BANNER";
667 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (widget);
670 /* We let the parent to init widget->window before we need it */
671 if (GTK_WIDGET_CLASS (hildon_banner_parent_class)->realize)
672 GTK_WIDGET_CLASS (hildon_banner_parent_class)->realize (widget);
674 /* We use special hint to turn the banner into information notification. */
675 gdk_window_set_type_hint (widget->window, GDK_WINDOW_TYPE_HINT_NOTIFICATION);
676 gtk_window_set_transient_for (GTK_WINDOW (widget), (GtkWindow *) priv->parent);
678 hildon_banner_check_position (widget);
680 gdkwin = widget->window;
682 /* Set the _HILDON_NOTIFICATION_TYPE property so Matchbox places the window correctly */
683 atom = gdk_atom_intern ("_HILDON_NOTIFICATION_TYPE", FALSE);
684 gdk_property_change (gdkwin, atom, gdk_x11_xatom_to_atom (XA_STRING), 8, GDK_PROP_MODE_REPLACE,
685 (gpointer) notification_type, strlen (notification_type));
687 /* HildonBanner supports portrait mode */
688 atom = gdk_atom_intern ("_HILDON_PORTRAIT_MODE_SUPPORT", FALSE);
689 gdk_property_change (gdkwin, atom, gdk_x11_xatom_to_atom (XA_CARDINAL), 32,
690 GDK_PROP_MODE_REPLACE, (gpointer) &portrait, 1);
694 hildon_banner_class_init (HildonBannerClass *klass)
696 GObjectClass *object_class;
697 GtkWidgetClass *widget_class;
699 object_class = G_OBJECT_CLASS (klass);
700 widget_class = GTK_WIDGET_CLASS (klass);
702 /* Append private structure to class. This is more elegant than
703 on g_new based approach */
704 g_type_class_add_private (klass, sizeof (HildonBannerPrivate));
706 /* Override virtual methods */
707 object_class->constructor = hildon_banner_constructor;
708 object_class->finalize = hildon_banner_finalize;
709 object_class->set_property = hildon_banner_set_property;
710 object_class->get_property = hildon_banner_get_property;
711 GTK_OBJECT_CLASS (klass)->destroy = hildon_banner_destroy;
712 widget_class->map_event = hildon_banner_map_event;
713 widget_class->realize = hildon_banner_realize;
714 widget_class->button_press_event = hildon_banner_button_press_event;
715 #if defined(MAEMO_GTK)
716 widget_class->map = hildon_banner_map;
719 /* Install properties.
720 We need construct properties for singleton purposes */
723 * HildonBanner:parent-window:
725 * The window for which the banner will be singleton.
728 g_object_class_install_property (object_class, PROP_PARENT_WINDOW,
729 g_param_spec_object ("parent-window",
731 "The window for which the banner will be singleton",
732 GTK_TYPE_WINDOW, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
735 * HildonBanner:is-timed:
737 * Whether the banner is timed and goes away automatically.
740 g_object_class_install_property (object_class, PROP_IS_TIMED,
741 g_param_spec_boolean ("is-timed",
743 "Whether or not the notification goes away automatically "
744 "after the specified time has passed",
745 FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
748 * HildonBanner:timeout:
750 * The time before making the banner banner go away. This needs
751 * to be adjusted before the banner is mapped to the screen.
754 g_object_class_install_property (object_class, PROP_TIMEOUT,
755 g_param_spec_uint ("timeout",
757 "The time before making the banner banner go away",
760 HILDON_BANNER_DEFAULT_TIMEOUT,
761 G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
765 hildon_banner_init (HildonBanner *self)
767 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (self);
772 /* Initialize the common layout inside banner */
773 priv->layout = gtk_hbox_new (FALSE, HILDON_MARGIN_DEFAULT);
775 priv->label = g_object_new (GTK_TYPE_LABEL, NULL);
776 gtk_label_set_line_wrap (GTK_LABEL (priv->label), TRUE);
777 gtk_label_set_line_wrap_mode (GTK_LABEL (priv->label), PANGO_WRAP_WORD_CHAR);
779 gtk_container_set_border_width (GTK_CONTAINER (priv->layout), HILDON_MARGIN_DEFAULT);
780 gtk_container_add (GTK_CONTAINER (self), priv->layout);
781 gtk_box_pack_start (GTK_BOX (priv->layout), priv->label, TRUE, TRUE, 0);
783 gtk_window_set_accept_focus (GTK_WINDOW (self), FALSE);
785 hildon_banner_reset_wrap_state (self);
787 gtk_widget_add_events (GTK_WIDGET (self), GDK_BUTTON_PRESS_MASK);
790 /* Makes sure that icon/progress item contains the desired type
791 of item. If possible, tries to avoid creating a new widget but
792 reuses the existing one */
794 hildon_banner_ensure_child (HildonBanner *self,
795 GtkWidget *user_widget,
798 const gchar *first_property,
803 HildonBannerPrivate *priv = HILDON_BANNER_GET_PRIVATE (self);
807 widget = priv->main_item;
808 va_start (args, first_property);
810 /* Reuse existing widget if possible */
811 if (! user_widget && G_TYPE_CHECK_INSTANCE_TYPE (widget, type))
813 g_object_set_valist (G_OBJECT (widget), first_property, args);
817 /* We have to abandon old content widget */
819 gtk_container_remove (GTK_CONTAINER (priv->layout), widget);
821 /* Use user provided widget or create a new one */
822 priv->main_item = widget = user_widget ?
823 user_widget : GTK_WIDGET (g_object_new_valist(type, first_property, args));
824 gtk_box_pack_start (GTK_BOX (priv->layout), widget, TRUE, TRUE, 0);
827 /* We make sure that the widget exists in desired position. Different
828 banners place this child widget to different places */
829 gtk_box_reorder_child (GTK_BOX (priv->layout), widget, pos);
833 /* Creates a new banner instance or uses an existing one */
835 hildon_banner_get_instance_for_widget (GtkWidget *widget,
840 window = widget ? gtk_widget_get_ancestor (widget, GTK_TYPE_WINDOW) : NULL;
841 return g_object_new (HILDON_TYPE_BANNER, "parent-window", window, "is-timed", timed, NULL);
845 hildon_banner_create_animation (void)
848 GdkPixbufSimpleAnim *anim;
851 GError *error = NULL;
855 anim = gdk_pixbuf_simple_anim_new (HILDON_ICON_PIXEL_SIZE_STYLUS,
856 HILDON_ICON_PIXEL_SIZE_STYLUS,
857 HILDON_BANNER_ANIMATION_FRAMERATE);
858 gdk_pixbuf_simple_anim_set_loop (anim, TRUE);
859 theme = gtk_icon_theme_get_default ();
861 for (i = 1; i <= HILDON_BANNER_ANIMATION_NFRAMES; i++) {
862 icon_name = g_strdup_printf (HILDON_BANNER_ANIMATION_TMPL, i);
863 frame = gtk_icon_theme_load_icon (theme, icon_name, HILDON_ICON_PIXEL_SIZE_STYLUS,
867 g_warning ("Icon theme lookup for icon `%s' failed: %s",
868 icon_name, error->message);
869 g_error_free (error);
872 gdk_pixbuf_simple_anim_add_frame (anim, frame);
875 g_object_unref (frame);
879 image = gtk_image_new_from_animation (GDK_PIXBUF_ANIMATION (anim));
880 g_object_unref (anim);
886 * hildon_banner_show_information:
887 * @widget: the #GtkWidget that is the owner of the banner
888 * @icon_name: since Hildon 2.2 this parameter is not used anymore and
889 * any value that you pass will be ignored
890 * @text: Text to display
892 * This function creates and displays an information banner that
893 * automatically goes away after certain time period. For each window
894 * in your application there can only be one timed banner, so if you
895 * spawn a new banner before the earlier one has timed out, the
896 * previous one will be replaced.
898 * Returns: The newly created banner
902 hildon_banner_show_information (GtkWidget *widget,
903 const gchar *icon_name,
906 HildonBanner *banner;
908 g_return_val_if_fail (text != NULL, NULL);
911 banner = hildon_banner_get_instance_for_widget (widget, TRUE);
913 hildon_banner_set_text (banner, text);
914 hildon_banner_bind_style (banner, "information");
916 /* Show the banner, since caller cannot do that */
917 gtk_widget_show_all (GTK_WIDGET (banner));
919 return (GtkWidget *) banner;
923 * hildon_banner_show_informationf:
924 * @widget: the #GtkWidget that is the owner of the banner
925 * @icon_name: since Hildon 2.2 this parameter is not used anymore and
926 * any value that you pass will be ignored
927 * @format: a printf-like format string
928 * @Varargs: arguments for the format string
930 * A helper function for #hildon_banner_show_information with
933 * Returns: the newly created banner
936 hildon_banner_show_informationf (GtkWidget *widget,
937 const gchar *icon_name,
941 g_return_val_if_fail (format != NULL, NULL);
947 va_start (args, format);
948 message = g_strdup_vprintf (format, args);
951 banner = hildon_banner_show_information (widget, icon_name, message);
959 * hildon_banner_show_information_with_markup:
960 * @widget: the #GtkWidget that wants to display banner
961 * @icon_name: since Hildon 2.2 this parameter is not used anymore and
962 * any value that you pass will be ignored
963 * @markup: a markup string to display (see <link linkend="PangoMarkupFormat">Pango markup format</link>)
965 * This function creates and displays an information banner that
966 * automatically goes away after certain time period. For each window
967 * in your application there can only be one timed banner, so if you
968 * spawn a new banner before the earlier one has timed out, the
969 * previous one will be replaced.
971 * Returns: the newly created banner
975 hildon_banner_show_information_with_markup (GtkWidget *widget,
976 const gchar *icon_name,
979 HildonBanner *banner;
981 g_return_val_if_fail (icon_name == NULL || icon_name[0] != 0, NULL);
982 g_return_val_if_fail (markup != NULL, NULL);
985 banner = hildon_banner_get_instance_for_widget (widget, TRUE);
987 hildon_banner_set_markup (banner, markup);
988 hildon_banner_bind_style (banner, "information");
990 /* Show the banner, since caller cannot do that */
991 gtk_widget_show_all (GTK_WIDGET (banner));
993 return (GtkWidget *) banner;
997 * hildon_banner_show_animation:
998 * @widget: the #GtkWidget that wants to display banner
999 * @animation_name: since Hildon 2.2 this parameter is not used
1000 * anymore and any value that you pass will be
1002 * @text: the text to display.
1004 * Shows an animated progress notification. It's recommended not to try
1005 * to show more than one progress notification at a time, since
1006 * they will appear on top of each other. You can use progress
1007 * notifications with timed banners. In this case the banners are
1008 * located so that you can somehow see both.
1010 * Please note that banners are destroyed automatically once the
1011 * window they are attached to is closed. The pointer that you receive
1012 * with this function does not contain additional references, so it
1013 * can become invalid without warning (this is true for all toplevel
1014 * windows in gtk). To make sure that the banner does not disappear
1015 * automatically, you can separately ref the return value (this
1016 * doesn't prevent the banner from disappearing, just the object from
1017 * being finalized). In this case you have to call both
1018 * gtk_widget_destroy() followed by g_object_unref() (in this order).
1020 * Returns: a #HildonBanner widget. You must call gtk_widget_destroy()
1021 * once you are done with the banner.
1023 * Deprecated: Hildon 2.2: use
1024 * hildon_gtk_window_set_progress_indicator() instead.
1027 hildon_banner_show_animation (GtkWidget *widget,
1028 const gchar *animation_name,
1031 HildonBanner *banner;
1032 GtkWidget *image_widget;
1034 g_return_val_if_fail (text != NULL, NULL);
1036 image_widget = hildon_banner_create_animation ();
1038 /* Prepare banner */
1039 banner = hildon_banner_get_instance_for_widget (widget, FALSE);
1040 hildon_banner_ensure_child (banner, image_widget, 0,
1041 GTK_TYPE_IMAGE, "yalign", 0.0, NULL);
1043 hildon_banner_set_text (banner, text);
1044 hildon_banner_bind_style (banner, "animation");
1047 gtk_widget_show_all (GTK_WIDGET (banner));
1049 return (GtkWidget *) banner;
1053 * hildon_banner_show_progress:
1054 * @widget: the #GtkWidget that wants to display banner
1055 * @bar: since Hildon 2.2 this parameter is not used anymore and
1056 * any value that you pass will be ignored
1057 * @text: text to display.
1059 * Shows progress notification. See #hildon_banner_show_animation
1060 * for more information.
1062 * Returns: a #HildonBanner widget. You must call #gtk_widget_destroy
1063 * once you are done with the banner.
1065 * Deprecated: Hildon 2.2: use hildon_gtk_window_set_progress_indicator() instead.
1068 hildon_banner_show_progress (GtkWidget *widget,
1069 GtkProgressBar *bar,
1072 HildonBanner *banner;
1073 HildonBannerPrivate *priv;
1075 g_return_val_if_fail (text != NULL, NULL);
1077 /* Prepare banner */
1078 banner = hildon_banner_get_instance_for_widget (widget, FALSE);
1079 priv = HILDON_BANNER_GET_PRIVATE (banner);
1082 hildon_banner_set_text (banner, text);
1083 hildon_banner_bind_style (banner, "progress");
1086 hildon_gtk_window_set_progress_indicator (priv->parent, 1);
1088 /* Show the banner */
1089 gtk_widget_show_all (GTK_WIDGET (banner));
1091 return GTK_WIDGET (banner);
1095 * hildon_banner_set_text:
1096 * @self: a #HildonBanner widget
1097 * @text: a new text to display in banner
1099 * Sets the text that is displayed in the banner.
1103 hildon_banner_set_text (HildonBanner *self,
1107 HildonBannerPrivate *priv;
1108 const gchar *existing_text;
1110 g_return_if_fail (HILDON_IS_BANNER (self));
1112 priv = HILDON_BANNER_GET_PRIVATE (self);
1115 label = GTK_LABEL (priv->label);
1116 existing_text = gtk_label_get_text (label);
1118 if (existing_text != NULL &&
1120 strcmp (existing_text, text) != 0) {
1121 gtk_label_set_text (label, text);
1122 hildon_banner_reset_wrap_state (self);
1125 hildon_banner_check_position (GTK_WIDGET (self));
1129 * hildon_banner_set_markup:
1130 * @self: a #HildonBanner widget
1131 * @markup: a new text with Pango markup to display in the banner
1133 * Sets the text with markup that is displayed in the banner.
1137 hildon_banner_set_markup (HildonBanner *self,
1138 const gchar *markup)
1141 HildonBannerPrivate *priv;
1143 g_return_if_fail (HILDON_IS_BANNER (self));
1145 priv = HILDON_BANNER_GET_PRIVATE (self);
1148 label = GTK_LABEL (priv->label);
1149 gtk_label_set_markup (label, markup);
1151 hildon_banner_reset_wrap_state (self);
1153 hildon_banner_check_position (GTK_WIDGET(self));
1157 * hildon_banner_set_fraction:
1158 * @self: a #HildonBanner widget
1159 * @fraction: #gdouble
1161 * The fraction is the completion of progressbar,
1162 * the scale is from 0.0 to 1.0.
1163 * Sets the amount of fraction the progressbar has.
1165 * Note that this method only has effect if @self was created with
1166 * hildon_banner_show_progress()
1168 * Deprecated: This function does nothing. As of Hildon 2.2, hildon
1169 * banners don't have progress bars.
1172 hildon_banner_set_fraction (HildonBanner *self,
1178 * hildon_banner_set_timeout:
1179 * @self: a #HildonBanner widget
1180 * @timeout: timeout to set in miliseconds.
1182 * Sets the timeout on the banner. After the given amount of miliseconds
1183 * has elapsed the banner will go away. Note that settings this only makes
1184 * sense on the banners that are timed and that have not been yet displayed
1187 * Note that this method only has effect if @self is an information
1188 * banner (created using hildon_banner_show_information() and
1192 hildon_banner_set_timeout (HildonBanner *self,
1195 HildonBannerPrivate *priv;
1197 g_return_if_fail (HILDON_IS_BANNER (self));
1198 priv = HILDON_BANNER_GET_PRIVATE (self);
1201 priv->timeout = timeout;
1205 * hildon_banner_set_icon:
1206 * @self: a #HildonBanner widget
1207 * @icon_name: the name of icon to use. Can be %NULL for default icon
1209 * Sets the icon to be used in the banner.
1211 * Deprecated: This function does nothing. As of hildon 2.2, hildon
1212 * banners don't allow changing their icons.
1215 hildon_banner_set_icon (HildonBanner *self,
1216 const gchar *icon_name)
1221 * hildon_banner_set_icon_from_file:
1222 * @self: a #HildonBanner widget
1223 * @icon_file: the filename of icon to use. Can be %NULL for default icon
1225 * Sets the icon from its filename to be used in the banner.
1227 * Deprecated: This function does nothing. As of hildon 2.2, hildon
1228 * banners don't allow changing their icons.
1231 hildon_banner_set_icon_from_file (HildonBanner *self,
1232 const gchar *icon_file)