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 <glib/gi18n.h>
33 #include <widgets/modest-combo-box.h>
34 #include "widgets/modest-progress-bar.h"
35 #include "modest-tny-account.h"
36 #include "modest-platform.h"
37 #include "modest-runtime.h"
39 /* 'private'/'protected' functions */
40 static void modest_progress_bar_class_init (ModestProgressBarClass *klass);
41 static void modest_progress_bar_init (ModestProgressBar *obj);
42 static void modest_progress_bar_finalize (GObject *obj);
44 static void modest_progress_bar_add_operation (ModestProgressObject *self,
45 ModestMailOperation *mail_op);
47 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
48 ModestMailOperation *mail_op);
50 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
52 static void modest_progress_bar_cancel_all_operations (ModestProgressObject *self);
54 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
56 static void on_progress_changed (ModestMailOperation *mail_op,
57 ModestMailOperationState *state,
58 ModestProgressBar *self);
60 static gboolean progressbar_clean (GtkProgressBar *bar);
62 static gboolean modest_progress_bar_is_pulsating (ModestProgressBar *self);
64 static void modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
66 gboolean is_pulsating);
76 #define MODEST_PROGRESS_BAR_PULSE_INTERVAL 125
83 typedef struct _ObservableData ObservableData;
84 struct _ObservableData {
86 ModestMailOperation *mail_op;
89 typedef struct _ModestProgressBarPrivate ModestProgressBarPrivate;
90 struct _ModestProgressBarPrivate {
92 ModestMailOperation *current;
94 GtkWidget *progress_bar;
95 guint pulsating_timeout;
97 #define MODEST_PROGRESS_BAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
98 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
99 ModestProgressBarPrivate))
102 static GtkContainerClass *parent_class = NULL;
104 /* uncomment the following if you have defined any signals */
105 /* static guint signals[LAST_SIGNAL] = {0}; */
108 modest_progress_object_init (gpointer g, gpointer iface_data)
110 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
112 klass->add_operation_func = modest_progress_bar_add_operation;
113 klass->remove_operation_func = modest_progress_bar_remove_operation;
114 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
115 klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
116 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
121 modest_progress_bar_get_type (void)
123 static GType my_type = 0;
125 static const GTypeInfo my_info = {
126 sizeof(ModestProgressBarClass),
127 NULL, /* base init */
128 NULL, /* base finalize */
129 (GClassInitFunc) modest_progress_bar_class_init,
130 NULL, /* class finalize */
131 NULL, /* class data */
132 sizeof(ModestProgressBar),
134 (GInstanceInitFunc) modest_progress_bar_init,
138 static const GInterfaceInfo modest_progress_object_info =
140 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
141 NULL, /* interface_finalize */
142 NULL /* interface_data */
145 my_type = g_type_register_static (GTK_TYPE_VBOX,
149 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
150 &modest_progress_object_info);
156 modest_progress_bar_class_init (ModestProgressBarClass *klass)
158 GObjectClass *gobject_class;
159 gobject_class = (GObjectClass*) klass;
161 parent_class = g_type_class_peek_parent (klass);
162 gobject_class->finalize = modest_progress_bar_finalize;
164 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarPrivate));
168 modest_progress_bar_init (ModestProgressBar *self)
171 ModestProgressBarPrivate *priv;
172 GtkWidget *align = NULL;
176 priv = MODEST_PROGRESS_BAR_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_progress_bar_set_pulse_step (GTK_PROGRESS_BAR (priv->progress_bar), 0.25);
189 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), " ");
190 gtk_widget_size_request (priv->progress_bar, &req);
191 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
192 gtk_widget_size_request (align, &req);
194 /* Add progress bar widget */
195 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
196 gtk_widget_show_all (GTK_WIDGET(self));
198 priv->pulsating_timeout = 0;
202 modest_progress_bar_finalize (GObject *obj)
204 ModestProgressBarPrivate *priv;
206 priv = MODEST_PROGRESS_BAR_GET_PRIVATE(obj);
207 if (priv->observables) {
210 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
211 ObservableData *ob_data = tmp->data;
212 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
213 g_object_unref (ob_data->mail_op);
216 g_slist_free (priv->observables);
217 priv->observables = NULL;
221 if (priv->pulsating_timeout != 0)
222 g_source_remove (priv->pulsating_timeout);
224 G_OBJECT_CLASS(parent_class)->finalize (obj);
229 modest_progress_bar_add_operation (ModestProgressObject *self,
230 ModestMailOperation *mail_op)
232 ModestProgressBar *me = NULL;
233 ObservableData *data = NULL;
234 ModestProgressBarPrivate *priv = NULL;
236 me = MODEST_PROGRESS_BAR (self);
237 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
239 data = g_malloc0 (sizeof (ObservableData));
240 data->mail_op = g_object_ref (mail_op);
241 data->signal_handler = g_signal_connect (data->mail_op,
243 G_CALLBACK (on_progress_changed),
245 /* Set curent operation */
246 if (priv->current == NULL) {
247 priv->current = mail_op;
251 /* Call progress_change handler to initialize progress message */
252 /* modest_progress_bar_set_undetermined_progress (MODEST_PROGRESS_BAR(self), mail_op); */
255 /* Add operation to obserbable objects list */
256 priv->observables = g_slist_prepend (priv->observables, data);
260 compare_observable_data (ObservableData *data1, ObservableData *data2)
262 if (data1->mail_op == data2->mail_op)
269 modest_progress_bar_remove_operation (ModestProgressObject *self,
270 ModestMailOperation *mail_op)
272 ModestProgressBar *me;
273 ModestProgressBarPrivate *priv;
275 ObservableData *tmp_data = NULL;
278 me = MODEST_PROGRESS_BAR (self);
279 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
281 is_current = (priv->current == mail_op);
284 tmp_data = g_malloc0 (sizeof (ObservableData));
285 tmp_data->mail_op = mail_op;
286 link = g_slist_find_custom (priv->observables,
288 (GCompareFunc) compare_observable_data);
290 /* Remove the item */
292 ObservableData *ob_data = link->data;
293 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
294 g_object_unref (ob_data->mail_op);
296 priv->observables = g_slist_delete_link (priv->observables, link);
297 tmp_data->mail_op = NULL;
301 /* Update the current mail operation */
303 if (priv->observables)
304 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
306 priv->current = NULL;
308 /* Refresh the view */
309 modest_progress_bar_set_pulsating_mode (me, NULL, FALSE);
310 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
318 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
320 ModestProgressBar *me;
321 ModestProgressBarPrivate *priv;
323 me = MODEST_PROGRESS_BAR (self);
324 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
326 return g_slist_length(priv->observables);
330 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
332 ModestProgressBar *me;
333 ModestProgressBarPrivate *priv;
335 me = MODEST_PROGRESS_BAR (self);
336 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
338 if (priv->current == NULL) return;
340 modest_mail_operation_cancel (priv->current);
344 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
346 ModestProgressBar *me;
347 ModestProgressBarPrivate *priv;
349 me = MODEST_PROGRESS_BAR (self);
350 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
352 /* Cancel all the mail operations */
353 modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
357 on_progress_changed (ModestMailOperation *mail_op,
358 ModestMailOperationState *state,
359 ModestProgressBar *self)
361 ModestProgressBarPrivate *priv;
362 gboolean determined = FALSE;
364 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
366 /* If the mail operation is the currently shown one */
367 if (priv->current == mail_op) {
370 determined = (state->done > 0 && state->total > 1) &&
371 !(state->done == 1 && state->total == 100);
373 switch (state->op_type) {
374 case MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE:
375 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
377 msg = g_strdup_printf(_("mcen_me_receiving"),
378 state->done, state->total);
380 msg = g_strdup(_("mail_me_receiving"));
382 case MODEST_MAIL_OPERATION_TYPE_SEND:
384 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
387 msg = g_strdup(_("mail_me_sending"));
390 case MODEST_MAIL_OPERATION_TYPE_OPEN:
391 msg = g_strdup(_("mail_me_opening"));
397 /* If we have byte information use it */
398 if ((state->bytes_done != 0) && (state->bytes_total != 0))
399 modest_progress_bar_set_progress (self, msg,
402 else if ((state->done == 0) && (state->total == 0))
403 modest_progress_bar_set_pulsating_mode (self, msg, TRUE);
405 modest_progress_bar_set_progress (self, msg,
413 progressbar_clean (GtkProgressBar *bar)
415 gtk_progress_bar_set_fraction (bar, 0);
416 gtk_progress_bar_set_text (bar, " ");
422 modest_progress_bar_new ()
424 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
429 modest_progress_bar_set_progress (ModestProgressBar *self,
430 const gchar *message,
434 ModestProgressBarPrivate *priv;
435 gboolean determined = FALSE;
437 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
438 g_return_if_fail (done <= total);
440 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
444 if (modest_progress_bar_is_pulsating (self))
445 modest_progress_bar_set_pulsating_mode (self, NULL, FALSE);
447 /* Set progress. Tinymail sometimes returns us 1/100 when it
448 does not have any clue, NOTE that 1/100 could be also a
449 valid progress (we will loose it), but it will be recovered
450 once the done is greater than 1 */
451 determined = (done > 0 && total > 1) &&
452 !(done == 1 && total == 100);
454 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
457 if (total != 0) /* Avoid division by zero. */
458 percent = (gdouble)done/(gdouble)total;
460 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
465 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar),
466 (message && message[0] != '\0')?message:" ");
471 modest_progress_bar_set_undetermined_progress (ModestProgressBar *self,
472 ModestMailOperation *mail_op)
474 ModestMailOperationState *state = NULL;
476 state = g_malloc0(sizeof(ModestMailOperationState));
479 state->op_type = modest_mail_operation_get_type_operation (mail_op);
480 on_progress_changed (mail_op, state, self);
484 /* this has to be explicitly removed */
486 do_pulse (gpointer data)
488 ModestProgressBarPrivate *priv;
490 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(data), FALSE);
492 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (data);
493 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
498 modest_progress_bar_is_pulsating (ModestProgressBar *self)
500 ModestProgressBarPrivate *priv;
502 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self), FALSE);
504 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
506 return priv->pulsating_timeout != 0;
510 modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
512 gboolean is_pulsating)
514 ModestProgressBarPrivate *priv;
516 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
518 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
521 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), msg);
523 if (is_pulsating == (priv->pulsating_timeout != 0))
525 else if (is_pulsating && (priv->pulsating_timeout == 0)) {
527 priv->pulsating_timeout = g_timeout_add (MODEST_PROGRESS_BAR_PULSE_INTERVAL,
529 } else if (!is_pulsating && (priv->pulsating_timeout != 0)) {
531 g_source_remove (priv->pulsating_timeout);
532 priv->pulsating_timeout = 0;