git.maemo.org Git - modest/blob - src/modest-tny-platform-factory.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 /* modest-tny-platform-factory.h */
  31
  32 #ifndef __MODEST_TNY_PLATFORM_FACTORY_H__
  33 #define __MODEST_TNY_PLATFORM_FACTORY_H__
  34
  35 #include <glib-object.h>
  36
  37 #include <tny-platform-factory.h>
  38 #include <modest-account-mgr.h>
  39 #include <modest-conf.h>
  40 #include <modest-mail-operation-queue.h>
  41 #include <modest-cache-mgr.h>
  42
  43 G_BEGIN_DECLS
  44
  45 /* convenience macros */
  46 #define MODEST_TYPE_TNY_PLATFORM_FACTORY             (modest_tny_platform_factory_get_type())
  47 #define MODEST_TNY_PLATFORM_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactory))
  48 #define MODEST_TNY_PLATFORM_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY,GObject))
  49 #define MODEST_IS_TNY_PLATFORM_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  50 #define MODEST_IS_TNY_PLATFORM_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  51 #define MODEST_TNY_PLATFORM_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactoryClass))
  52
  53 typedef struct _ModestTnyPlatformFactory      ModestTnyPlatformFactory;
  54 typedef struct _ModestTnyPlatformFactoryClass ModestTnyPlatformFactoryClass;
  55
  56 struct _ModestTnyPlatformFactory {
  57          GObject parent;
  58 };
  59
  60 struct _ModestTnyPlatformFactoryClass {
  61         GObjectClass parent_class;
  62 };
  63
  64 /* member functions */
  65 GType        modest_tny_platform_factory_get_type    (void) G_GNUC_CONST;
  66
  67 /**
  68  * modest_tny_platform_factory_get_instance:
  69  *
  70  * Gets a new instance of the platform factory if it is the first call
  71  * to the function, or the current one otherwise. This object is
  72  * supposed to be a singleton
  73  *
  74  * Returns: the instance of a #ModestTnyPlatformFactory
  75  **/
  76 TnyPlatformFactory*    modest_tny_platform_factory_get_instance         (void);
  77
  78 /**
  79  * modest_tny_platform_factory_get_account_mgr_instance:
  80  * @fact: the #TnyPlatformFactory that holds the #ModestAccountMgr instance
  81  *
  82  * Gets a new instance of a #ModestAccountMgr if it is the first call
  83  * to the function, or the current instantiated one otherwise. This
  84  * object is supposed to be a singleton
  85  *
  86  * Returns: an instance of a #ModestAccountMgr
  87  **/
  88 ModestAccountMgr*  modest_tny_platform_factory_get_account_mgr_instance (ModestTnyPlatformFactory *fact);
  89
  90 /**
  91  * modest_tny_platform_factory_get_conf_instance:
  92  * @fact: the #TnyPlatformFactory that holds the #ModestConf instance
  93  *
  94  * Gets a new instance of a #ModestConf if it is the first call to the
  95  * function, or the current instantiated one otherwise. This object is
  96  * supposed to be a singleton
  97  *
  98  * Returns: an instance of a #ModestConf
  99  **/
 100 ModestConf*     modest_tny_platform_factory_get_conf_instance (ModestTnyPlatformFactory *fact);
 101
 102 /**
 103  * modest_tny_platform_factory_get_mail_operation_queue_instance:
 104  * @fact: the #TnyPlatformFactory that holds the #ModestMailOperationQueue instance
 105  *
 106  * Gets a new instance of a #ModestMailOperationQueue if it is the
 107  * first call to the function, or the current instantiated one
 108  * otherwise. This object is supposed to be a singleton
 109  *
 110  * Returns: an instance of a #ModestMailOperationQueue
 111  **/
 112 ModestMailOperationQueue*   modest_tny_platform_factory_get_mail_operation_queue_instance (ModestTnyPlatformFactory *fact);
 113
 114
 115 /**
 116  * modest_tny_platform_factory_get_cache_mgr_instance:
 117  * @fact: the #TnyPlatformFactory that holds the #ModestCacheMgr instance
 118  *
 119  * Gets a new instance of a #ModestCacheMgr if it is the
 120  * first call to the function, or the current instantiated one
 121  * otherwise. This object is supposed to be a singleton
 122  *
 123  * Returns: an instance of a #ModestCacheMgr.
 124  **/
 125 ModestCacheMgr*   modest_tny_platform_factory_get_cache_mgr_instance (ModestTnyPlatformFactory *fact);
 126
 127
 128
 129
 130 G_END_DECLS
 131
 132 #endif /* __MODEST_TNY_PLATFORM_FACTORY_H__ */