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