eail/eail_map.h

   1 /*
   2  * Copyright (c) 2013 Samsung Electronics Co., Ltd.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  */
  19
  20 /**
  21  * @file eail_map.h
  22  *
  23  * @brief Header for EailMap implementation
  24  */
  25 #ifndef EAIL_MAP_H
  26 #define EAIL_MAP_H
  27
  28 #include "eail_image.h"
  29 /**
  30  * @brief Returns a value corresponding to the type of EailMap class
  31  */
  32 #define EAIL_TYPE_MAP             (eail_map_get_type())
  33 /**
  34  * @brief Macro upcasts an instance (obj) of a subclass to the EailMap
  35  * type
  36  *
  37  * @param obj AtkObject instance
  38  */
  39 #define EAIL_MAP(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
  40                                    EAIL_TYPE_MAP, EailMap))
  41 /**
  42  * @brief Macro upcasts a subclass (klass) to the EailMap class
  43  *
  44  * @param klass subclass object
  45  */
  46 #define EAIL_MAP_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), \
  47                                    EAIL_TYPE_MAP, EailMapClass))
  48 /**
  49  * @brief Tests whether object (obj) is an instance of EailMap class
  50  *
  51  * @param obj AtkObject instance
  52  */
  53 #define EAIL_IS_MAP(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), \
  54                                    EAIL_TYPE_MAP))
  55 /**
  56  * @brief Tests whether given klass is a subclass of EailMap
  57  *
  58  * @param klass klass object
  59  */
  60 #define EAIL_IS_MAP_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), \
  61                                    EAIL_TYPE_MAP))
  62 /**
  63  * @brief Gets EailMap class structure from an obj (class instance)
  64  *
  65  * @param obj object instance to get EailMap class from
  66  */
  67 #define EAIL_MAP_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), \
  68                                    EAIL_TYPE_MAP, EailMapClass))
  69
  70 #ifdef __cplusplus
  71 extern "C" {
  72 #endif
  73
  74 /** @brief Definition of object structure for Atk EailMap*/
  75 typedef struct _EailMap       EailMap;
  76 /** @brief Definition of object class for Atk EailMap*/
  77 typedef struct _EailMapClass  EailMapClass;
  78
  79 /** @brief Definition of object structure for Atk EailMap*/
  80 struct _EailMap
  81 {
  82    EailImage parent;/**< @brief Parent widget whose functionality is being extended*/
  83    const char *name;/**< @brief Name string property for map*/
  84 };
  85
  86 /** @brief Definition of object class for Atk EailMap*/
  87 struct _EailMapClass
  88 {
  89    EailImageClass parent_class;/**< @brief class that is being extended*/
  90 };
  91
  92 /**
  93  * @brief Getter for EailMap GType
  94  * @returns GType for EailMap implementation
  95  */
  96 GType eail_map_get_type(void);
  97
  98 #ifdef __cplusplus
  99 }
 100 #endif
 101
 102 #endif