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
  42 G_BEGIN_DECLS
  43
  44 /* convenience macros */
  45 #define MODEST_TYPE_TNY_PLATFORM_FACTORY             (modest_tny_platform_factory_get_type())
  46 #define MODEST_TNY_PLATFORM_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactory))
  47 #define MODEST_TNY_PLATFORM_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY,GObject))
  48 #define MODEST_IS_TNY_PLATFORM_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  49 #define MODEST_IS_TNY_PLATFORM_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  50 #define MODEST_TNY_PLATFORM_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactoryClass))
  51
  52 typedef struct _ModestTnyPlatformFactory      ModestTnyPlatformFactory;
  53 typedef struct _ModestTnyPlatformFactoryClass ModestTnyPlatformFactoryClass;
  54
  55 struct _ModestTnyPlatformFactory {
  56          GObject parent;
  57 };
  58
  59 struct _ModestTnyPlatformFactoryClass {
  60         GObjectClass parent_class;
  61 };
  62
  63 /* member functions */
  64 GType        modest_tny_platform_factory_get_type    (void) G_GNUC_CONST;
  65
  66 /**
  67  * modest_tny_platform_factory_get_instance:
  68  *
  69  * Gets a new instance of the platform factory if it is the first call
  70  * to the function, or the current one otherwise. This object is
  71  * supposed to be a singleton
  72  *
  73  * Returns: the instance of a #ModestTnyPlatformFactory
  74  **/
  75 TnyPlatformFactory*    modest_tny_platform_factory_get_instance         (void);
  76
  77 /**
  78  * modest_tny_platform_factory_get_account_mgr_instance:
  79  * @fact: the #TnyPlatformFactory that holds the #ModestAccountMgr instance
  80  *
  81  * Gets a new instance of a #ModestAccountMgr if it is the first call
  82  * to the function, or the current instantiated one otherwise. This
  83  * object is supposed to be a singleton
  84  *
  85  * Returns: an instance of a #ModestAccountMgr
  86  **/
  87 ModestAccountMgr*  modest_tny_platform_factory_get_account_mgr_instance (ModestTnyPlatformFactory *fact);
  88
  89 /**
  90  * modest_tny_platform_factory_get_conf_instance:
  91  * @fact: the #TnyPlatformFactory that holds the #ModestConf instance
  92  *
  93  * Gets a new instance of a #ModestConf if it is the first call to the
  94  * function, or the current instantiated one otherwise. This object is
  95  * supposed to be a singleton
  96  *
  97  * Returns: an instance of a #ModestConf
  98  **/
  99 ModestConf*     modest_tny_platform_factory_get_conf_instance (ModestTnyPlatformFactory *fact);
 100
 101 /**
 102  * modest_tny_platform_factory_get_mail_operation_queue_instance:
 103  * @fact: the #TnyPlatformFactory that holds the #ModestMailOperationQueue instance
 104  *
 105  * Gets a new instance of a #ModestMailOperationQueue if it is the
 106  * first call to the function, or the current instantiated one
 107  * otherwise. This object is supposed to be a singleton
 108  *
 109  * Returns: an instance of a #ModestMailOperationQueue
 110  **/
 111 ModestMailOperationQueue*   modest_tny_platform_factory_get_mail_operation_queue_instance (ModestTnyPlatformFactory *fact);
 112
 113
 114 G_END_DECLS
 115
 116 #endif /* __MODEST_TNY_PLATFORM_FACTORY_H__ */