eail/eail/eail_bubble.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_bubble.h
  22  *
  23  * @brief Header for EailBubble implementation
  24  */
  25
  26 #ifndef EAIL_BUBBLE_H
  27 #define EAIL_BUBBLE_H
  28
  29 #include "eail_text.h"
  30 /**
  31  * @brief Returns a value corresponding to the type of EailBubble class
  32  */
  33 #define EAIL_TYPE_BUBBLE             (eail_bubble_get_type())
  34 /**
  35  * @brief Macro upcasts an instance (obj) of a subclass to the EailBubble
  36  * type
  37  *
  38  * @param obj an AtkObject
  39  */
  40 #define EAIL_BUBBLE(obj)             (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  41                                       EAIL_TYPE_BUBBLE, EailBubble))
  42 /**
  43  * @brief Macro upcasts a subclass (klass) to the EailBubble class
  44  *
  45  * @param klass subclass object
  46  */
  47 #define EAIL_BUBBLE_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST((klass), \
  48                                       EAIL_TYPE_BUBBLE, EailBubbleClass))
  49 /**
  50  * @brief Tests whether object (obj) is an instance of EailBubble class
  51  *
  52  * @param obj an AtkObject
  53  */
  54 #define EAIL_IS_BUBBLE(obj)          (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  55                                       EAIL_TYPE_BUBBLE))
  56 /**
  57  * @brief Tests whether given klass is a subclass of EailBubble
  58  *
  59  * @param klass klass object
  60  */
  61 #define EAIL_IS_BUBBLE_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE((klass), \
  62                                       EAIL_TYPE_BUBBLE))
  63 /**
  64  * @brief Gets EailBubble class structure from an obj (class instance)
  65  *
  66  * @param obj object instance to get EailBubble class from
  67  */
  68 #define EAIL_BUBBLE_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), \
  69                                       EAIL_TYPE_BUBBLE, EailBubbleClass))
  70
  71 #ifdef __cplusplus
  72 extern "C" {
  73 #endif
  74
  75 /** @brief Definition of object structure for Atk EailBubble*/
  76 typedef struct _EailBubble      EailBubble;
  77 /** @brief Definition of class structure for Atk EailBubble*/
  78 typedef struct _EailBubbleClass EailBubbleClass;
  79
  80 /** @brief Definition of object structure for Atk EailBubble*/
  81 struct _EailBubble
  82 {
  83    EailText parent; /*!< parent class object*/
  84    char *click_description; /*!< click action description*/
  85 };
  86
  87 /** @brief Definition of class structure for Atk EailBubble*/
  88 struct _EailBubbleClass
  89 {
  90    /** @brief parent class whose functionality is being extended */
  91    EailTextClass parent_class;
  92 };
  93
  94 /** @brief Getter for EailBubble GType
  95  *
  96  * @returns GType for EailBubble implementation
  97  * */
  98 GType eail_bubble_get_type(void);
  99
 100 #ifdef __cplusplus
 101 }
 102 #endif
 103
 104 #endif