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