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-widget-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  *
  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  *
 103  * get the ModestAccountMgr singleton instance
 104  * don't use this function directly, use the modest-runtime
 105  * functions instead.
 106  *
 107  * Returns: the ModestAccountMgr singleton
 108  **/
 109 ModestAccountMgr*         modest_singletons_get_account_mgr   (ModestSingletons *self);
 110
 111
 112 /**
 113  * modest_singletons_get_account_store:
 114  *
 115  * get the ModestTnyAccountStore singleton instance
 116  * don't use this function directly, use the modest-runtime
 117  * functions instead.
 118  *
 119  * Returns: the ModestTnyAccountStore singleton
 120  **/
 121 ModestTnyAccountStore*    modest_singletons_get_account_store (ModestSingletons *self);
 122
 123
 124 /**
 125  * modest_singletons_get_cache_mgr:
 126  *
 127  * get the ModestCacheMgr singleton instance
 128  * don't use this function directly, use the modest-runtime
 129  * functions instead.
 130  *
 131  * Returns: the ModestCacheMgr singleton
 132  **/
 133 ModestCacheMgr*           modest_singletons_get_cache_mgr     (ModestSingletons *self);
 134
 135
 136 /**
 137  * modest_singletons_get_mail_operation_queue:
 138  *
 139  * get the ModestMailOperationQueue singleton instance
 140  * don't use this function directly, use the modest-runtime
 141  * functions instead.
 142  *
 143  * Returns: the ModestMailOperationQueue singleton
 144  **/
 145 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
 146
 147
 148
 149
 150 /**
 151  * modest_singletons_get_widget_factory:
 152  *
 153  * get the ModestWidgetFactory singleton instance
 154  * don't use this function directly, use the modest-runtime
 155  * functions instead.
 156  *
 157  * Returns: the ModestWidgetFactory singleton
 158  **/
 159 ModestWidgetFactory* modest_singletons_get_widget_factory (ModestSingletons *self);
 160
 161
 162 G_END_DECLS
 163
 164 #endif /* __MODEST_SINGLETONS_H__ */
 165