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