git.maemo.org Git - modest/blob - src/maemo/modest-progress-bar-widget.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   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.
  16  *
  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.
  28  */
  29
  30 #include <glib/gi18n.h>
  31 #include <gtk/gtk.h>
  32 #include <widgets/modest-combo-box.h>
  33 #include "modest-progress-bar-widget.h"
  34 #include <string.h>
  35
  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);
  40
  41 static void modest_progress_bar_add_operation    (ModestProgressObject *self,
  42                                                     ModestMailOperation  *mail_op);
  43
  44 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
  45                                                     ModestMailOperation  *mail_op);
  46
  47 static void
  48 modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
  49
  50 static guint
  51 modest_progress_bar_num_pending_operations (ModestProgressObject *self);
  52
  53 static void on_progress_changed                    (ModestMailOperation  *mail_op,
  54                                                     ModestProgressBarWidget *self);
  55
  56 static gboolean     progressbar_clean        (GtkProgressBar *bar);
  57
  58 #define XALIGN 0.5
  59 #define YALIGN 0.5
  60 #define XSPACE 1
  61 #define YSPACE 0
  62
  63 #define LOWER 0
  64 #define UPPER 150
  65
  66 /* list my signals  */
  67 /* enum { */
  68 /*      LAST_SIGNAL */
  69 /* }; */
  70
  71 typedef struct _ObservableData ObservableData;
  72 struct _ObservableData {
  73         guint signal_handler;
  74         ModestMailOperation *mail_op;
  75 };
  76
  77 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
  78 struct _ModestProgressBarWidgetPrivate {
  79         GSList              *observables;
  80         ModestMailOperation *current;
  81
  82         GtkWidget *progress_bar;
  83 };
  84 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  85                                                  MODEST_TYPE_PROGRESS_BAR_WIDGET, \
  86                                                  ModestProgressBarWidgetPrivate))
  87
  88 /* globals */
  89 static GtkContainerClass *parent_class = NULL;
  90
  91 /* uncomment the following if you have defined any signals */
  92 /* static guint signals[LAST_SIGNAL] = {0}; */
  93
  94 static void
  95 modest_progress_object_init (gpointer g, gpointer iface_data)
  96 {
  97         ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
  98
  99         klass->add_operation_func = modest_progress_bar_add_operation;
 100         klass->remove_operation_func = modest_progress_bar_remove_operation;
 101         klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
 102         klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
 103 }
 104
 105
 106 GType
 107 modest_progress_bar_widget_get_type (void)
 108 {
 109         static GType my_type = 0;
 110         if (!my_type) {
 111                 static const GTypeInfo my_info = {
 112                         sizeof(ModestProgressBarWidgetClass),
 113                         NULL,           /* base init */
 114                         NULL,           /* base finalize */
 115                         (GClassInitFunc) modest_progress_bar_widget_class_init,
 116                         NULL,           /* class finalize */
 117                         NULL,           /* class data */
 118                         sizeof(ModestProgressBarWidget),
 119                         1,              /* n_preallocs */
 120                         (GInstanceInitFunc) modest_progress_bar_widget_init,
 121                         NULL
 122                 };
 123
 124                 static const GInterfaceInfo modest_progress_object_info =
 125                 {
 126                   (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
 127                   NULL,         /* interface_finalize */
 128                   NULL          /* interface_data */
 129                 };
 130
 131                 my_type = g_type_register_static (GTK_TYPE_VBOX,
 132                                                   "ModestProgressBarWidget",
 133                                                   &my_info, 0);
 134
 135                 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
 136                                              &modest_progress_object_info);
 137         }
 138         return my_type;
 139 }
 140
 141 static void
 142 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
 143 {
 144         GObjectClass *gobject_class;
 145         gobject_class = (GObjectClass*) klass;
 146
 147         parent_class            = g_type_class_peek_parent (klass);
 148         gobject_class->finalize = modest_progress_bar_widget_finalize;
 149
 150         g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
 151
 152         /* signal definitions go here, e.g.: */
 153 /*      signals[DATA_CHANGED_SIGNAL] = */
 154 /*              g_signal_new ("data_changed", */
 155 /*                            G_TYPE_FROM_CLASS (klass), */
 156 /*                            G_SIGNAL_RUN_FIRST, */
 157 /*                            G_STRUCT_OFFSET(ModestProgressBarWidgetClass, data_changed), */
 158 /*                            NULL, NULL, */
 159 /*                            g_cclosure_marshal_VOID__VOID, */
 160 /*                            G_TYPE_NONE, 0); */
 161 }
 162
 163 static void
 164 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
 165 {
 166
 167         ModestProgressBarWidgetPrivate *priv;
 168         GtkWidget *align = NULL;
 169         GtkRequisition req;
 170         GtkAdjustment *adj;
 171
 172         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
 173
 174         /* Alignment */
 175         align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
 176
 177         /* Build GtkProgressBar */
 178         adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
 179         priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
 180         req.width = 228;
 181         req.height = 64;
 182         gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
 183         gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
 184         gtk_widget_size_request (priv->progress_bar, &req);
 185         gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
 186
 187         /* Add progress bar widget */
 188         gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
 189         gtk_widget_show_all (GTK_WIDGET(self));
 190 }
 191
 192 static void
 193 destroy_observable_data (ObservableData *data)
 194 {
 195         g_signal_handler_disconnect (data->mail_op, data->signal_handler);
 196         g_object_unref (data->mail_op);
 197 }
 198
 199 static void
 200 modest_progress_bar_widget_finalize (GObject *obj)
 201 {
 202         ModestProgressBarWidgetPrivate *priv;
 203
 204         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
 205         if (priv->observables) {
 206                 GSList *tmp;
 207
 208                 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
 209                         destroy_observable_data ((ObservableData *) tmp->data);
 210                         g_free (tmp->data);
 211                 }
 212                 g_slist_free (priv->observables);
 213                 priv->observables = NULL;
 214         }
 215
 216         G_OBJECT_CLASS(parent_class)->finalize (obj);
 217 }
 218
 219
 220 static void
 221 modest_progress_bar_add_operation (ModestProgressObject *self,
 222                                    ModestMailOperation  *mail_op)
 223 {
 224         ModestProgressBarWidget *me;
 225         ObservableData *data;
 226         ModestProgressBarWidgetPrivate *priv;
 227
 228         me = MODEST_PROGRESS_BAR_WIDGET (self);
 229         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 230
 231         data = g_malloc0 (sizeof (ObservableData));
 232         data->mail_op = g_object_ref (mail_op);
 233         data->signal_handler = g_signal_connect (data->mail_op,
 234                                                  "progress-changed",
 235                                                  G_CALLBACK (on_progress_changed),
 236                                                  me);
 237
 238         if (priv->observables == NULL) {
 239                 priv->current = mail_op;
 240         }
 241         priv->observables = g_slist_append (priv->observables, data);
 242
 243         /* Call progress_change handler to initialize progress message */
 244 /*      on_progress_changed (mail_op, me); */
 245 }
 246
 247 static gint
 248 compare_observable_data (ObservableData *data1, ObservableData *data2)
 249 {
 250         if (data1->mail_op == data2->mail_op)
 251                 return 0;
 252         else
 253                 return 1;
 254 }
 255
 256 static void
 257 modest_progress_bar_remove_operation (ModestProgressObject *self,
 258                                         ModestMailOperation  *mail_op)
 259 {
 260         ModestProgressBarWidget *me;
 261         ModestProgressBarWidgetPrivate *priv;
 262         GSList *link;
 263         ObservableData *tmp_data = NULL;
 264
 265         me = MODEST_PROGRESS_BAR_WIDGET (self);
 266         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 267
 268         /* Find item */
 269         tmp_data = g_malloc0 (sizeof (ObservableData));
 270         tmp_data->mail_op = g_object_ref (mail_op);
 271         link = g_slist_find_custom (priv->observables,
 272                                     tmp_data,
 273                                     (GCompareFunc) compare_observable_data);
 274
 275         /* Remove the item */
 276         if (link) {
 277                 priv->observables = g_slist_remove_link (priv->observables, link);
 278                 destroy_observable_data ((ObservableData *) link->data);
 279         }
 280
 281         /* Update the current mail operation */
 282         if (priv->current == mail_op) {
 283                 if (priv->observables)
 284                         priv->current = ((ObservableData *) priv->observables->data)->mail_op;
 285                 else
 286                         priv->current = NULL;
 287
 288                 /* Refresh the view */
 289                 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
 290         }
 291
 292         /* free */
 293         g_free(tmp_data);
 294 }
 295
 296 static guint
 297 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
 298 {
 299         ModestProgressBarWidget *me;
 300         ModestProgressBarWidgetPrivate *priv;
 301
 302         me = MODEST_PROGRESS_BAR_WIDGET (self);
 303         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 304
 305         return g_slist_length(priv->observables);
 306 }
 307
 308 static void
 309 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
 310 {
 311         ModestProgressBarWidget *me;
 312         ModestProgressBarWidgetPrivate *priv;
 313
 314         me = MODEST_PROGRESS_BAR_WIDGET (self);
 315         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 316
 317         if (priv->current == NULL) return;
 318         modest_mail_operation_cancel (priv->current);
 319
 320 }
 321 static void
 322 on_progress_changed (ModestMailOperation  *mail_op,
 323                      ModestProgressBarWidget *self)
 324 {
 325         ModestProgressBarWidgetPrivate *priv;
 326         gboolean determined = FALSE;
 327         ModestMailOperationId id;
 328
 329         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 330
 331         /* If the mail operation is the currently shown one */
 332         if (priv->current == mail_op) {
 333                 gchar *msg = NULL;
 334                 guint done  = modest_mail_operation_get_task_done (mail_op);
 335                 guint total = modest_mail_operation_get_task_total (mail_op);
 336
 337                 determined = (done > 0 && total > 0) & !(done == 1 && total == 100);
 338                 id = modest_mail_operation_get_id (mail_op);
 339
 340                 switch (id) {
 341                 case MODEST_MAIL_OPERATION_ID_RECEIVE:
 342                         if (determined)
 343 /*                              msg = g_strdup_printf(_("mcen_me_receiving"), done, total); */
 344                                 msg = g_strdup_printf("Receiving %d/%d", done, total);
 345                         else
 346 /*                              msg = g_strdup(_("mail_me_receiving")); */
 347                                 msg = g_strdup("Receiving ...");
 348                         break;
 349                 case MODEST_MAIL_OPERATION_ID_SEND:
 350                         if (determined)
 351                                 msg = g_strdup_printf(_("mcen_me_sending"), done, total);
 352                         else
 353                                 msg = g_strdup(_("mail_me_sending"));
 354                         break;
 355
 356                 case MODEST_MAIL_OPERATION_ID_OPEN:
 357                         msg = g_strdup(_("mail_me_opening"));
 358                         break;
 359                 default:
 360                         msg = g_strdup("");
 361                 }
 362
 363                 modest_progress_bar_widget_set_progress (self, msg, done, total);
 364                 g_free (msg);
 365         }
 366 }
 367
 368 static gboolean
 369 progressbar_clean (GtkProgressBar *bar)
 370 {
 371         gtk_progress_bar_set_fraction (bar, 0);
 372         gtk_progress_bar_set_text (bar, 0);
 373         return FALSE;
 374 }
 375
 376
 377 GtkWidget*
 378 modest_progress_bar_widget_new ()
 379 {
 380         return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
 381 }
 382
 383
 384 void
 385 modest_progress_bar_widget_set_progress   (ModestProgressBarWidget *self,
 386                                            const gchar *message,
 387                                            guint done,
 388                                            guint total)
 389 {
 390         ModestProgressBarWidgetPrivate *priv;
 391
 392         g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
 393         g_return_if_fail (done <= total);
 394
 395         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 396
 397         /* Set progress */
 398         if (total != 0)
 399                 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
 400                                                (gdouble)done/(gdouble)total);
 401         else
 402                 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
 403
 404         /* Set text */
 405         gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);
 406 }
 407