1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
8 * * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * * Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * * Neither the name of the Nokia Corporation nor the names of its
14 * contributors may be used to endorse or promote products derived from
15 * this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
18 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
20 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
21 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
24 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
25 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
26 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 #include "modest-gnome-info-bar.h"
32 #include <gtk/gtkprogressbar.h>
33 #include <gtk/gtkstatusbar.h>
34 /* include other impl specific header files */
36 /* 'private'/'protected' functions */
37 static void modest_gnome_info_bar_class_init (ModestGnomeInfoBarClass *klass);
38 static void modest_gnome_info_bar_init (ModestGnomeInfoBar *obj);
39 static void modest_gnome_info_bar_finalize (GObject *obj);
41 static void modest_gnome_info_bar_add_operation (ModestProgressObject *self,
42 ModestMailOperation *mail_op);
44 static void modest_gnome_info_bar_remove_operation (ModestProgressObject *self,
45 ModestMailOperation *mail_op);
47 static void on_progress_changed (ModestMailOperation *mail_op,
48 ModestGnomeInfoBar *self);
50 static gboolean progressbar_clean (GtkProgressBar *bar);
51 static gboolean statusbar_clean (GtkStatusbar *bar);
60 typedef struct _ObservableData ObservableData;
61 struct _ObservableData {
63 ModestMailOperation *mail_op;
66 typedef struct _ModestGnomeInfoBarPrivate ModestGnomeInfoBarPrivate;
67 struct _ModestGnomeInfoBarPrivate {
69 ModestMailOperation *current;
71 GtkWidget *status_bar;
72 GtkWidget *progress_bar;
74 guint status_bar_timeout;
75 guint progress_bar_timeout;
78 #define MODEST_GNOME_INFO_BAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
79 MODEST_TYPE_GNOME_INFO_BAR, \
80 ModestGnomeInfoBarPrivate))
82 static GtkHBoxClass *parent_class = NULL;
84 /* uncomment the following if you have defined any signals */
85 /* static guint signals[LAST_SIGNAL] = {0}; */
88 modest_progress_object_init (gpointer g, gpointer iface_data)
90 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
92 klass->add_operation_func = modest_gnome_info_bar_add_operation;
93 klass->remove_operation_func = modest_gnome_info_bar_remove_operation;
97 modest_gnome_info_bar_get_type (void)
99 static GType my_type = 0;
101 static const GTypeInfo my_info = {
102 sizeof(ModestGnomeInfoBarClass),
103 NULL, /* base init */
104 NULL, /* base finalize */
105 (GClassInitFunc) modest_gnome_info_bar_class_init,
106 NULL, /* class finalize */
107 NULL, /* class data */
108 sizeof(ModestGnomeInfoBar),
110 (GInstanceInitFunc) modest_gnome_info_bar_init,
114 static const GInterfaceInfo modest_progress_object_info =
116 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
117 NULL, /* interface_finalize */
118 NULL /* interface_data */
121 my_type = g_type_register_static (GTK_TYPE_HBOX,
122 "ModestGnomeInfoBar",
125 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
126 &modest_progress_object_info);
132 modest_gnome_info_bar_class_init (ModestGnomeInfoBarClass *klass)
134 GObjectClass *gobject_class;
135 gobject_class = (GObjectClass*) klass;
137 parent_class = g_type_class_peek_parent (klass);
138 gobject_class->finalize = modest_gnome_info_bar_finalize;
140 g_type_class_add_private (gobject_class, sizeof(ModestGnomeInfoBarPrivate));
144 modest_gnome_info_bar_init (ModestGnomeInfoBar *obj)
146 ModestGnomeInfoBarPrivate *priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE(obj);
148 priv->observables = NULL;
149 priv->current = NULL;
152 priv->status_bar = gtk_statusbar_new ();
153 gtk_statusbar_set_has_resize_grip (GTK_STATUSBAR (priv->status_bar), FALSE);
156 priv->progress_bar = gtk_progress_bar_new ();
157 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar), 1.0);
158 gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar),
159 PANGO_ELLIPSIZE_END);
162 priv->status_bar_timeout = 0;
163 priv->progress_bar_timeout = 0;
166 gtk_box_pack_start (GTK_BOX (obj), priv->status_bar, TRUE, TRUE, 0);
167 gtk_box_pack_start (GTK_BOX (obj), priv->progress_bar, FALSE, FALSE, 0);
171 destroy_observable_data (ObservableData *data)
173 g_signal_handler_disconnect (data->mail_op, data->signal_handler);
174 g_object_unref (data->mail_op);
178 modest_gnome_info_bar_finalize (GObject *obj)
180 ModestGnomeInfoBarPrivate *priv;
182 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE(obj);
183 if (priv->observables) {
186 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
187 destroy_observable_data ((ObservableData *) tmp->data);
190 g_slist_free (priv->observables);
191 priv->observables = NULL;
194 if (priv->status_bar_timeout > 0) {
195 g_source_remove (priv->status_bar_timeout);
196 priv->status_bar_timeout = 0;
199 if (priv->progress_bar_timeout > 0) {
200 g_source_remove (priv->progress_bar_timeout);
201 priv->progress_bar_timeout = 0;
204 G_OBJECT_CLASS(parent_class)->finalize (obj);
208 modest_gnome_info_bar_new (void)
210 return GTK_WIDGET (g_object_new (MODEST_TYPE_GNOME_INFO_BAR, NULL));
214 modest_gnome_info_bar_add_operation (ModestProgressObject *self,
215 ModestMailOperation *mail_op)
217 ModestGnomeInfoBar *me;
218 ObservableData *data;
219 ModestGnomeInfoBarPrivate *priv;
221 me = MODEST_GNOME_INFO_BAR (self);
222 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (me);
224 data = g_malloc0 (sizeof (ObservableData));
225 data->mail_op = g_object_ref (mail_op);
226 data->signal_handler = g_signal_connect (data->mail_op,
228 G_CALLBACK (on_progress_changed),
231 if (priv->observables == NULL) {
232 priv->current = mail_op;
234 priv->observables = g_slist_append (priv->observables, data);
238 compare_observable_data (ObservableData *data1, ObservableData *data2)
240 if (data1->mail_op == data2->mail_op)
247 modest_gnome_info_bar_remove_operation (ModestProgressObject *self,
248 ModestMailOperation *mail_op)
250 ModestGnomeInfoBar *me;
251 ModestGnomeInfoBarPrivate *priv;
254 me = MODEST_GNOME_INFO_BAR (self);
255 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (me);
257 link = g_slist_find_custom (priv->observables,
259 (GCompareFunc) compare_observable_data);
261 /* Remove the item */
263 priv->observables = g_slist_remove_link (priv->observables, link);
264 destroy_observable_data ((ObservableData *) link->data);
267 /* Update the current mail operation */
268 if (priv->current == mail_op) {
269 if (priv->observables)
270 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
272 priv->current = NULL;
274 /* Refresh the view */
275 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
280 on_progress_changed (ModestMailOperation *mail_op,
281 ModestGnomeInfoBar *self)
283 ModestGnomeInfoBarPrivate *priv;
285 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
287 /* If the mail operation is the currently shown one */
288 if (priv->current == mail_op) {
291 msg = g_strdup_printf ("Mail operation %d of %d",
292 modest_mail_operation_get_task_done (mail_op),
293 modest_mail_operation_get_task_total (mail_op));
294 modest_gnome_info_bar_set_message (self, msg);
300 progressbar_clean (GtkProgressBar *bar)
302 gtk_progress_bar_set_fraction (bar, 0);
303 gtk_progress_bar_set_text (bar, 0);
308 statusbar_clean (GtkStatusbar *bar)
310 gtk_statusbar_push (bar, 0, "");
315 modest_gnome_info_bar_set_message (ModestGnomeInfoBar *self,
316 const gchar *message)
318 ModestGnomeInfoBarPrivate *priv;
320 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
322 /* Set a message. Clean it after 2.5 seconds */
323 gtk_statusbar_push (GTK_STATUSBAR (priv->status_bar), 0, message);
324 priv->status_bar_timeout = g_timeout_add (2500,
325 (GSourceFunc) statusbar_clean,
330 modest_gnome_info_bar_set_progress (ModestGnomeInfoBar *self,
331 const gchar *message,
335 ModestGnomeInfoBarPrivate *priv;
337 priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
341 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
342 (gdouble)done/(gdouble)total);
344 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
347 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);