git.maemo.org Git - modest/blob - src/gnome/modest-gnome-info-bar.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
  31 #ifndef __MODEST_GNOME_INFO_BAR_H__
  32 #define __MODEST_GNOME_INFO_BAR_H__
  33
  34 #include <gtk/gtkhbox.h>
  35 #include "modest-progress-object.h"
  36 /* other include files */
  37
  38 G_BEGIN_DECLS
  39
  40 /* convenience macros */
  41 #define MODEST_TYPE_GNOME_INFO_BAR             (modest_gnome_info_bar_get_type())
  42 #define MODEST_GNOME_INFO_BAR(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_GNOME_INFO_BAR,ModestGnomeInfoBar))
  43 #define MODEST_GNOME_INFO_BAR_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_GNOME_INFO_BAR,ModestProgressObject))
  44 #define MODEST_IS_GNOME_INFO_BAR(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_GNOME_INFO_BAR))
  45 #define MODEST_IS_GNOME_INFO_BAR_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_GNOME_INFO_BAR))
  46 #define MODEST_GNOME_INFO_BAR_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_GNOME_INFO_BAR,ModestGnomeInfoBarClass))
  47
  48 typedef struct _ModestGnomeInfoBar      ModestGnomeInfoBar;
  49 typedef struct _ModestGnomeInfoBarClass ModestGnomeInfoBarClass;
  50
  51 struct _ModestGnomeInfoBar {
  52          GtkHBox parent;
  53 };
  54
  55 struct _ModestGnomeInfoBarClass {
  56         GtkHBoxClass parent_class;
  57 };
  58
  59 /* member functions */
  60 GType         modest_gnome_info_bar_get_type       (void) G_GNUC_CONST;
  61
  62 /* typical parameter-less _new function */
  63 GtkWidget*    modest_gnome_info_bar_new            (void);
  64
  65 /**
  66  * modest_gnome_info_bar_new:
  67  * @void:
  68  *
  69  * Sets a text in the status bar of the widget
  70  *
  71  * Return value:
  72  **/
  73 void          modest_gnome_info_bar_set_message    (ModestGnomeInfoBar *self,
  74                                                     const gchar *message);
  75
  76
  77 /**
  78  * modest_gnome_info_bar_set_progress:
  79  * @self:
  80  * @message:
  81  * @done:
  82  * @total:
  83  *
  84  * Causes the progress bar of the widget to fill in the amount of work
  85  * done of a given total. If message is supplied then it'll be
  86  * superimposed on the progress bar
  87  **/
  88 void          modest_gnome_info_bar_set_progress   (ModestGnomeInfoBar *self,
  89                                                     const gchar *message,
  90                                                     gint done,
  91                                                     gint total);
  92
  93 G_END_DECLS
  94
  95 #endif /* __MODEST_GNOME_INFO_BAR_H__ */
  96