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.
30 #include <glib/gi18n.h>
32 #include <widgets/modest-combo-box.h>
33 #include "modest-progress-bar-widget.h"
35 #include "modest-platform.h"
36 #include "modest-runtime.h"
38 /* 'private'/'protected' functions */
39 static void modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass);
40 static void modest_progress_bar_widget_init (ModestProgressBarWidget *obj);
41 static void modest_progress_bar_widget_finalize (GObject *obj);
43 static void modest_progress_bar_add_operation (ModestProgressObject *self,
44 ModestMailOperation *mail_op);
46 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
47 ModestMailOperation *mail_op);
49 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
51 static void modest_progress_bar_cancel_all_operations (ModestProgressObject *self);
53 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
55 static void on_progress_changed (ModestMailOperation *mail_op,
56 ModestMailOperationState *state,
57 ModestProgressBarWidget *self);
59 static gboolean progressbar_clean (GtkProgressBar *bar);
74 typedef struct _ObservableData ObservableData;
75 struct _ObservableData {
77 ModestMailOperation *mail_op;
80 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
81 struct _ModestProgressBarWidgetPrivate {
83 ModestMailOperation *current;
85 GtkWidget *progress_bar;
87 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
88 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
89 ModestProgressBarWidgetPrivate))
92 static GtkContainerClass *parent_class = NULL;
94 /* uncomment the following if you have defined any signals */
95 /* static guint signals[LAST_SIGNAL] = {0}; */
98 modest_progress_object_init (gpointer g, gpointer iface_data)
100 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
102 klass->add_operation_func = modest_progress_bar_add_operation;
103 klass->remove_operation_func = modest_progress_bar_remove_operation;
104 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
105 klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
106 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
111 modest_progress_bar_widget_get_type (void)
113 static GType my_type = 0;
115 static const GTypeInfo my_info = {
116 sizeof(ModestProgressBarWidgetClass),
117 NULL, /* base init */
118 NULL, /* base finalize */
119 (GClassInitFunc) modest_progress_bar_widget_class_init,
120 NULL, /* class finalize */
121 NULL, /* class data */
122 sizeof(ModestProgressBarWidget),
124 (GInstanceInitFunc) modest_progress_bar_widget_init,
128 static const GInterfaceInfo modest_progress_object_info =
130 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
131 NULL, /* interface_finalize */
132 NULL /* interface_data */
135 my_type = g_type_register_static (GTK_TYPE_VBOX,
136 "ModestProgressBarWidget",
139 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
140 &modest_progress_object_info);
146 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
148 GObjectClass *gobject_class;
149 gobject_class = (GObjectClass*) klass;
151 parent_class = g_type_class_peek_parent (klass);
152 gobject_class->finalize = modest_progress_bar_widget_finalize;
154 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
156 /* signal definitions go here, e.g.: */
157 /* signals[DATA_CHANGED_SIGNAL] = */
158 /* g_signal_new ("data_changed", */
159 /* G_TYPE_FROM_CLASS (klass), */
160 /* G_SIGNAL_RUN_FIRST, */
161 /* G_STRUCT_OFFSET(ModestProgressBarWidgetClass, data_changed), */
163 /* g_cclosure_marshal_VOID__VOID, */
164 /* G_TYPE_NONE, 0); */
168 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
171 ModestProgressBarWidgetPrivate *priv;
172 GtkWidget *align = NULL;
176 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
179 align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
181 /* Build GtkProgressBar */
182 adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
183 priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
186 gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
187 gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
188 gtk_widget_size_request (priv->progress_bar, &req);
189 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
190 gtk_widget_size_request (align, &req);
192 /* Add progress bar widget */
193 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
194 gtk_widget_show_all (GTK_WIDGET(self));
198 modest_progress_bar_widget_finalize (GObject *obj)
200 ModestProgressBarWidgetPrivate *priv;
202 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
203 if (priv->observables) {
206 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
207 ObservableData *ob_data = tmp->data;
208 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
209 g_object_unref (ob_data->mail_op);
212 g_slist_free (priv->observables);
213 priv->observables = NULL;
216 G_OBJECT_CLASS(parent_class)->finalize (obj);
221 modest_progress_bar_add_operation (ModestProgressObject *self,
222 ModestMailOperation *mail_op)
224 ModestProgressBarWidget *me = NULL;
225 ObservableData *data = NULL;
226 ModestProgressBarWidgetPrivate *priv = NULL;
227 ModestMailOperationState *state = NULL;
229 me = MODEST_PROGRESS_BAR_WIDGET (self);
230 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
232 data = g_malloc0 (sizeof (ObservableData));
233 data->mail_op = g_object_ref (mail_op);
234 data->signal_handler = g_signal_connect (data->mail_op,
236 G_CALLBACK (on_progress_changed),
238 /* Set curent operation */
239 if (priv->current == NULL) {
240 priv->current = mail_op;
242 /* Call progress_change handler to initialize progress message */
243 state = g_malloc0(sizeof(ModestMailOperationState));
246 state->op_type = modest_mail_operation_get_type_operation (mail_op);
247 on_progress_changed (mail_op, state, me);
251 /* Add operation to obserbable objects list */
252 priv->observables = g_slist_prepend (priv->observables, data);
256 compare_observable_data (ObservableData *data1, ObservableData *data2)
258 if (data1->mail_op == data2->mail_op)
265 modest_progress_bar_remove_operation (ModestProgressObject *self,
266 ModestMailOperation *mail_op)
268 ModestProgressBarWidget *me;
269 ModestProgressBarWidgetPrivate *priv;
271 ObservableData *tmp_data = NULL;
274 me = MODEST_PROGRESS_BAR_WIDGET (self);
275 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
277 is_current = (priv->current == mail_op);
280 tmp_data = g_malloc0 (sizeof (ObservableData));
281 tmp_data->mail_op = mail_op;
282 link = g_slist_find_custom (priv->observables,
284 (GCompareFunc) compare_observable_data);
286 /* Remove the item */
288 ObservableData *ob_data = link->data;
289 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
290 g_object_unref (ob_data->mail_op);
292 priv->observables = g_slist_delete_link (priv->observables, link);
293 tmp_data->mail_op = NULL;
297 /* Update the current mail operation */
299 if (priv->observables)
300 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
302 priv->current = NULL;
304 /* Refresh the view */
305 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
313 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
315 ModestProgressBarWidget *me;
316 ModestProgressBarWidgetPrivate *priv;
318 me = MODEST_PROGRESS_BAR_WIDGET (self);
319 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
321 return g_slist_length(priv->observables);
325 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
327 ModestProgressBarWidget *me;
328 ModestProgressBarWidgetPrivate *priv;
330 me = MODEST_PROGRESS_BAR_WIDGET (self);
331 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
333 if (priv->current == NULL) return;
335 /* If received canceled we shall show banner */
336 if (modest_mail_operation_get_type_operation (priv->current) ==
337 MODEST_MAIL_OPERATION_TYPE_RECEIVE)
338 modest_platform_information_banner (NULL, NULL,
339 _("emev_ib_ui_pop3_msg_recv_cancel"));
341 modest_mail_operation_cancel (priv->current);
345 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
347 ModestProgressBarWidget *me;
348 ModestProgressBarWidgetPrivate *priv;
350 me = MODEST_PROGRESS_BAR_WIDGET (self);
351 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
353 /* If received canceled we shall show banner */
354 if (priv->current && modest_mail_operation_get_type_operation (priv->current) ==
355 MODEST_MAIL_OPERATION_TYPE_RECEIVE)
356 modest_platform_information_banner (NULL, NULL,
357 _("emev_ib_ui_pop3_msg_recv_cancel"));
359 /* Cancel all the mail operations */
360 modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
364 on_progress_changed (ModestMailOperation *mail_op,
365 ModestMailOperationState *state,
366 ModestProgressBarWidget *self)
368 ModestProgressBarWidgetPrivate *priv;
369 gboolean determined = FALSE;
371 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
373 /* If the mail operation is the currently shown one */
374 if (priv->current == mail_op) {
377 determined = (state->done > 0 && state->total > 0) &&
378 !(state->done == 1 && state->total == 100);
380 switch (state->op_type) {
381 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
383 msg = g_strdup_printf(_("mcen_me_receiving"),
384 state->done, state->total);
386 msg = g_strdup(_("mail_me_receiving"));
388 case MODEST_MAIL_OPERATION_TYPE_SEND:
390 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
393 msg = g_strdup(_("mail_me_sending"));
396 case MODEST_MAIL_OPERATION_TYPE_OPEN:
397 msg = g_strdup(_("mail_me_opening"));
403 /* If we have byte information use it */
404 if ((state->bytes_done != 0) && (state->bytes_total != 0))
405 modest_progress_bar_widget_set_progress (self, msg,
409 modest_progress_bar_widget_set_progress (self, msg,
417 progressbar_clean (GtkProgressBar *bar)
419 gtk_progress_bar_set_fraction (bar, 0);
420 gtk_progress_bar_set_text (bar, 0);
426 modest_progress_bar_widget_new ()
428 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
433 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
434 const gchar *message,
438 ModestProgressBarWidgetPrivate *priv;
440 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
441 g_return_if_fail (done <= total);
443 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
445 /* Set progress. Tinymail sometimes returns us 1/100 when it
446 does not have any clue, NOTE that 1/100 could be also a
447 valid progress (we will loose it), but it will be recovered
448 once the done is greater than 1 */
449 if ((done == 0 && total == 0) ||
450 (done == 1 && total == 100)) {
451 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
454 if (total != 0) /* Avoid division by zero. */
455 percent = (gdouble)done/(gdouble)total;
457 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
462 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);