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"
36 /* 'private'/'protected' functions */
37 static void modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass);
38 static void modest_progress_bar_widget_init (ModestProgressBarWidget *obj);
39 static void modest_progress_bar_widget_finalize (GObject *obj);
41 static void modest_progress_bar_add_operation (ModestProgressObject *self,
42 ModestMailOperation *mail_op);
44 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
45 ModestMailOperation *mail_op);
48 modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
51 modest_progress_bar_num_pending_operations (ModestProgressObject *self);
53 static void on_progress_changed (ModestMailOperation *mail_op,
54 ModestMailOperationState *state,
55 ModestProgressBarWidget *self);
57 static gboolean progressbar_clean (GtkProgressBar *bar);
72 typedef struct _ObservableData ObservableData;
73 struct _ObservableData {
75 ModestMailOperation *mail_op;
78 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
79 struct _ModestProgressBarWidgetPrivate {
81 ModestMailOperation *current;
83 GtkWidget *progress_bar;
85 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
86 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
87 ModestProgressBarWidgetPrivate))
90 static GtkContainerClass *parent_class = NULL;
92 /* uncomment the following if you have defined any signals */
93 /* static guint signals[LAST_SIGNAL] = {0}; */
96 modest_progress_object_init (gpointer g, gpointer iface_data)
98 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
100 klass->add_operation_func = modest_progress_bar_add_operation;
101 klass->remove_operation_func = modest_progress_bar_remove_operation;
102 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
103 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
108 modest_progress_bar_widget_get_type (void)
110 static GType my_type = 0;
112 static const GTypeInfo my_info = {
113 sizeof(ModestProgressBarWidgetClass),
114 NULL, /* base init */
115 NULL, /* base finalize */
116 (GClassInitFunc) modest_progress_bar_widget_class_init,
117 NULL, /* class finalize */
118 NULL, /* class data */
119 sizeof(ModestProgressBarWidget),
121 (GInstanceInitFunc) modest_progress_bar_widget_init,
125 static const GInterfaceInfo modest_progress_object_info =
127 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
128 NULL, /* interface_finalize */
129 NULL /* interface_data */
132 my_type = g_type_register_static (GTK_TYPE_VBOX,
133 "ModestProgressBarWidget",
136 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
137 &modest_progress_object_info);
143 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
145 GObjectClass *gobject_class;
146 gobject_class = (GObjectClass*) klass;
148 parent_class = g_type_class_peek_parent (klass);
149 gobject_class->finalize = modest_progress_bar_widget_finalize;
151 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
153 /* signal definitions go here, e.g.: */
154 /* signals[DATA_CHANGED_SIGNAL] = */
155 /* g_signal_new ("data_changed", */
156 /* G_TYPE_FROM_CLASS (klass), */
157 /* G_SIGNAL_RUN_FIRST, */
158 /* G_STRUCT_OFFSET(ModestProgressBarWidgetClass, data_changed), */
160 /* g_cclosure_marshal_VOID__VOID, */
161 /* G_TYPE_NONE, 0); */
165 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
168 ModestProgressBarWidgetPrivate *priv;
169 GtkWidget *align = NULL;
173 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
176 align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
178 /* Build GtkProgressBar */
179 adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
180 priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
183 gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
184 gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
185 gtk_widget_size_request (priv->progress_bar, &req);
186 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
187 gtk_widget_size_request (align, &req);
189 /* Add progress bar widget */
190 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
191 gtk_widget_show_all (GTK_WIDGET(self));
195 modest_progress_bar_widget_finalize (GObject *obj)
197 ModestProgressBarWidgetPrivate *priv;
199 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
200 if (priv->observables) {
203 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
204 ObservableData *ob_data = tmp->data;
205 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
206 g_object_unref (ob_data->mail_op);
209 g_slist_free (priv->observables);
210 priv->observables = NULL;
213 G_OBJECT_CLASS(parent_class)->finalize (obj);
218 modest_progress_bar_add_operation (ModestProgressObject *self,
219 ModestMailOperation *mail_op)
221 ModestProgressBarWidget *me = NULL;
222 ObservableData *data = NULL;
223 ModestProgressBarWidgetPrivate *priv = NULL;
224 ModestMailOperationState *state = NULL;
226 me = MODEST_PROGRESS_BAR_WIDGET (self);
227 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
229 data = g_malloc0 (sizeof (ObservableData));
230 data->mail_op = g_object_ref (mail_op);
231 data->signal_handler = g_signal_connect (data->mail_op,
233 G_CALLBACK (on_progress_changed),
235 if (priv->observables == NULL) {
236 priv->current = mail_op;
238 /* Call progress_change handler to initialize progress message */
239 state = g_malloc0(sizeof(ModestMailOperationState));
242 state->op_type = modest_mail_operation_get_type_operation (mail_op);;
243 on_progress_changed (mail_op, state, me);
246 priv->observables = g_slist_append (priv->observables, data);
251 compare_observable_data (ObservableData *data1, ObservableData *data2)
253 if (data1->mail_op == data2->mail_op)
260 modest_progress_bar_remove_operation (ModestProgressObject *self,
261 ModestMailOperation *mail_op)
263 ModestProgressBarWidget *me;
264 ModestProgressBarWidgetPrivate *priv;
266 ObservableData *tmp_data = NULL;
268 me = MODEST_PROGRESS_BAR_WIDGET (self);
269 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
272 tmp_data = g_malloc0 (sizeof (ObservableData));
273 tmp_data->mail_op = mail_op;
274 link = g_slist_find_custom (priv->observables,
276 (GCompareFunc) compare_observable_data);
278 /* Remove the item */
280 ObservableData *ob_data = link->data;
281 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
282 g_object_unref (ob_data->mail_op);
284 priv->observables = g_slist_delete_link (priv->observables, link);
285 tmp_data->mail_op = NULL;
289 /* Update the current mail operation */
290 if (priv->current == mail_op) {
291 if (priv->observables)
292 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
294 priv->current = NULL;
296 /* Refresh the view */
297 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
305 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
307 ModestProgressBarWidget *me;
308 ModestProgressBarWidgetPrivate *priv;
310 me = MODEST_PROGRESS_BAR_WIDGET (self);
311 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
313 return g_slist_length(priv->observables);
317 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
319 ModestProgressBarWidget *me;
320 ModestProgressBarWidgetPrivate *priv;
322 me = MODEST_PROGRESS_BAR_WIDGET (self);
323 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
325 if (priv->current == NULL) return;
326 modest_mail_operation_cancel (priv->current);
330 on_progress_changed (ModestMailOperation *mail_op,
331 ModestMailOperationState *state,
332 ModestProgressBarWidget *self)
334 ModestProgressBarWidgetPrivate *priv;
335 gboolean determined = FALSE;
337 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
339 /* If the mail operation is the currently shown one */
340 if (priv->current == mail_op) {
343 determined = (state->done > 0 && state->total > 0) &&
344 !(state->done == 1 && state->total == 100);
346 switch (state->op_type) {
347 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
349 msg = g_strdup_printf(_("mcen_me_receiving"),
350 state->done, state->total);
352 msg = g_strdup(_("mail_me_receiving"));
354 case MODEST_MAIL_OPERATION_TYPE_SEND:
356 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
359 msg = g_strdup(_("mail_me_sending"));
362 case MODEST_MAIL_OPERATION_TYPE_OPEN:
363 msg = g_strdup(_("mail_me_opening"));
369 /* If we have byte information use it */
370 if ((state->bytes_done != 0) && (state->bytes_total != 0))
371 modest_progress_bar_widget_set_progress (self, msg,
375 modest_progress_bar_widget_set_progress (self, msg,
383 progressbar_clean (GtkProgressBar *bar)
385 gtk_progress_bar_set_fraction (bar, 0);
386 gtk_progress_bar_set_text (bar, 0);
392 modest_progress_bar_widget_new ()
394 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
399 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
400 const gchar *message,
404 ModestProgressBarWidgetPrivate *priv;
406 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
407 g_return_if_fail (done <= total);
409 priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
411 /* Set progress. Tinymail sometimes returns us 1/100 when it
412 does not have any clue, NOTE that 1/100 could be also a
413 valid progress (we will loose it), but it will be recovered
414 once the done is greater than 1 */
415 if ((done == 0 && total == 0) ||
416 (done == 1 && total == 100)) {
417 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
420 if (total != 0) /* Avoid division by zero. */
421 percent = (gdouble)done/(gdouble)total;
423 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
428 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);