eail/eail_conformant.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_conformant.h
  22  *
  23  * @brief Header for EailConformant implementation
  24  */
  25
  26 #ifndef EAIL_CONFORMANT_H
  27 #define EAIL_CONFORMANT_H
  28
  29 #include "eail_layout.h"
  30
  31 /**
  32  * @brief Returns a value corresponding to the type of EailConformant class
  33  */
  34 #define EAIL_TYPE_CONFORMANT              (eail_conformant_get_type())
  35
  36 /**
  37  * @brief Macro upcasts an instance (obj) of a subclass to the EailConformant
  38  * type
  39  *
  40  * @param obj AtkObject instance
  41  */
  42 #define EAIL_CONFORMANT(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  43                                            EAIL_TYPE_CONFORMANT, EailConformant))
  44
  45 /**
  46  * @brief Macro upcasts a subclass (klass) to the EailConformant class
  47  *
  48  * @param klass subclass object
  49  */
  50 #define EAIL_CONFORMANT_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass), \
  51                                            EAIL_TYPE_CONFORMANT, EailConformantClass))
  52
  53 /**
  54  * @brief Tests whether object (obj) is an instance of EailConformant class
  55  *
  56  * @param obj AtkObject instance
  57  */
  58 #define EAIL_IS_CONFORMANT(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  59                                            EAIL_TYPE_CONFORMANT))
  60
  61 /**
  62  * @brief Tests whether given klass is a subclass of EailConformant
  63  *
  64  * @param klass klass object
  65  */
  66 #define EAIL_IS_CONFORMANT_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), \
  67                                            EAIL_TYPE_CONFORMANT))
  68
  69 /**
  70  * @brief Gets EailConformant class structure from an obj (class instance)
  71  *
  72  * @param obj object instance to get EailConformant class from
  73  */
  74 #define EAIL_CONFORMANT_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj), \
  75                                            EAIL_TYPE_CONFORMANT, EailConformantClass))
  76
  77 #ifdef __cplusplus
  78 extern "C" {
  79 #endif
  80
  81 /** @brief Definition of object structure for Atk EailConformant*/
  82 typedef struct _EailConformant      EailConformant;
  83
  84 /** @brief Definition of class structure for Atk EailConformant*/
  85 typedef struct _EailConformantClass EailConformantClass;
  86
  87 /** @brief Definition of object structure for Atk EailConformant*/
  88 struct _EailConformant
  89 {
  90    /** @brief Parent widget whose functionality is being extended */
  91    EailLayout parent;
  92 };
  93
  94 /** @brief Definition of class structure for Atk EailConformant*/
  95 struct _EailConformantClass
  96 {
  97    /** @brief parent class whose functionality is being extended */
  98    EailLayoutClass parent_class;
  99 };
 100
 101 /** @brief Getter for EailConformant GType
 102  *
 103  * @returns GType for EailConfomant implementation*/
 104 GType eail_conformant_get_type(void);
 105
 106 #ifdef __cplusplus
 107 }
 108 #endif
 109
 110 #endif