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