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-account-mgr.h>
  38 #include <modest-tny-account-store.h>
  39 #include <modest-mail-operation-queue.h>
  40 #include <modest-cache-mgr.h>
  41 #include <modest-tny-platform-factory.h>
  42
  43 G_BEGIN_DECLS
  44
  45 /* convenience macros */
  46 #define MODEST_TYPE_SINGLETONS             (modest_singletons_get_type())
  47 #define MODEST_SINGLETONS(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SINGLETONS,ModestSingletons))
  48 #define MODEST_SINGLETONS_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SINGLETONS,GObject))
  49 #define MODEST_IS_SINGLETONS(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SINGLETONS))
  50 #define MODEST_IS_SINGLETONS_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SINGLETONS))
  51 #define MODEST_SINGLETONS_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SINGLETONS,ModestSingletonsClass))
  52
  53 typedef struct _ModestSingletons      ModestSingletons;
  54 typedef struct _ModestSingletonsClass ModestSingletonsClass;
  55
  56 struct _ModestSingletons {
  57          GObject parent;
  58 };
  59
  60 struct _ModestSingletonsClass {
  61         GObjectClass parent_class;
  62 };
  63
  64
  65 /**
  66  * modest_singletons_get_type:
  67  *
  68  * get the GType for ModestSingletons
  69  *
  70  * Returns: the GType
  71  */
  72 GType        modest_singletons_get_type    (void) G_GNUC_CONST;
  73
  74
  75 /**
  76  * modest_singletons_new:
  77  *
  78  * create a new ModestSingletons instance;
  79  * don't use this function directly, use the modest-runtime
  80  * functions instead.
  81  *
  82  * Returns: a new ModestSingletons instance, or NULL in case
  83  * of any error
  84  */
  85 ModestSingletons*    modest_singletons_new         (void);
  86
  87
  88 /**
  89  * modest_singletons_get_conf:
  90  * @self: a valid ModestSingletons instance
  91  *
  92  * get the ModestConf singleton instance
  93  * don't use this function directly, use the modest-runtime
  94  * functions instead.
  95  *
  96  * Returns: the ModestConf singleton
  97  **/
  98 ModestConf*               modest_singletons_get_conf          (ModestSingletons *self);
  99
 100
 101 /**
 102  * modest_singletons_get_account_mgr:
 103  * @self: a valid ModestSingletons instance
 104  *
 105  * get the ModestAccountMgr singleton instance
 106  * don't use this function directly, use the modest-runtime
 107  * functions instead.
 108  *
 109  * Returns: the ModestAccountMgr singleton
 110  **/
 111 ModestAccountMgr*         modest_singletons_get_account_mgr   (ModestSingletons *self);
 112
 113
 114 /**
 115  * modest_singletons_get_account_store:
 116  * @self: a valid #ModestSingletons instance
 117  *
 118  * get the #ModestTnyAccountStore singleton instance
 119  * don't use this function directly, use the modest-runtime
 120  * functions instead.
 121  *
 122  * Returns: the #ModestTnyAccountStore singleton
 123  **/
 124 ModestTnyAccountStore*    modest_singletons_get_account_store (ModestSingletons *self);
 125
 126 /**
 127  * modest_singletons_get_cache_mgr:
 128  * @self: a valid #ModestSingletons instance
 129  *
 130  * get the #ModestCacheMgr singleton instance
 131  * don't use this function directly, use the modest-runtime
 132  * functions instead.
 133  *
 134  * Returns: the #ModestCacheMgr singleton
 135  **/
 136 ModestCacheMgr*           modest_singletons_get_cache_mgr     (ModestSingletons *self);
 137
 138
 139
 140 /**
 141  * modest_singletons_get_platform_factory:
 142  * @self: a valid #ModestSingletons instance
 143  *
 144  * get the #TnyPlatformFactory singleton instance
 145  * don't use this function directly, use the modest-runtime
 146  * functions instead.
 147  *
 148  * Returns: the #TnyPlatformFactory singleton
 149  **/
 150 TnyPlatformFactory*       modest_singletons_get_platform_factory  (ModestSingletons *self);
 151
 152
 153 /**
 154  * modest_singletons_get_device:
 155  * @self: a valid #ModestSingletons instance
 156  *
 157  * get the #TnyDevice singleton instance
 158  * don't use this function directly, use the modest-runtime
 159  * functions instead.
 160  *
 161  * Returns: the #TnyDevice singleton
 162  **/
 163 TnyDevice*                 modest_singletons_get_device       (ModestSingletons *self);
 164
 165
 166 /**
 167  * modest_singletons_get_mail_operation_queue:
 168  * @self: a valid ModestSingletons instance
 169  *
 170  * get the ModestMailOperationQueue singleton instance
 171  * don't use this function directly, use the modest-runtime
 172  * functions instead.
 173  *
 174  * Returns: the ModestMailOperationQueue singleton
 175  **/
 176 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
 177
 178
 179
 180 G_END_DECLS
 181
 182 #endif /* __MODEST_SINGLETONS_H__ */
 183