git.maemo.org Git - modest/blob - src/gnome/modest-gnome-info-bar.h

   1 /* modest-gnome-bar.h */
   2 /* insert (c)/licensing information) */
   3
   4 #ifndef __MODEST_GNOME_INFO_BAR_H__
   5 #define __MODEST_GNOME_INFO_BAR_H__
   6
   7 #include <gtk/gtkhbox.h>
   8 #include "modest-progress-object.h"
   9 /* other include files */
  10
  11 G_BEGIN_DECLS
  12
  13 /* convenience macros */
  14 #define MODEST_TYPE_GNOME_INFO_BAR             (modest_gnome_info_bar_get_type())
  15 #define MODEST_GNOME_INFO_BAR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_GNOME_INFO_BAR,ModestGnomeInfoBar))
  16 #define MODEST_GNOME_INFO_BAR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_GNOME_INFO_BAR,ModestProgressObject))
  17 #define MODEST_IS_GNOME_INFO_BAR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_GNOME_INFO_BAR))
  18 #define MODEST_IS_GNOME_INFO_BAR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_GNOME_INFO_BAR))
  19 #define MODEST_GNOME_INFO_BAR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_GNOME_INFO_BAR,ModestGnomeInfoBarClass))
  20
  21 typedef struct _ModestGnomeInfoBar      ModestGnomeInfoBar;
  22 typedef struct _ModestGnomeInfoBarClass ModestGnomeInfoBarClass;
  23
  24 struct _ModestGnomeInfoBar {
  25          GtkHBox parent;
  26 };
  27
  28 struct _ModestGnomeInfoBarClass {
  29         GtkHBoxClass parent_class;
  30 };
  31
  32 /* member functions */
  33 GType         modest_gnome_info_bar_get_type       (void) G_GNUC_CONST;
  34
  35 /* typical parameter-less _new function */
  36 GtkWidget*    modest_gnome_info_bar_new            (void);
  37
  38 /**
  39  * modest_gnome_info_bar_new:
  40  * @void:
  41  *
  42  * Sets a text in the status bar of the widget
  43  *
  44  * Return value:
  45  **/
  46 void          modest_gnome_info_bar_set_message    (ModestGnomeInfoBar *self,
  47                                                     const gchar *message);
  48
  49
  50 /**
  51  * modest_gnome_info_bar_set_progress:
  52  * @self:
  53  * @message:
  54  * @done:
  55  * @total:
  56  *
  57  * Causes the progress bar of the widget to fill in the amount of work
  58  * done of a given total. If message is supplied then it'll be
  59  * superimposed on the progress bar
  60  **/
  61 void          modest_gnome_info_bar_set_progress   (ModestGnomeInfoBar *self,
  62                                                     const gchar *message,
  63                                                     gint done,
  64                                                     gint total);
  65
  66 G_END_DECLS
  67
  68 #endif /* __MODEST_GNOME_INFO_BAR_H__ */
  69