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