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 "modest-plugin-factory.h"
43 #include "widgets/modest-window-mgr.h"
45 #include <tny-stream-cache.h>
47 #include "modest-protocol-registry.h"
48 #include <tny-stream-cache.h>
49 >>>>>>> .merge-right.r5668
53 /* convenience macros */
54 #define MODEST_TYPE_SINGLETONS (modest_singletons_get_type())
55 #define MODEST_SINGLETONS(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_SINGLETONS,ModestSingletons))
56 #define MODEST_SINGLETONS_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_SINGLETONS,GObject))
57 #define MODEST_IS_SINGLETONS(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_SINGLETONS))
58 #define MODEST_IS_SINGLETONS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_SINGLETONS))
59 #define MODEST_SINGLETONS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_SINGLETONS,ModestSingletonsClass))
61 typedef struct _ModestSingletons ModestSingletons;
62 typedef struct _ModestSingletonsClass ModestSingletonsClass;
64 struct _ModestSingletons {
68 struct _ModestSingletonsClass {
69 GObjectClass parent_class;
74 * modest_singletons_get_type:
76 * get the GType for ModestSingletons
80 GType modest_singletons_get_type (void) G_GNUC_CONST;
84 * modest_singletons_new:
86 * create a new ModestSingletons instance;
87 * don't use this function directly, use the modest-runtime
90 * Returns: a new ModestSingletons instance, or NULL in case
93 ModestSingletons* modest_singletons_new (void);
97 * modest_singletons_get_conf:
98 * @self: a valid ModestSingletons instance
100 * get the ModestConf singleton instance
101 * don't use this function directly, use the modest-runtime
104 * Returns: the ModestConf singleton
106 ModestConf* modest_singletons_get_conf (ModestSingletons *self);
110 * modest_singletons_get_account_mgr:
111 * @self: a valid ModestSingletons instance
113 * get the ModestAccountMgr singleton instance
114 * don't use this function directly, use the modest-runtime
117 * Returns: the ModestAccountMgr singleton
119 ModestAccountMgr* modest_singletons_get_account_mgr (ModestSingletons *self);
122 * modest_singletons_get_account_mgr:
123 * @self: a valid #ModestSingletons instance
125 * get the #ModestEamilClipboard singleton instance
126 * don't use this function directly, use the modest-runtime
129 * Returns: the #ModestEmailClipboard singleton
131 ModestEmailClipboard* modest_singletons_get_email_clipboard (ModestSingletons *self);
135 * modest_singletons_get_cache_mgr:
136 * @self: a valid #ModestSingletons instance
138 * get the #ModestCacheMgr singleton instance
139 * don't use this function directly, use the modest-runtime
142 * Returns: the #ModestCacheMgr singleton
144 ModestCacheMgr* modest_singletons_get_cache_mgr (ModestSingletons *self);
149 * modest_singletons_get_platform_factory:
150 * @self: a valid #ModestSingletons instance
152 * get the #TnyPlatformFactory singleton instance
153 * don't use this function directly, use the modest-runtime
156 * Returns: the #TnyPlatformFactory singleton
158 TnyPlatformFactory* modest_singletons_get_platform_factory (ModestSingletons *self);
162 * modest_singletons_get_device:
163 * @self: a valid #ModestSingletons instance
165 * get the #TnyDevice singleton instance
166 * don't use this function directly, use the modest-runtime
169 * Returns: the #TnyDevice singleton
171 TnyDevice* modest_singletons_get_device (ModestSingletons *self);
175 * modest_singletons_get_mail_operation_queue:
176 * @self: a valid ModestSingletons instance
178 * get the ModestMailOperationQueue singleton instance
179 * don't use this function directly, use the modest-runtime
182 * Returns: the ModestMailOperationQueue singleton
184 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
187 * modest_singletons_get_window_mgr:
190 * Gets the #ModestWindowMgr singleton instance. Don't use this
191 * function directly, use the modest-runtime function instead.
193 * Return value: the singleton instance of #ModestWindowMgr
195 ModestWindowMgr* modest_singletons_get_window_mgr (ModestSingletons *self);
199 * modest_singletons_get_images_cache:
200 * @self: a #ModestSingletons
202 * Gets the #TnyStreamCache used to store the external images cache.
204 TnyStreamCache* modest_singletons_get_images_cache (ModestSingletons *self);
208 * modest_singletons_get_protocol_registry:
211 * Gets the #ModestProtocolRegistry singleton instance. Don't use this
212 * function directly, use the modest-runtime function instead.
214 * Return value: the singleton instance of #ModestProtocolRegistry
216 ModestProtocolRegistry* modest_singletons_get_protocol_registry (ModestSingletons *self);
219 * modest_singletons_get_images_cache:
220 * @self: a #ModestSingletons
222 * Gets the #TnyStreamCache used to store the external images cache.
224 TnyStreamCache* modest_singletons_get_images_cache (ModestSingletons *self);
227 * modest_singletons_get_plugin_factory:
228 * @self: a #ModestSingletons
230 * Gets the #ModestMailPluginFactory singleton.
232 ModestPluginFactory* modest_singletons_get_plugin_factory (ModestSingletons *self);
234 >>>>>>> .merge-right.r5668
237 #endif /* __MODEST_SINGLETONS_H__ */