1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
30 #ifndef __MODEST_SINGLETONS_H__
31 #define __MODEST_SINGLETONS_H__
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 "widgets/modest-window-mgr.h"
43 #include <tny-stream-cache.h>
47 /* convenience macros */
48 #define MODEST_TYPE_SINGLETONS (modest_singletons_get_type())
49 #define MODEST_SINGLETONS(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SINGLETONS,ModestSingletons))
50 #define MODEST_SINGLETONS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SINGLETONS,GObject))
51 #define MODEST_IS_SINGLETONS(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SINGLETONS))
52 #define MODEST_IS_SINGLETONS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SINGLETONS))
53 #define MODEST_SINGLETONS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SINGLETONS,ModestSingletonsClass))
55 typedef struct _ModestSingletons ModestSingletons;
56 typedef struct _ModestSingletonsClass ModestSingletonsClass;
58 struct _ModestSingletons {
62 struct _ModestSingletonsClass {
63 GObjectClass parent_class;
68 * modest_singletons_get_type:
70 * get the GType for ModestSingletons
74 GType modest_singletons_get_type (void) G_GNUC_CONST;
78 * modest_singletons_new:
80 * create a new ModestSingletons instance;
81 * don't use this function directly, use the modest-runtime
84 * Returns: a new ModestSingletons instance, or NULL in case
87 ModestSingletons* modest_singletons_new (void);
91 * modest_singletons_get_conf:
92 * @self: a valid ModestSingletons instance
94 * get the ModestConf singleton instance
95 * don't use this function directly, use the modest-runtime
98 * Returns: the ModestConf singleton
100 ModestConf* modest_singletons_get_conf (ModestSingletons *self);
104 * modest_singletons_get_account_mgr:
105 * @self: a valid ModestSingletons instance
107 * get the ModestAccountMgr singleton instance
108 * don't use this function directly, use the modest-runtime
111 * Returns: the ModestAccountMgr singleton
113 ModestAccountMgr* modest_singletons_get_account_mgr (ModestSingletons *self);
116 * modest_singletons_get_account_mgr:
117 * @self: a valid #ModestSingletons instance
119 * get the #ModestEamilClipboard singleton instance
120 * don't use this function directly, use the modest-runtime
123 * Returns: the #ModestEmailClipboard singleton
125 ModestEmailClipboard* modest_singletons_get_email_clipboard (ModestSingletons *self);
129 * modest_singletons_get_cache_mgr:
130 * @self: a valid #ModestSingletons instance
132 * get the #ModestCacheMgr singleton instance
133 * don't use this function directly, use the modest-runtime
136 * Returns: the #ModestCacheMgr singleton
138 ModestCacheMgr* modest_singletons_get_cache_mgr (ModestSingletons *self);
143 * modest_singletons_get_platform_factory:
144 * @self: a valid #ModestSingletons instance
146 * get the #TnyPlatformFactory singleton instance
147 * don't use this function directly, use the modest-runtime
150 * Returns: the #TnyPlatformFactory singleton
152 TnyPlatformFactory* modest_singletons_get_platform_factory (ModestSingletons *self);
156 * modest_singletons_get_device:
157 * @self: a valid #ModestSingletons instance
159 * get the #TnyDevice singleton instance
160 * don't use this function directly, use the modest-runtime
163 * Returns: the #TnyDevice singleton
165 TnyDevice* modest_singletons_get_device (ModestSingletons *self);
169 * modest_singletons_get_mail_operation_queue:
170 * @self: a valid ModestSingletons instance
172 * get the ModestMailOperationQueue singleton instance
173 * don't use this function directly, use the modest-runtime
176 * Returns: the ModestMailOperationQueue singleton
178 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
181 * modest_singletons_get_window_mgr:
184 * Gets the #ModestWindowMgr singleton instance. Don't use this
185 * function directly, use the modest-runtime function instead.
187 * Return value: the singleton instance of #ModestWindowMgr
189 ModestWindowMgr* modest_singletons_get_window_mgr (ModestSingletons *self);
192 * modest_singletons_get_images_cache:
193 * @self: a #ModestSingletons
195 * Gets the #TnyStreamCache used to store the external images cache.
197 TnyStreamCache* modest_singletons_get_images_cache (ModestSingletons *self);
201 #endif /* __MODEST_SINGLETONS_H__ */