* check for a valid foldername
[modest] / 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-email-clipboard.h>
38 #include <modest-account-mgr.h>
39 #include <modest-tny-account-store.h>
40 #include <modest-mail-operation-queue.h>
41 #include <modest-cache-mgr.h>
42 #include <modest-tny-platform-factory.h>
43 #include "widgets/modest-window-mgr.h"
44
45 G_BEGIN_DECLS
46
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))
54
55 typedef struct _ModestSingletons      ModestSingletons;
56 typedef struct _ModestSingletonsClass ModestSingletonsClass;
57
58 struct _ModestSingletons {
59          GObject parent;
60 };
61
62 struct _ModestSingletonsClass {
63         GObjectClass parent_class;
64 };
65
66
67 /**
68  * modest_singletons_get_type:
69  * 
70  * get the GType for ModestSingletons
71  *  
72  * Returns: the GType
73  */
74 GType        modest_singletons_get_type    (void) G_GNUC_CONST;
75
76
77 /**
78  * modest_singletons_new:
79  * 
80  * create a new ModestSingletons instance;
81  * don't use this function directly, use the modest-runtime
82  * functions instead.
83  * 
84  * Returns: a new ModestSingletons instance, or NULL in case
85  * of any error
86  */
87 ModestSingletons*    modest_singletons_new         (void);
88
89
90 /**
91  * modest_singletons_get_conf:
92  * @self: a valid ModestSingletons instance
93  * 
94  * get the ModestConf singleton instance
95  * don't use this function directly, use the modest-runtime
96  * functions instead.
97  *
98  * Returns: the ModestConf singleton
99  **/
100 ModestConf*               modest_singletons_get_conf          (ModestSingletons *self);
101
102
103 /**
104  * modest_singletons_get_account_mgr:
105  * @self: a valid ModestSingletons instance
106  * 
107  * get the ModestAccountMgr singleton instance
108  * don't use this function directly, use the modest-runtime
109  * functions instead.
110  * 
111  * Returns: the ModestAccountMgr singleton
112  **/
113 ModestAccountMgr*         modest_singletons_get_account_mgr   (ModestSingletons *self);
114
115 /**
116  * modest_singletons_get_account_mgr:
117  * @self: a valid #ModestSingletons instance
118  * 
119  * get the #ModestEamilClipboard singleton instance
120  * don't use this function directly, use the modest-runtime
121  * functions instead.
122  * 
123  * Returns: the #ModestEmailClipboard singleton
124  **/
125 ModestEmailClipboard*      modest_singletons_get_email_clipboard (ModestSingletons *self);
126
127 /**
128  * modest_singletons_get_account_store:
129  * @self: a valid #ModestSingletons instance
130  * 
131  * get the #ModestTnyAccountStore singleton instance
132  * don't use this function directly, use the modest-runtime
133  * functions instead.
134  *
135  * Returns: the #ModestTnyAccountStore singleton
136  **/
137 ModestTnyAccountStore*    modest_singletons_get_account_store (ModestSingletons *self);
138
139 /**
140  * modest_singletons_get_cache_mgr:
141  * @self: a valid #ModestSingletons instance
142  * 
143  * get the #ModestCacheMgr singleton instance
144  * don't use this function directly, use the modest-runtime
145  * functions instead.
146  *
147  * Returns: the #ModestCacheMgr singleton
148  **/
149 ModestCacheMgr*           modest_singletons_get_cache_mgr     (ModestSingletons *self);
150
151
152
153 /**
154  * modest_singletons_get_platform_factory:
155  * @self: a valid #ModestSingletons instance
156  * 
157  * get the #TnyPlatformFactory singleton instance
158  * don't use this function directly, use the modest-runtime
159  * functions instead.
160  *
161  * Returns: the #TnyPlatformFactory singleton
162  **/
163 TnyPlatformFactory*       modest_singletons_get_platform_factory  (ModestSingletons *self);
164
165
166 /**
167  * modest_singletons_get_device:
168  * @self: a valid #ModestSingletons instance
169  * 
170  * get the #TnyDevice singleton instance
171  * don't use this function directly, use the modest-runtime
172  * functions instead.
173  *
174  * Returns: the #TnyDevice singleton
175  **/
176 TnyDevice*                 modest_singletons_get_device       (ModestSingletons *self);
177
178
179 /**
180  * modest_singletons_get_mail_operation_queue:
181  * @self: a valid ModestSingletons instance
182  * 
183  * get the ModestMailOperationQueue singleton instance
184  * don't use this function directly, use the modest-runtime
185  * functions instead.
186  *
187  * Returns: the ModestMailOperationQueue singleton
188  **/
189 ModestMailOperationQueue* modest_singletons_get_mail_operation_queue (ModestSingletons *self);
190
191 /**
192  * modest_singletons_get_window_mgr:
193  * @self: 
194  * 
195  * Gets the #ModestWindowMgr singleton instance. Don't use this
196  * function directly, use the modest-runtime function instead.
197  *
198  * Return value: the singleton instance of #ModestWindowMgr
199  **/
200 ModestWindowMgr*          modest_singletons_get_window_mgr           (ModestSingletons *self);
201
202 G_END_DECLS
203
204 #endif /* __MODEST_SINGLETONS_H__ */
205