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 "modest-account-mgr.h"
  34 #include "modest-tny-account-store.h"
  35 #include "widgets/modest-header-view.h"
  36 #include "widgets/modest-folder-view.h"
  37 #include "widgets/modest-msg-view.h"
  38 #include "widgets/modest-account-view.h"
  39 #include "widgets/modest-toolbar.h"
  40 #include "widgets/modest-combo-box.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 typedef 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         MODEST_COMBO_BOX_TYPE_TRANSPORTS
  73 } 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   (void);
  97 /**
  98  * modest_widget_factory_get_folder_view
  99  * @self: a ModestWidgetFactory instance
 100  *
 101  * return the folder tree widget (ie. the widget with the list of folders);
 102  *
 103  * This factory will always return the
 104  * same widget, and takes care of its lifetime - users should *not* destroy it.
 105  *
 106  * Returns: a folder tree view, or NULL in case of error
 107  */
 108 ModestFolderView*    modest_widget_factory_get_folder_view (ModestWidgetFactory *self);
 109
 110
 111 /**
 112  * modest_widget_factory_get_header_view
 113  * @self: a ModestWidgetFactory instance
 114  *
 115  * return the header tree widget (ie. the widget with the list of headers);
 116  *
 117  * This factory will always return the
 118  * same widget, and takes care of its lifetime - users should *not* destroy it.
 119  *
 120  * Returns: a header tree view, or NULL in case of error
 121  */
 122 ModestHeaderView*    modest_widget_factory_get_header_view (ModestWidgetFactory *self);
 123
 124
 125 /**
 126  * modest_widget_factory_get_msg_preview
 127  * @self: a ModestWidgetFactory instance
 128  *
 129  * return the message preview widget (ie. the widget with shows the currently selected message);
 130  *
 131  * This factory will always return the
 132  * same widget, and takes care of its lifetime - users should *not* destroy it.
 133  *
 134  * Returns: a header tree view, or NULL in case of error
 135  */
 136 ModestMsgView*           modest_widget_factory_get_msg_preview (ModestWidgetFactory *self);
 137
 138
 139 /**
 140  * modest_widget_factory_get_account_view
 141  * @self: a ModestWidgetFactory instance
 142  *
 143  * return an account view widget (ie. the widget that shows a list of accounts)
 144  *
 145  * This factory will always return the
 146  * same widget, and takes care of its lifetime - users should *not* destroy it.
 147  *
 148  * Returns: the account view, or NULL in case of error
 149  */
 150 ModestAccountView*    modest_widget_factory_get_account_view (ModestWidgetFactory *self);
 151
 152
 153 /**
 154  * modest_widget_factory_get_progress_bar
 155  * @self: a ModestWidgetFactory instance
 156  *
 157  * return an progress bar widget
 158  * if the widget factory was created with 'auto_connect', then this progress bar
 159  * will automatically update for changes in the other widgets
 160  * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
 161  *
 162  * This factory will always return the
 163  * same widget, and takes care of its lifetime - users should *not* destroy it.
 164  *
 165  * Returns: the progress bar widget
 166  */
 167 GtkWidget*       modest_widget_factory_get_progress_bar (ModestWidgetFactory *self);
 168
 169
 170
 171 /**
 172  * modest_widget_factory_get_status_bar
 173  * @self: a ModestWidgetFactory instance
 174  *
 175  * return an status bar widget
 176  * if the widget factory was created with 'auto_connect', then this status bar
 177  * will automatically update for changes in the other widgets
 178  * NOTE the naming inconsistency: GtkProgressBar vs GtkStatusbar
 179  *
 180  * This factory will always return the
 181  * same widget, and takes care of its lifetime - users should *not* destroy it.
 182  *
 183  * Returns: the status bar widget
 184  */
 185 GtkWidget*     modest_widget_factory_get_status_bar (ModestWidgetFactory *self);
 186
 187 /**
 188  * modest_widget_factory_get_store
 189  * @self: a ModestWidgetFactory instance
 190  * @type: the type of items we want a combo box for
 191  *
 192  * return a combobox with with the given items
 193  *
 194  * Returns: the combo box
 195  */
 196 GtkWidget*     modest_widget_factory_get_combo_box (ModestWidgetFactory *self,
 197                                                     ModestComboBoxType type);
 198
 199
 200 /**
 201  * modest_widget_factory_get_online_combo
 202  * @self: a ModestWidgetFactory instance
 203  *
 204  * return a toggle which with one can see whether online/offline mode is active.
 205  * In case of auto-connect, this will automatically be sync'd with the
 206  * account_store / device
 207  *
 208  * Returns: the combo box
 209  */
 210 GtkWidget*  modest_widget_factory_get_online_toggle (ModestWidgetFactory *self);
 211
 212
 213
 214
 215 /**
 216  * modest_widget_factory_get_folder_info_label
 217  * @self: a ModestWidgetFactory instance
 218  *
 219  * return a label with the number of items, unread items in the current folder
 220  *
 221  * Returns: the label
 222  */
 223 GtkWidget* modest_widget_factory_get_folder_info_label (ModestWidgetFactory *self);
 224
 225
 226 /**
 227  * modest_widget_factory_get_main_toolbar
 228  * @self: a ModestWidgetFactory instance
 229  * @items: a list of ModestToolbarButtons (button_ids)
 230  *
 231  * returns the main toolbar widget; their enabled/disabled state synchronized with
 232  * the other widgets. Note that after the first calling, this function will
 233  * always return the same toolbar, regardless of the items
 234  *
 235  * Returns: the toolbar
 236  */
 237 ModestToolbar *modest_widget_factory_get_main_toolbar (ModestWidgetFactory *self,
 238                                                        GSList *items);
 239
 240 /**
 241  * modest_widget_factory_get_edit_toolbar
 242  * @self: a ModestWidgetFactory instance
 243  * @items: a list of ModestToolbarButtons (button_ids)
 244  *
 245  * returns the toolbar widget for edit windows; the enabled/disabled
 246  * state synchronized with the other widgets.
 247  *
 248  * Returns: the toolbar
 249  */
 250 ModestToolbar *modest_widget_factory_get_edit_toolbar (ModestWidgetFactory *self,
 251                                                        GSList *items);
 252
 253
 254 G_END_DECLS
 255
 256 #endif /* __MODEST_WIDGET_FACTORY_H__ */
 257