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