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