eail/eail_item.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_item.h
  22  *
  23  * @brief Header for EailItem implementation
  24  */
  25
  26 #ifndef EAIL_ITEM_H
  27 #define EAIL_ITEM_H
  28
  29 #include <atk/atk.h>
  30 #include <Elementary.h>
  31 /**
  32  * @brief Returns a value corresponding to the type of EailItem class
  33  */
  34 #define EAIL_TYPE_ITEM            (eail_item_get_type())
  35 /**
  36  * @brief Macro upcasts an instance (obj) of a subclass to the EailItem
  37  * type
  38  *
  39  * @param obj AtkObject instance
  40  */
  41 #define EAIL_ITEM(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  42                                    EAIL_TYPE_ITEM, EailItem))
  43 /**
  44  * @brief Macro upcasts a subclass (klass) to the EailItem class
  45  *
  46  * @param klass subclass object
  47  */
  48 #define EAIL_ITEM_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST((klass), \
  49                                    EAIL_TYPE_ITEM, EailItemClass))
  50 /**
  51  * @brief Tests whether object (obj) is an instance of EailItem class
  52  *
  53  * @param obj AtkObject instance
  54  */
  55 #define EAIL_IS_ITEM(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  56                                    EAIL_TYPE_ITEM))
  57 /**
  58  * @brief Tests whether given klass is a subclass of EailItem
  59  *
  60  * @param klass klass object
  61  */
  62 #define EAIL_IS_ITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), \
  63                                    EAIL_TYPE_ITEM))
  64 /**
  65  * @brief Gets EailItem class structure from an obj (class instance)
  66  *
  67  * @param obj object instance to get EailItem class from
  68  */
  69 #define EAIL_ITEM_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS((obj), \
  70                                    EAIL_TYPE_ITEM, EailItemClass))
  71
  72 #ifdef __cplusplus
  73 extern "C" {
  74 #endif
  75
  76 /** @brief Definition of object structure for Atk EailItem*/
  77 typedef struct _EailItem      EailItem;
  78 /** @brief Definition of class structure for Atk EailItem*/
  79 typedef struct _EailItemClass EailItemClass;
  80
  81 /** @brief Definition of object structure for Atk EailItem*/
  82 struct _EailItem
  83 {
  84    /** @brief Parent AtkObject whose functionality is being extended*/
  85    AtkObject parent;
  86
  87    /** @brief Elementary item that is being represented by EailItem accessible
  88     * object*/
  89    Elm_Object_Item *item;
  90
  91    /** @brief "click" action description*/
  92    char *click_description;
  93
  94    /** @brief "press" action description*/
  95    char *press_description;
  96
  97    /** @brief "release" action description*/
  98    char *release_description;
  99
 100    /** @brief "expand" action description*/
 101    char *expand_description;
 102
 103    /** @brief "shrink" action description*/
 104    char *shrink_description;
 105 };
 106
 107 /** @brief Definition of class structure for Atk EailItem*/
 108 struct _EailItemClass
 109 {
 110    /** @brief Parent class whose functionality is being extended*/
 111    AtkObjectClass parent_class;
 112 };
 113
 114 /** @brief Getter for EailItem GType
 115  *
 116  * @returns GType for EailItem implementation*/
 117 GType eail_item_get_type(void);
 118
 119 /** @brief Gets nested Elm_Object_Item * object*/
 120 Elm_Object_Item *eail_item_get_item(EailItem *item);
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif
 125
 126 #endif