git.maemo.org Git - modest/blob - src/modest-widget-factory.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_WIDGET_FACTORY_H__
  31 #define __MODEST_WIDGET_FACTORY_H__
  32
  33 #include <glib-object.h>
  34 #include "modest-account-mgr.h"
  35 #include "modest-tny-account-store.h"
  36
  37 #include "widgets/modest-header-view.h"
  38 #include "widgets/modest-folder-view.h"
  39 #include "widgets/modest-msg-view.h"
  40 #include "widgets/modest-account-view.h"
  41
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_WIDGET_FACTORY             (modest_widget_factory_get_type())
  46 #define MODEST_WIDGET_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_WIDGET_FACTORY,ModestWidgetFactory))
  47 #define MODEST_WIDGET_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_WIDGET_FACTORY,GObject))
  48 #define MODEST_IS_WIDGET_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_WIDGET_FACTORY))
  49 #define MODEST_IS_WIDGET_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_WIDGET_FACTORY))
  50 #define MODEST_WIDGET_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_WIDGET_FACTORY,ModestWidgetFactoryClass))
  51
  52 typedef struct _ModestWidgetFactory      ModestWidgetFactory;
  53 typedef struct _ModestWidgetFactoryClass ModestWidgetFactoryClass;
  54
  55 struct _ModestWidgetFactory {
  56          GObject parent;
  57         /* insert public members, if any */
  58 };
  59
  60 struct _ModestWidgetFactoryClass {
  61         GObjectClass parent_class;
  62         /* insert signal callback declarations, eg. */
  63         /* void (* my_event) (ModestWidgetFactory* obj); */
  64 };
  65
  66
  67 enum _ModestComboBoxType {
  68         MODEST_COMBO_BOX_TYPE_STORE_PROTOS,
  69         MODEST_COMBO_BOX_TYPE_TRANSPORT_PROTOS,
  70         MODEST_COMBO_BOX_TYPE_SECURITY_PROTOS,
  71         MODEST_COMBO_BOX_TYPE_AUTH_PROTOS,
  72 };
  73 typedef enum _ModestComboBoxType ModestComboBoxType;
  74
  75
  76 /**
  77  * modest_widget_factory_get_type
  78  *
  79  * get the GType for ModestWidgetFactory
  80  *
  81  * Returns: the GType
  82  */
  83 GType        modest_widget_factory_get_type    (void) G_GNUC_CONST;
  84
  85
  86 /**
  87  * modest_widget_factory_new
  88  * @conf: a modest conf instance
  89  * @acc_store: a modest account store instance
  90  * @acc_mgr: a modest account mgr instance
  91  *
  92  * instantiates a ModestWidgetFactory
  93  *
  94  * Returns: a new ModestWidgetFactory, or NULL in case of error
  95  */
  96 ModestWidgetFactory*      modest_widget_factory_new   (ModestConf *conf,
  97                                                        ModestTnyAccountStore *acc_store,
  98                                                        ModestAccountMgr *account_mgr);
  99 /**
 100  * modest_widget_factory_get_folder_view
 101  * @self: a ModestWidgetFactory instance
 102  *
 103  * return the folder tree widget (ie. the widget with the list of folders);
 104  *
 105  * This factory will always return the
 106  * same widget, and takes care of its lifetime - users should *not* destroy it.
 107  *
 108  * Returns: a folder tree view, or NULL in case of error
 109  */
 110 ModestFolderView*    modest_widget_factory_get_folder_view (ModestWidgetFactory *self);
 111
 112
 113 /**
 114  * modest_widget_factory_get_header_view
 115  * @self: a ModestWidgetFactory instance
 116  *
 117  * return the header tree widget (ie. the widget with the list of headers);
 118  *
 119  * This factory will always return the
 120  * same widget, and takes care of its lifetime - users should *not* destroy it.
 121  *
 122  * Returns: a header tree view, or NULL in case of error
 123  */
 124 ModestHeaderView*    modest_widget_factory_get_header_view (ModestWidgetFactory *self);
 125
 126
 127 /**
 128  * modest_widget_factory_get_msg_preview
 129  * @self: a ModestWidgetFactory instance
 130  *
 131  * return the message preview widget (ie. the widget with shows the currently selected message);
 132  *
 133  * This factory will always return the
 134  * same widget, and takes care of its lifetime - users should *not* destroy it.
 135  *
 136  * Returns: a header tree view, or NULL in case of error
 137  */
 138 ModestMsgView*           modest_widget_factory_get_msg_preview (ModestWidgetFactory *self);
 139
 140
 141 /**
 142  * modest_widget_factory_get_account_view
 143  * @self: a ModestWidgetFactory instance
 144  *
 145  * return an account view widget (ie. the widget that shows a list of accounts)
 146  *
 147  * This factory will always return the
 148  * same widget, and takes care of its lifetime - users should *not* destroy it.
 149  *
 150  * Returns: the account view, or NULL in case of error
 151  */
 152 ModestAccountView*    modest_widget_factory_get_account_view (ModestWidgetFactory *self);
 153
 154
 155 /**
 156  * modest_widget_factory_get_progress_bar
 157  * @self: a ModestWidgetFactory instance
 158  *
 159  * return an progress bar widget
 160  * if the widget factory was created with 'auto_connect', then this progress bar
 161  * will automatically update for changes in the other widgets
 162  * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
 163  *
 164  * This factory will always return the
 165  * same widget, and takes care of its lifetime - users should *not* destroy it.
 166  *
 167  * Returns: the progress bar widget
 168  */
 169 GtkWidget*       modest_widget_factory_get_progress_bar (ModestWidgetFactory *self);
 170
 171
 172
 173 /**
 174  * modest_widget_factory_get_status_bar
 175  * @self: a ModestWidgetFactory instance
 176  *
 177  * return an status bar widget
 178  * if the widget factory was created with 'auto_connect', then this status bar
 179  * will automatically update for changes in the other widgets
 180  * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
 181  *
 182  * This factory will always return the
 183  * same widget, and takes care of its lifetime - users should *not* destroy it.
 184  *
 185  * Returns: the status bar widget
 186  */
 187 GtkWidget*     modest_widget_factory_get_status_bar (ModestWidgetFactory *self);
 188
 189 /**
 190  * modest_widget_factory_get_store
 191  * @self: a ModestWidgetFactory instance
 192  * @type: the type of items we want a combo box for
 193  *
 194  * return a combobox with with the given items
 195  *
 196  * Returns: the combo box
 197  */
 198 GtkWidget*     modest_widget_factory_get_combo_box (ModestWidgetFactory *self,
 199                                                     ModestComboBoxType type);
 200
 201
 202 /**
 203  * modest_widget_factory_get_online_combo
 204  * @self: a ModestWidgetFactory instance
 205  *
 206  * return a toggle which with one can see whether online/offline mode is active.
 207  * In case of auto-connect, this will automatically be sync'd with the
 208  * account_store / device
 209  *
 210  * Returns: the combo box
 211  */
 212 GtkWidget*  modest_widget_factory_get_online_toggle (ModestWidgetFactory *self);
 213
 214
 215
 216
 217
 218 G_END_DECLS
 219
 220 #endif /* __MODEST_WIDGET_FACTORY_H__ */
 221