2007-07-31 Philip Van Hoof <pvanhoof@gnome.org>
[modest] / src / modest-tny-local-folders-account.h
1 /* Copyright (c) 2007, 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_TNY_LOCAL_FOLDERS_ACCOUNT
31 #define _MODEST_TNY_LOCAL_FOLDERS_ACCOUNT
32
33 #include <tny-camel-store-account.h>
34
35 G_BEGIN_DECLS
36
37 #define MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT modest_tny_local_folders_account_get_type()
38
39 #define MODEST_TNY_LOCAL_FOLDERS_ACCOUNT(obj) \
40   (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
41   MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT, ModestTnyLocalFoldersAccount))
42
43 #define MODEST_TNY_LOCAL_FOLDERS_ACCOUNT_CLASS(klass) \
44   (G_TYPE_CHECK_CLASS_CAST ((klass), \
45   MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT, ModestTnyLocalFoldersAccountClass))
46
47 #define MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT(obj) \
48   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
49   MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT))
50
51 #define MODEST_IS_TNY_LOCAL_FOLDERS_ACCOUNT_CLASS(klass) \
52   (G_TYPE_CHECK_CLASS_TYPE ((klass), \
53   MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT))
54
55 #define MODEST_TNY_LOCAL_FOLDERS_ACCOUNT_GET_CLASS(obj) \
56   (G_TYPE_INSTANCE_GET_CLASS ((obj), \
57   MODEST_TYPE_TNY_LOCAL_FOLDERS_ACCOUNT, ModestTnyLocalFoldersAccountClass))
58
59 /** ModestTnyLocalFoldersAccount contains references to folders that exist 
60  * in other folder stores or accounts. It does not instantiate any folders 
61  * of its own.
62  */
63 typedef struct {
64   TnyCamelStoreAccount parent;
65 } ModestTnyLocalFoldersAccount;
66
67 typedef struct {
68   TnyCamelStoreAccountClass parent_class;
69 } ModestTnyLocalFoldersAccountClass;
70
71 GType modest_tny_local_folders_account_get_type (void);
72
73 ModestTnyLocalFoldersAccount* modest_tny_local_folders_account_new (void);
74
75 gboolean   modest_tny_local_folders_account_folder_name_in_use   (ModestTnyLocalFoldersAccount *self,
76                                                                   const gchar *name);
77
78 void       modest_tny_local_folders_account_add_folder_to_outbox (ModestTnyLocalFoldersAccount *self, 
79                                                                   TnyFolder *per_account_outbox);
80
81 G_END_DECLS
82
83 #endif /* _MODEST_TNY_LOCAL_FOLDERS_ACCOUNT */