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 "modest-progress-bar-widget.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_widget_class_init (ModestProgressBarWidgetClass *klass);
41 static void modest_progress_bar_widget_init (ModestProgressBarWidget *obj);
42 static void modest_progress_bar_widget_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 ModestProgressBarWidget *self);
60 static gboolean progressbar_clean (GtkProgressBar *bar);
75 typedef struct _ObservableData ObservableData;
76 struct _ObservableData {
78 ModestMailOperation *mail_op;
81 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
82 struct _ModestProgressBarWidgetPrivate {
84 ModestMailOperation *current;
87 GtkWidget *progress_bar;
89 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
90 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
91 ModestProgressBarWidgetPrivate))
94 static GtkContainerClass *parent_class = NULL;
96 /* uncomment the following if you have defined any signals */
97 /* static guint signals[LAST_SIGNAL] = {0}; */
100 modest_progress_object_init (gpointer g, gpointer iface_data)
102 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
104 klass->add_operation_func = modest_progress_bar_add_operation;
105 klass->remove_operation_func = modest_progress_bar_remove_operation;
106 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
107 klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
108 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
113 modest_progress_bar_widget_get_type (void)
115 static GType my_type = 0;
117 static const GTypeInfo my_info = {
118 sizeof(ModestProgressBarWidgetClass),
119 NULL, /* base init */
120 NULL, /* base finalize */
121 (GClassInitFunc) modest_progress_bar_widget_class_init,
122 NULL, /* class finalize */
123 NULL, /* class data */
124 sizeof(ModestProgressBarWidget),
126 (GInstanceInitFunc) modest_progress_bar_widget_init,
130 static const GInterfaceInfo modest_progress_object_info =
132 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
133 NULL, /* interface_finalize */
134 NULL /* interface_data */
137 my_type = g_type_register_static (GTK_TYPE_VBOX,
138 "ModestProgressBarWidget",
141 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
142 &modest_progress_object_info);
148 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
150 GObjectClass *gobject_class;
151 gobject_class = (GObjectClass*) klass;
153 parent_class = g_type_class_peek_parent (klass);
154 gobject_class->finalize = modest_progress_bar_widget_finalize;
156 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
160 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
163 ModestProgressBarWidgetPrivate *priv;
164 GtkWidget *align = NULL;
168 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
171 align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
173 /* Build GtkProgressBar */
174 adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
175 priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
178 gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
179 gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
180 gtk_progress_bar_set_pulse_step (GTK_PROGRESS_BAR (priv->progress_bar), 0.05);
181 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), " ");
182 gtk_widget_size_request (priv->progress_bar, &req);
183 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
184 gtk_widget_size_request (align, &req);
186 /* Add progress bar widget */
187 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
188 gtk_widget_show_all (GTK_WIDGET(self));
192 modest_progress_bar_widget_finalize (GObject *obj)
194 ModestProgressBarWidgetPrivate *priv;
196 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
197 if (priv->observables) {
200 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
201 ObservableData *ob_data = tmp->data;
202 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
203 g_object_unref (ob_data->mail_op);
206 g_slist_free (priv->observables);
207 priv->observables = NULL;
210 G_OBJECT_CLASS(parent_class)->finalize (obj);
215 modest_progress_bar_add_operation (ModestProgressObject *self,
216 ModestMailOperation *mail_op)
218 ModestProgressBarWidget *me = NULL;
219 ObservableData *data = NULL;
220 ModestProgressBarWidgetPrivate *priv = NULL;
222 me = MODEST_PROGRESS_BAR_WIDGET (self);
223 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
225 data = g_malloc0 (sizeof (ObservableData));
226 data->mail_op = g_object_ref (mail_op);
227 data->signal_handler = g_signal_connect (data->mail_op,
229 G_CALLBACK (on_progress_changed),
231 /* Set curent operation */
232 if (priv->current == NULL) {
233 priv->current = mail_op;
237 /* Call progress_change handler to initialize progress message */
238 /* modest_progress_bar_widget_set_undetermined_progress (MODEST_PROGRESS_BAR_WIDGET(self), mail_op); */
241 /* Add operation to obserbable objects list */
242 priv->observables = g_slist_prepend (priv->observables, data);
246 compare_observable_data (ObservableData *data1, ObservableData *data2)
248 if (data1->mail_op == data2->mail_op)
255 modest_progress_bar_remove_operation (ModestProgressObject *self,
256 ModestMailOperation *mail_op)
258 ModestProgressBarWidget *me;
259 ModestProgressBarWidgetPrivate *priv;
261 ObservableData *tmp_data = NULL;
264 me = MODEST_PROGRESS_BAR_WIDGET (self);
265 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
267 is_current = (priv->current == mail_op);
270 tmp_data = g_malloc0 (sizeof (ObservableData));
271 tmp_data->mail_op = mail_op;
272 link = g_slist_find_custom (priv->observables,
274 (GCompareFunc) compare_observable_data);
276 /* Remove the item */
278 ObservableData *ob_data = link->data;
279 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
280 g_object_unref (ob_data->mail_op);
282 priv->observables = g_slist_delete_link (priv->observables, link);
283 tmp_data->mail_op = NULL;
287 /* Update the current mail operation */
289 if (priv->observables)
290 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
292 priv->current = NULL;
294 /* Refresh the view */
295 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
303 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
305 ModestProgressBarWidget *me;
306 ModestProgressBarWidgetPrivate *priv;
308 me = MODEST_PROGRESS_BAR_WIDGET (self);
309 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
311 return g_slist_length(priv->observables);
315 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
317 ModestProgressBarWidget *me;
318 ModestProgressBarWidgetPrivate *priv;
320 me = MODEST_PROGRESS_BAR_WIDGET (self);
321 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
323 if (priv->current == NULL) return;
325 modest_mail_operation_cancel (priv->current);
329 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
331 ModestProgressBarWidget *me;
332 ModestProgressBarWidgetPrivate *priv;
334 me = MODEST_PROGRESS_BAR_WIDGET (self);
335 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
337 /* Cancel all the mail operations */
338 modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
342 on_progress_changed (ModestMailOperation *mail_op,
343 ModestMailOperationState *state,
344 ModestProgressBarWidget *self)
346 ModestProgressBarWidgetPrivate *priv;
347 gboolean determined = FALSE;
349 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
351 /* If the mail operation is the currently shown one */
352 if (priv->current == mail_op) {
355 determined = (state->done > 0 && state->total > 1) &&
356 !(state->done == 1 && state->total == 100);
358 switch (state->op_type) {
359 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
361 msg = g_strdup_printf(_("mcen_me_receiving"),
362 state->done, state->total);
364 msg = g_strdup(_("mail_me_receiving"));
366 case MODEST_MAIL_OPERATION_TYPE_SEND:
368 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
371 msg = g_strdup(_("mail_me_sending"));
374 case MODEST_MAIL_OPERATION_TYPE_OPEN:
375 msg = g_strdup(_("mail_me_opening"));
381 /* If we have byte information use it */
382 if ((state->bytes_done != 0) && (state->bytes_total != 0))
383 modest_progress_bar_widget_set_progress (self, msg,
387 modest_progress_bar_widget_set_progress (self, msg,
395 progressbar_clean (GtkProgressBar *bar)
397 gtk_progress_bar_set_fraction (bar, 0);
398 gtk_progress_bar_set_text (bar, " ");
404 modest_progress_bar_widget_new ()
406 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
411 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
412 const gchar *message,
416 ModestProgressBarWidgetPrivate *priv;
417 gboolean determined = FALSE;
419 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
420 g_return_if_fail (done <= total);
422 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
426 /* Set progress. Tinymail sometimes returns us 1/100 when it
427 does not have any clue, NOTE that 1/100 could be also a
428 valid progress (we will loose it), but it will be recovered
429 once the done is greater than 1 */
430 determined = (done > 0 && total > 1) &&
431 !(done == 1 && total == 100);
433 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
436 if (total != 0) /* Avoid division by zero. */
437 percent = (gdouble)done/(gdouble)total;
439 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
444 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar),
445 (message && message[0] != '\0')?message:" ");
450 modest_progress_bar_widget_set_undetermined_progress (ModestProgressBarWidget *self,
451 ModestMailOperation *mail_op)
453 ModestMailOperationState *state = NULL;
455 state = g_malloc0(sizeof(ModestMailOperationState));
458 state->op_type = modest_mail_operation_get_type_operation (mail_op);
459 on_progress_changed (mail_op, state, self);