Modified webpage: now tinymail repository is in gitorious.
[modest] / src / modest-init.h
1 /* Copyright (c) 2006, 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_INIT_H__
31 #define __MODEST_INIT_H__
32
33 #include <glib.h>
34 #include <glib-object.h>
35 #include <modest-runtime.h>
36 #include <widgets/modest-header-view.h>
37
38 G_BEGIN_DECLS
39
40 /**
41  * modest_init_init_core:
42  * @argc:
43  * @argv:
44  *
45  * initialize the modest runtime system (which sets up the
46  * environment, instantiates singletons and so on)
47  * modest_runtime_init should only be called once, and
48  * when done with it, modest_runtime_uninit should be called
49  *  
50  * TRUE if this succeeded, FALSE otherwise.
51  */
52 gboolean modest_init (int argc, char *argv[]);
53
54
55 /**
56  * modest_init_uninit:
57  *
58  * uninitialize the modest runtime system; free all the
59  * resources and so on.
60  *
61  * TRUE if this succeeded, FALSE otherwise
62  */
63 gboolean modest_init_uninit (void);
64
65 /**
66  * modest_init_local_folders:
67  * 
68  * create the Local Folders folder under cache, if they
69  * do not exist yet.
70  * 
71  * Returns: TRUE if the folder were already there, or
72  * they were created, FALSE otherwise
73  */
74 gboolean modest_init_local_folders  (const gchar* location_filepath);
75
76 /**
77  * modest_init_one_local_folder:
78  *
79  * Create the directory structure for a maildir folder,
80  * so that camel can use it as a maildir folder in a 
81  * local maildir store account.
82  */
83 gboolean modest_init_one_local_folder (gchar *maildir_path);
84
85 /**
86  * modest_init_get_default_header_view_column_widths:
87  *
88  * Get a GList* containing the default column ids, 
89  * for when suitable values cannot be retrieved from gconf.
90  * The result should be freed with g_slist_free().
91  * Use (ModestHeaderViewColumn(GPOINTER_TO_INT(item->data)) to get the IDs.
92  */
93 GList * modest_init_get_default_header_view_column_ids (TnyFolderType folder_type, ModestHeaderViewStyle style);
94
95 G_END_DECLS
96
97 #endif /*__MODEST_INIT_H__*/