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

   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 #ifndef __MODEST_PROGRESS_BAR_WIDGET_H__
  31 #define __MODEST_PROGRESS_BAR_WIDGET_H__
  32
  33 #include <gtk/gtkvbox.h>
  34 #include "modest-progress-object.h"
  35
  36 G_BEGIN_DECLS
  37
  38 /* convenience macros */
  39 #define MODEST_TYPE_PROGRESS_BAR_WIDGET             (modest_progress_bar_widget_get_type())
  40 #define MODEST_PROGRESS_BAR_WIDGET(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_PROGRESS_BAR_WIDGET,ModestProgressBarWidget))
  41 #define MODEST_PROGRESS_BAR_WIDGET_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_PROGRESS_BAR_WIDGET,GtkContainer))
  42 #define MODEST_IS_PROGRESS_BAR_WIDGET(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_PROGRESS_BAR_WIDGET))
  43 #define MODEST_IS_PROGRESS_BAR_WIDGET_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_PROGRESS_BAR_WIDGET))
  44 #define MODEST_PROGRESS_BAR_WIDGET_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_PROGRESS_BAR_WIDGET,ModestProgressBarWidgetClass))
  45
  46 typedef struct _ModestProgressBarWidget      ModestProgressBarWidget;
  47 typedef struct _ModestProgressBarWidgetClass ModestProgressBarWidgetClass;
  48
  49 struct _ModestProgressBarWidget {
  50          GtkVBox parent;
  51         /* insert public members, if any */
  52 };
  53
  54 struct _ModestProgressBarWidgetClass {
  55         GtkVBoxClass parent_class;
  56
  57 };
  58
  59 typedef enum {
  60         STATUS_RECEIVING,
  61         STATUS_SENDING,
  62         STATUS_OPENING
  63 } ModestProgressStatus;
  64
  65
  66
  67 /* member functions */
  68 GType        modest_progress_bar_widget_get_type    (void) G_GNUC_CONST;
  69
  70 GtkWidget*   modest_progress_bar_widget_new         (void);
  71
  72 void modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
  73                                               const gchar *msg,
  74                                               gint done,
  75                                               gint total);
  76
  77 void
  78 modest_progress_bar_widget_set_undetermined_progress (ModestProgressBarWidget *self,
  79                                                       ModestMailOperation *mail_op);
  80
  81
  82 G_END_DECLS
  83
  84 #endif /* __MODEST_PROGRESS_BAR_WIDGET_H__ */
  85