git.maemo.org Git - modest/blob - 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
  37 G_BEGIN_DECLS
  38
  39 /**
  40  * modest_init_init_core:
  41  *
  42  * initialize the modest runtime system (which sets up the
  43  * environment, instantiates singletons and so on)
  44  * modest_runtime_init should only be called once, and
  45  * when done with it, modest_runtime_uninit should be called
  46  *
  47  * TRUE if this succeeded, FALSE otherwise.
  48  */
  49 gboolean modest_init_init_core (void);
  50
  51
  52 /**
  53  * modest_init_init_ui:
  54  * @argc: the #argc argument to the main function
  55  * @argv: the #argv argument to the main function
  56  *
  57  * initialize the modest UI; this replaces the call to
  58  * gtk_init
  59  *
  60  * TRUE if this succeeded, FALSE otherwise.
  61  */
  62 gboolean modest_init_init_ui (gint argc, gchar** argv);
  63
  64 /**
  65  * modest_init_uninit:
  66  *
  67  * uninitialize the modest runtime system; free all the
  68  * resources and so on.
  69  *
  70  * TRUE if this succeeded, FALSE otherwise
  71  */
  72 gboolean modest_init_uninit (void);
  73
  74 /**
  75  * modest_init_local_folders:
  76  *
  77  * create the Local Folders folder under cache, if they
  78  * do not exist yet.
  79  *
  80  * Returns: TRUE if the folder were already there, or
  81  * they were created, FALSE otherwise
  82  */
  83 gboolean modest_init_local_folders  (const gchar* location_filepath);
  84
  85 /**
  86  * modest_init_one_local_folder:
  87  *
  88  * Create the directory structure for a maildir folder,
  89  * so that camel can use it as a maildir folder in a
  90  * local maildir store account.
  91  */
  92 gboolean modest_init_one_local_folder (gchar *maildir_path);
  93
  94
  95 G_END_DECLS
  96
  97 #endif /*__MODEST_INIT_H__*/