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 #include <tny-platform-factory.h>
  37
  38 G_BEGIN_DECLS
  39
  40 /* convenience macros */
  41 #define MODEST_TYPE_TNY_PLATFORM_FACTORY             (modest_tny_platform_factory_get_type())
  42 #define MODEST_TNY_PLATFORM_FACTORY(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactory))
  43 #define MODEST_TNY_PLATFORM_FACTORY_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY,GObject))
  44 #define MODEST_IS_TNY_PLATFORM_FACTORY(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  45 #define MODEST_IS_TNY_PLATFORM_FACTORY_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_TNY_PLATFORM_FACTORY))
  46 #define MODEST_TNY_PLATFORM_FACTORY_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_TNY_PLATFORM_FACTORY,ModestTnyPlatformFactoryClass))
  47
  48 typedef struct _ModestTnyPlatformFactory      ModestTnyPlatformFactory;
  49 typedef struct _ModestTnyPlatformFactoryClass ModestTnyPlatformFactoryClass;
  50
  51 struct _ModestTnyPlatformFactory {
  52          GObject parent;
  53 };
  54
  55 struct _ModestTnyPlatformFactoryClass {
  56         GObjectClass parent_class;
  57 };
  58
  59
  60 /**
  61  * modest_tny_platform_factory_get_type:
  62  *
  63  * get the GType for #ModestTnyPlatformFactory
  64  *
  65  * Returns: the GType for #ModestTnyPlatformFactory
  66  */
  67 GType        modest_tny_platform_factory_get_type    (void) G_GNUC_CONST;
  68
  69 /**
  70  * modest_tny_platform_factory_get_instance:
  71  *
  72  * Gets a new instance of the platform factory if it is the first call
  73  * to the function, or the current one otherwise. This object is
  74  * supposed to be a singleton
  75  *
  76  * Returns: the instance of a #ModestTnyPlatformFactory
  77  **/
  78 TnyPlatformFactory*    modest_tny_platform_factory_get_instance         (void);
  79
  80 G_END_DECLS
  81
  82 #endif /* __MODEST_TNY_PLATFORM_FACTORY_H__ */