git.maemo.org Git - modest/blob - src/modest-singletons.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_SINGLETONS_H__
  31 #define __MODEST_SINGLETONS_H__
  32
  33 #include <config.h>
  34
  35 #include <glib-object.h>
  36 #include <modest-conf.h>
  37 #include <modest-email-clipboard.h>
  38 #include <modest-account-mgr.h>
  39 #include <modest-mail-operation-queue.h>
  40 #include <modest-cache-mgr.h>
  41 #include <modest-tny-platform-factory.h>
  42 #include <widgets/modest-toolkit-factory.h>
  43 #include "modest-plugin-factory.h"
  44 #include "widgets/modest-window-mgr.h"
  45 #include "modest-protocol-registry.h"
  46 #include <tny-stream-cache.h>
  47
  48 G_BEGIN_DECLS
  49
  50 /* convenience macros */
  51 #define MODEST_TYPE_SINGLETONS             (modest_singletons_get_type())
  52 #define MODEST_SINGLETONS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SINGLETONS,ModestSingletons))
  53 #define MODEST_SINGLETONS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SINGLETONS,GObject))
  54 #define MODEST_IS_SINGLETONS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SINGLETONS))
  55 #define MODEST_IS_SINGLETONS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SINGLETONS))
  56 #define MODEST_SINGLETONS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SINGLETONS,ModestSingletonsClass))
  57
  58 typedef struct _ModestSingletons      ModestSingletons;
  59 typedef struct _ModestSingletonsClass ModestSingletonsClass;
  60
  61 struct _ModestSingletons {
  62          GObject parent;
  63 };
  64
  65 struct _ModestSingletonsClass {
  66         GObjectClass parent_class;
  67 };
  68
  69
  70 /**
  71  * modest_singletons_get_type:
  72  *
  73  * get the GType for ModestSingletons
  74  *
  75  * Returns: the GType
  76  */
  77 GType        modest_singletons_get_type    (void) G_GNUC_CONST;
  78
  79
  80 /**
  81  * modest_singletons_new:
  82  *
  83  * create a new ModestSingletons instance;
  84  * don't use this function directly, use the modest-runtime
  85  * functions instead.
  86  *
  87  * Returns: a new ModestSingletons instance, or NULL in case
  88  * of any error
  89  */
  90 ModestSingletons*    modest_singletons_new         (void);
  91
  92
  93 /**
  94  * modest_singletons_get_conf:
  95  * @self: a valid ModestSingletons instance
  96  *
  97  * get the ModestConf singleton instance
  98  * don't use this function directly, use the modest-runtime
  99  * functions instead.
 100  *
 101  * Returns: the ModestConf singleton
 102  **/
 103 ModestConf*               modest_singletons_get_conf          (ModestSingletons *self);
 104
 105
 106 /**
 107  * modest_singletons_get_account_mgr:
 108  * @self: a valid ModestSingletons instance
 109  *
 110  * get the ModestAccountMgr singleton instance
 111  * don't use this function directly, use the modest-runtime
 112  * functions instead.
 113  *
 114  * Returns: the ModestAccountMgr singleton
 115  **/
 116 ModestAccountMgr*         modest_singletons_get_account_mgr   (ModestSingletons *self);
 117
 118 /**
 119  * modest_singletons_get_account_mgr:
 120  * @self: a valid #ModestSingletons instance
 121  *
 122  * get the #ModestEamilClipboard singleton instance
 123  * don't use this function directly, use the modest-runtime
 124  * functions instead.
 125  *
 126  * Returns: the #ModestEmailClipboard singleton
 127  **/
 128 ModestEmailClipboard*      modest_singletons_get_email_clipboard (ModestSingletons *self);
 129
 130
 131 /**
 132  * modest_singletons_get_cache_mgr:
 133  * @self: a valid #ModestSingletons instance
 134  *
 135  * get the #ModestCacheMgr singleton instance
 136  * don't use this function directly, use the modest-runtime
 137  * functions instead.
 138  *
 139  * Returns: the #ModestCacheMgr singleton
 140  **/
 141 ModestCacheMgr*           modest_singletons_get_cache_mgr     (ModestSingletons *self);
 142
 143
 144
 145 /**
 146  * modest_singletons_get_platform_factory:
 147  * @self: a valid #ModestSingletons instance
 148  *
 149  * get the #TnyPlatformFactory singleton instance
 150  * don't use this function directly, use the modest-runtime
 151  * functions instead.
 152  *
 153  * Returns: the #TnyPlatformFactory singleton
 154  **/
 155 TnyPlatformFactory*       modest_singletons_get_platform_factory  (ModestSingletons *self);
 156
 157 /**
 158  * modest_singletons_get_toolkit_factory:
 159  * @self: a valid #ModestSingletons instance
 160  *
 161  * get the #TnyToolkitFactory singleton instance
 162  * don't use this function directly, use the modest-runtime
 163  * functions instead.
 164  *
 165  * Returns: the #ModestToolkitFactory singleton
 166  **/
 167 ModestToolkitFactory*       modest_singletons_get_toolkit_factory  (ModestSingletons *self);
 168
 169
 170 /**
 171  * modest_singletons_get_device:
 172  * @self: a valid #ModestSingletons instance
 173  *
 174  * get the #TnyDevice singleton instance
 175  * don't use this function directly, use the modest-runtime
 176  * functions instead.
 177  *
 178  * Returns: the #TnyDevice singleton
 179  **/
 180 TnyDevice*                 modest_singletons_get_device       (ModestSingletons *self);
 181
 182
 183 /**
 184  * modest_singletons_get_mail_operation_queue:
 185  * @self: a valid ModestSingletons instance
 186  *
 187  * get the ModestMailOperationQueue singleton instance
 188  * don't use this function directly, use the modest-runtime
 189  * functions instead.
 190  *
 191  * Returns: the ModestMailOperationQueue singleton
 192  **/
 193 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
 194
 195 /**
 196  * modest_singletons_get_window_mgr:
 197  * @self:
 198  *
 199  * Gets the #ModestWindowMgr singleton instance. Don't use this
 200  * function directly, use the modest-runtime function instead.
 201  *
 202  * Return value: the singleton instance of #ModestWindowMgr
 203  **/
 204 ModestWindowMgr*          modest_singletons_get_window_mgr           (ModestSingletons *self);
 205
 206 /**
 207  * modest_singletons_get_protocol_registry:
 208  * @self:
 209  *
 210  * Gets the #ModestProtocolRegistry singleton instance. Don't use this
 211  * function directly, use the modest-runtime function instead.
 212  *
 213  * Return value: the singleton instance of #ModestProtocolRegistry
 214  **/
 215 ModestProtocolRegistry*          modest_singletons_get_protocol_registry           (ModestSingletons *self);
 216
 217 /**
 218  * modest_singletons_get_images_cache:
 219  * @self: a #ModestSingletons
 220  *
 221  * Gets the #TnyStreamCache used to store the external images cache.
 222  */
 223 TnyStreamCache*           modest_singletons_get_images_cache         (ModestSingletons *self);
 224
 225 /**
 226  * modest_singletons_get_plugin_factory:
 227  * @self: a #ModestSingletons
 228  *
 229  * Gets the #ModestMailPluginFactory singleton.
 230  */
 231 ModestPluginFactory*           modest_singletons_get_plugin_factory         (ModestSingletons *self);
 232
 233 G_END_DECLS
 234
 235 #endif /* __MODEST_SINGLETONS_H__ */
 236