wearable/src/lib/elm_widget_plug.h

   1 #ifndef ELM_WIDGET_PLUG_H
   2 #define ELM_WIDGET_PLUG_H
   3
   4 /**
   5  * @addtogroup Widget
   6  * @{
   7  *
   8  * @section elm-plug-class The Elementary Plug Class
   9  *
  10  * Elementary, besides having the @ref Plug widget, exposes its
  11  * foundation -- the Elementary Plug Class -- in order to create other
  12  * widgets which are a plug with some more logic on top.
  13  */
  14
  15 /**
  16  * @def ELM_PLUG_CLASS
  17  *
  18  * Use this macro to cast whichever subclass of
  19  * #Elm_Plug_Smart_Class into it, so to access its fields.
  20  *
  21  * @ingroup Widget
  22  */
  23 #define ELM_PLUG_CLASS(x) ((Elm_Plug_Smart_Class *)x)
  24
  25 /**
  26  * @def ELM_PLUG_DATA
  27  *
  28  * Use this macro to cast whichever subdata of
  29  * #Elm_Plug_Smart_Data into it, so to access its fields.
  30  *
  31  * @ingroup Widget
  32  */
  33 #define ELM_PLUG_DATA(x)  ((Elm_Plug_Smart_Data *)x)
  34
  35 /**
  36  * @def ELM_PLUG_SMART_CLASS_VERSION
  37  *
  38  * Current version for Elementary plug @b base smart class, a value
  39  * which goes to _Elm_Plug_Smart_Class::version.
  40  *
  41  * @ingroup Widget
  42  */
  43 #define ELM_PLUG_SMART_CLASS_VERSION 1
  44
  45 /**
  46  * @def ELM_PLUG_SMART_CLASS_INIT
  47  *
  48  * Initializer for a whole #Elm_Plug_Smart_Class structure, with
  49  * @c NULL values on its specific fields.
  50  *
  51  * @param smart_class_init initializer to use for the "base" field
  52  * (#Evas_Smart_Class).
  53  *
  54  * @see EVAS_SMART_CLASS_INIT_NULL
  55  * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
  56  * @see ELM_PLUG_SMART_CLASS_INIT_NULL
  57  * @see ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION
  58  *
  59  * @ingroup Widget
  60  */
  61 #define ELM_PLUG_SMART_CLASS_INIT(smart_class_init) \
  62   {smart_class_init, ELM_PLUG_SMART_CLASS_VERSION}
  63
  64 /**
  65  * @def ELM_PLUG_SMART_CLASS_INIT_NULL
  66  *
  67  * Initializer to zero out a whole #Elm_Plug_Smart_Class structure.
  68  *
  69  * @see ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION
  70  * @see ELM_PLUG_SMART_CLASS_INIT
  71  *
  72  * @ingroup Widget
  73  */
  74 #define ELM_PLUG_SMART_CLASS_INIT_NULL \
  75   ELM_PLUG_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  76
  77 /**
  78  * @def ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION
  79  *
  80  * Initializer to zero out a whole #Elm_Plug_Smart_Class structure and
  81  * set its name and version.
  82  *
  83  * This is similar to #ELM_PLUG_SMART_CLASS_INIT_NULL, but it will
  84  * also set the version field of #Elm_Plug_Smart_Class (base field)
  85  * to the latest #ELM_PLUG_SMART_CLASS_VERSION and name it to the
  86  * specific value.
  87  *
  88  * It will keep a reference to the name field as a <c>"const char *"</c>,
  89  * i.e., the name must be available while the structure is
  90  * used (hint: static or global variable!) and must not be modified.
  91  *
  92  * @see ELM_PLUG_SMART_CLASS_INIT_NULL
  93  * @see ELM_PLUG_SMART_CLASS_INIT
  94  *
  95  * @ingroup Widget
  96  */
  97 #define ELM_PLUG_SMART_CLASS_INIT_NAME_VERSION(name) \
  98   ELM_PLUG_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
  99
 100 /**
 101  * Elementary plug base smart class. This inherits directly from
 102  * #Elm_Widget_Smart_Class and is meant to build widgets extending the
 103  * behavior of a plug.
 104  *
 105  * All of the functions listed on @ref Plug namespace will work for
 106  * objects deriving from #Elm_Plug_Smart_Class.
 107  */
 108 typedef struct _Elm_Plug_Smart_Class
 109 {
 110    Elm_Widget_Smart_Class base;
 111
 112    int                    version; /**< Version of this smart class definition */
 113 } Elm_Plug_Smart_Class;
 114
 115 /**
 116  * Base widget smart data extended with plug instance data.
 117  */
 118 typedef struct _Elm_Plug_Smart_Data Elm_Plug_Smart_Data;
 119 struct _Elm_Plug_Smart_Data
 120 {
 121    Elm_Widget_Smart_Data base;    /* base widget smart data as
 122                                    * first member obligatory, as
 123                                    * we're inheriting from it */
 124 };
 125 /**
 126  * @}
 127  */
 128
 129 EAPI extern const char ELM_PLUG_SMART_NAME[];
 130 EAPI const Elm_Plug_Smart_Class *elm_plug_smart_class_get(void);
 131
 132 #define ELM_PLUG_DATA_GET(o, sd) \
 133   Elm_Plug_Smart_Data * sd = evas_object_smart_data_get(o)
 134
 135 #define ELM_PLUG_DATA_GET_OR_RETURN(o, ptr)          \
 136   ELM_PLUG_DATA_GET(o, ptr);                         \
 137   if (!ptr)                                          \
 138     {                                                \
 139        CRITICAL("No widget data for object %p (%s)", \
 140                 o, evas_object_type_get(o));         \
 141        return;                                       \
 142     }
 143
 144 #define ELM_PLUG_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 145   ELM_PLUG_DATA_GET(o, ptr);                         \
 146   if (!ptr)                                          \
 147     {                                                \
 148        CRITICAL("No widget data for object %p (%s)", \
 149                 o, evas_object_type_get(o));         \
 150        return val;                                   \
 151     }
 152
 153 #define ELM_PLUG_CHECK(obj)                                                 \
 154   if (!obj || !elm_widget_type_check((obj), ELM_PLUG_SMART_NAME, __func__)) \
 155     return
 156
 157 #endif