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