git.maemo.org Git - modest/blob - src/gnome/modest-gnome-info-bar.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
  31 #include "modest-gnome-info-bar.h"
  32 #include <gtk/gtkprogressbar.h>
  33 #include <gtk/gtkstatusbar.h>
  34 /* include other impl specific header files */
  35
  36 /* 'private'/'protected' functions */
  37 static void modest_gnome_info_bar_class_init (ModestGnomeInfoBarClass *klass);
  38 static void modest_gnome_info_bar_init       (ModestGnomeInfoBar *obj);
  39 static void modest_gnome_info_bar_finalize   (GObject *obj);
  40
  41 static void modest_gnome_info_bar_add_operation    (ModestProgressObject *self,
  42                                                     ModestMailOperation  *mail_op);
  43
  44 static void modest_gnome_info_bar_remove_operation (ModestProgressObject *self,
  45                                                     ModestMailOperation  *mail_op);
  46
  47 static void on_progress_changed                    (ModestMailOperation  *mail_op,
  48                                                     ModestGnomeInfoBar *self);
  49
  50 static gboolean     progressbar_clean        (GtkProgressBar *bar);
  51 static gboolean     statusbar_clean          (GtkStatusbar *bar);
  52
  53 /* list my signals  */
  54 enum {
  55         /* MY_SIGNAL_1, */
  56         /* MY_SIGNAL_2, */
  57         LAST_SIGNAL
  58 };
  59
  60 typedef struct _ObservableData ObservableData;
  61 struct _ObservableData {
  62         guint signal_handler;
  63         ModestMailOperation *mail_op;
  64 };
  65
  66 typedef struct _ModestGnomeInfoBarPrivate ModestGnomeInfoBarPrivate;
  67 struct _ModestGnomeInfoBarPrivate {
  68         GSList              *observables;
  69         ModestMailOperation *current;
  70
  71         GtkWidget *status_bar;
  72         GtkWidget *progress_bar;
  73
  74         guint status_bar_timeout;
  75         guint progress_bar_timeout;
  76 };
  77
  78 #define MODEST_GNOME_INFO_BAR_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  79                                               MODEST_TYPE_GNOME_INFO_BAR, \
  80                                               ModestGnomeInfoBarPrivate))
  81 /* globals */
  82 static GtkHBoxClass *parent_class = NULL;
  83
  84 /* uncomment the following if you have defined any signals */
  85 /* static guint signals[LAST_SIGNAL] = {0}; */
  86
  87 static void
  88 modest_progress_object_init (gpointer g, gpointer iface_data)
  89 {
  90         ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
  91
  92         klass->add_operation_func = modest_gnome_info_bar_add_operation;
  93         klass->remove_operation_func = modest_gnome_info_bar_remove_operation;
  94 }
  95
  96 GType
  97 modest_gnome_info_bar_get_type (void)
  98 {
  99         static GType my_type = 0;
 100         if (!my_type) {
 101                 static const GTypeInfo my_info = {
 102                         sizeof(ModestGnomeInfoBarClass),
 103                         NULL,           /* base init */
 104                         NULL,           /* base finalize */
 105                         (GClassInitFunc) modest_gnome_info_bar_class_init,
 106                         NULL,           /* class finalize */
 107                         NULL,           /* class data */
 108                         sizeof(ModestGnomeInfoBar),
 109                         1,              /* n_preallocs */
 110                         (GInstanceInitFunc) modest_gnome_info_bar_init,
 111                         NULL
 112                 };
 113
 114                 static const GInterfaceInfo modest_progress_object_info =
 115                 {
 116                   (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
 117                   NULL,         /* interface_finalize */
 118                   NULL          /* interface_data */
 119                 };
 120
 121                 my_type = g_type_register_static (GTK_TYPE_HBOX,
 122                                                   "ModestGnomeInfoBar",
 123                                                   &my_info, 0);
 124
 125                 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
 126                                              &modest_progress_object_info);
 127         }
 128         return my_type;
 129 }
 130
 131 static void
 132 modest_gnome_info_bar_class_init (ModestGnomeInfoBarClass *klass)
 133 {
 134         GObjectClass *gobject_class;
 135         gobject_class = (GObjectClass*) klass;
 136
 137         parent_class            = g_type_class_peek_parent (klass);
 138         gobject_class->finalize = modest_gnome_info_bar_finalize;
 139
 140         g_type_class_add_private (gobject_class, sizeof(ModestGnomeInfoBarPrivate));
 141 }
 142
 143 static void
 144 modest_gnome_info_bar_init (ModestGnomeInfoBar *obj)
 145 {
 146         ModestGnomeInfoBarPrivate *priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE(obj);
 147
 148         priv->observables = NULL;
 149         priv->current = NULL;
 150
 151         /* Status bar */
 152         priv->status_bar = gtk_statusbar_new ();
 153         gtk_statusbar_set_has_resize_grip (GTK_STATUSBAR (priv->status_bar), FALSE);
 154
 155         /* Progress bar */
 156         priv->progress_bar = gtk_progress_bar_new ();
 157         gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar), 1.0);
 158         gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar),
 159                                         PANGO_ELLIPSIZE_END);
 160
 161         /* Timeouts */
 162         priv->status_bar_timeout = 0;
 163         priv->progress_bar_timeout = 0;
 164
 165         /* Pack */
 166         gtk_box_pack_start (GTK_BOX (obj), priv->status_bar, TRUE, TRUE, 0);
 167         gtk_box_pack_start (GTK_BOX (obj), priv->progress_bar, FALSE, FALSE, 0);
 168 }
 169
 170 static void
 171 destroy_observable_data (ObservableData *data)
 172 {
 173         g_signal_handler_disconnect (data->mail_op, data->signal_handler);
 174         g_object_unref (data->mail_op);
 175 }
 176
 177 static void
 178 modest_gnome_info_bar_finalize (GObject *obj)
 179 {
 180         ModestGnomeInfoBarPrivate *priv;
 181
 182         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE(obj);
 183         if (priv->observables) {
 184                 GSList *tmp;
 185
 186                 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
 187                         destroy_observable_data ((ObservableData *) tmp->data);
 188                         g_free (tmp->data);
 189                 }
 190                 g_slist_free (priv->observables);
 191                 priv->observables = NULL;
 192         }
 193
 194         if (priv->status_bar_timeout > 0) {
 195                 g_source_remove (priv->status_bar_timeout);
 196                 priv->status_bar_timeout = 0;
 197         }
 198
 199         if (priv->progress_bar_timeout > 0) {
 200                 g_source_remove (priv->progress_bar_timeout);
 201                 priv->progress_bar_timeout = 0;
 202         }
 203
 204         G_OBJECT_CLASS(parent_class)->finalize (obj);
 205 }
 206
 207 GtkWidget *
 208 modest_gnome_info_bar_new (void)
 209 {
 210         return GTK_WIDGET (g_object_new (MODEST_TYPE_GNOME_INFO_BAR, NULL));
 211 }
 212
 213 static void
 214 modest_gnome_info_bar_add_operation (ModestProgressObject *self,
 215                                      ModestMailOperation  *mail_op)
 216 {
 217         ModestGnomeInfoBar *me;
 218         ObservableData *data;
 219         ModestGnomeInfoBarPrivate *priv;
 220
 221         me = MODEST_GNOME_INFO_BAR (self);
 222         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (me);
 223
 224         data = g_malloc0 (sizeof (ObservableData));
 225         data->mail_op = g_object_ref (mail_op);
 226         data->signal_handler = g_signal_connect (data->mail_op,
 227                                                  "progress-changed",
 228                                                  G_CALLBACK (on_progress_changed),
 229                                                  me);
 230
 231         if (priv->observables == NULL) {
 232                 priv->current = mail_op;
 233         }
 234         priv->observables = g_slist_append (priv->observables, data);
 235 }
 236
 237 static gint
 238 compare_observable_data (ObservableData *data1, ObservableData *data2)
 239 {
 240         if (data1->mail_op == data2->mail_op)
 241                 return 0;
 242         else
 243                 return 1;
 244 }
 245
 246 static void
 247 modest_gnome_info_bar_remove_operation (ModestProgressObject *self,
 248                                         ModestMailOperation  *mail_op)
 249 {
 250         ModestGnomeInfoBar *me;
 251         ModestGnomeInfoBarPrivate *priv;
 252         GSList *link;
 253
 254         me = MODEST_GNOME_INFO_BAR (self);
 255         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (me);
 256
 257         link = g_slist_find_custom (priv->observables,
 258                                     mail_op,
 259                                     (GCompareFunc) compare_observable_data);
 260
 261         /* Remove the item */
 262         if (link) {
 263                 priv->observables = g_slist_remove_link (priv->observables, link);
 264                 destroy_observable_data ((ObservableData *) link->data);
 265         }
 266
 267         /* Update the current mail operation */
 268         if (priv->current == mail_op) {
 269                 if (priv->observables)
 270                         priv->current = ((ObservableData *) priv->observables->data)->mail_op;
 271                 else
 272                         priv->current = NULL;
 273
 274                 /* Refresh the view */
 275                 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
 276         }
 277 }
 278
 279 static void
 280 on_progress_changed (ModestMailOperation  *mail_op,
 281                      ModestGnomeInfoBar *self)
 282 {
 283         ModestGnomeInfoBarPrivate *priv;
 284
 285         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
 286
 287         /* If the mail operation is the currently shown one */
 288         if (priv->current == mail_op) {
 289                 gchar *msg = NULL;
 290
 291                 msg = g_strdup_printf ("Mail operation %d of %d",
 292                                        modest_mail_operation_get_task_done (mail_op),
 293                                        modest_mail_operation_get_task_total (mail_op));
 294                 modest_gnome_info_bar_set_message (self, msg);
 295                 g_free (msg);
 296         }
 297 }
 298
 299 static gboolean
 300 progressbar_clean (GtkProgressBar *bar)
 301 {
 302         gtk_progress_bar_set_fraction (bar, 0);
 303         gtk_progress_bar_set_text (bar, 0);
 304         return FALSE;
 305 }
 306
 307 static gboolean
 308 statusbar_clean (GtkStatusbar *bar)
 309 {
 310         gtk_statusbar_push (bar, 0, "");
 311         return FALSE;
 312 }
 313
 314 void
 315 modest_gnome_info_bar_set_message    (ModestGnomeInfoBar *self,
 316                                       const gchar *message)
 317 {
 318         ModestGnomeInfoBarPrivate *priv;
 319
 320         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
 321
 322         /* Set a message. Clean it after 2.5 seconds */
 323         gtk_statusbar_push (GTK_STATUSBAR (priv->status_bar), 0, message);
 324         priv->status_bar_timeout = g_timeout_add (2500,
 325                                                   (GSourceFunc) statusbar_clean,
 326                                                   priv->status_bar);
 327 }
 328
 329 void
 330 modest_gnome_info_bar_set_progress   (ModestGnomeInfoBar *self,
 331                                       const gchar *message,
 332                                       gint done,
 333                                       gint total)
 334 {
 335         ModestGnomeInfoBarPrivate *priv;
 336
 337         priv = MODEST_GNOME_INFO_BAR_GET_PRIVATE (self);
 338
 339         /* Set progress */
 340         if (total != 0)
 341                 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
 342                                                (gdouble)done/(gdouble)total);
 343         else
 344                 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
 345
 346         /* Set text */
 347         gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);
 348 }