src/lib/elm_widget_conform.h

   1 #ifndef ELM_WIDGET_CONFORMANT_H
   2 #define ELM_WIDGET_CONFORMANT_H
   3
   4 #include "elm_widget_layout.h"
   5
   6 /**
   7  * @addtogroup Widget
   8  * @{
   9  *
  10  * @section elm-conformant-class The Elementary Conformant Class
  11  *
  12  * Elementary, besides having the @ref Conformant widget, exposes its
  13  * foundation -- the Elementary Conformant Class -- in order to create other
  14  * widgets which are a conformant with some more logic on top.
  15  */
  16
  17 /**
  18  * @def ELM_CONFORMANT_CLASS
  19  *
  20  * Use this macro to cast whichever subclass of
  21  * #Elm_Conformant_Smart_Class into it, so to access its fields.
  22  *
  23  * @ingroup Widget
  24  */
  25 #define ELM_CONFORMANT_CLASS(x) ((Elm_Conformant_Smart_Class *)x)
  26
  27 /**
  28  * @def ELM_CONFORMANT_DATA
  29  *
  30  * Use this macro to cast whichever subdata of
  31  * #Elm_Conformant_Smart_Data into it, so to access its fields.
  32  *
  33  * @ingroup Widget
  34  */
  35 #define ELM_CONFORMANT_DATA(x)  ((Elm_Conformant_Smart_Data *)x)
  36
  37 /**
  38  * @def ELM_CONFORMANT_SMART_CLASS_VERSION
  39  *
  40  * Current version for Elementary conformant @b base smart class, a value
  41  * which goes to _Elm_Conformant_Smart_Class::version.
  42  *
  43  * @ingroup Widget
  44  */
  45 #define ELM_CONFORMANT_SMART_CLASS_VERSION 1
  46
  47 /**
  48  * @def ELM_CONFORMANT_SMART_CLASS_INIT
  49  *
  50  * Initializer for a whole #Elm_Conformant_Smart_Class structure, with
  51  * @c NULL values on its specific fields.
  52  *
  53  * @param smart_class_init initializer to use for the "base" field
  54  * (#Evas_Smart_Class).
  55  *
  56  * @see EVAS_SMART_CLASS_INIT_NULL
  57  * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
  58  * @see ELM_CONFORMANT_SMART_CLASS_INIT_NULL
  59  * @see ELM_CONFORMANT_SMART_CLASS_INIT_NAME_VERSION
  60  *
  61  * @ingroup Widget
  62  */
  63 #define ELM_CONFORMANT_SMART_CLASS_INIT(smart_class_init) \
  64   {smart_class_init, ELM_CONFORMANT_SMART_CLASS_VERSION}
  65
  66 /**
  67  * @def ELM_CONFORMANT_SMART_CLASS_INIT_NULL
  68  *
  69  * Initializer to zero out a whole #Elm_Conformant_Smart_Class structure.
  70  *
  71  * @see ELM_CONFORMANT_SMART_CLASS_INIT_NAME_VERSION
  72  * @see ELM_CONFORMANT_SMART_CLASS_INIT
  73  *
  74  * @ingroup Widget
  75  */
  76 #define ELM_CONFORMANT_SMART_CLASS_INIT_NULL \
  77   ELM_CONFORMANT_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  78
  79 /**
  80  * @def ELM_CONFORMANT_SMART_CLASS_INIT_NAME_VERSION
  81  *
  82  * Initializer to zero out a whole #Elm_Conformant_Smart_Class structure and
  83  * set its name and version.
  84  *
  85  * This is similar to #ELM_CONFORMANT_SMART_CLASS_INIT_NULL, but it will
  86  * also set the version field of #Elm_Conformant_Smart_Class (base field)
  87  * to the latest #ELM_CONFORMANT_SMART_CLASS_VERSION and name it to the
  88  * specific value.
  89  *
  90  * It will keep a reference to the name field as a <c>"const char *"</c>,
  91  * i.e., the name must be available while the structure is
  92  * used (hint: static or global variable!) and must not be modified.
  93  *
  94  * @see ELM_CONFORMANT_SMART_CLASS_INIT_NULL
  95  * @see ELM_CONFORMANT_SMART_CLASS_INIT
  96  *
  97  * @ingroup Widget
  98  */
  99 #define ELM_CONFORMANT_SMART_CLASS_INIT_NAME_VERSION(name) \
 100   ELM_CONFORMANT_SMART_CLASS_INIT                          \
 101     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
 102
 103 /**
 104  * Elementary conformant base smart class. This inherits directly from
 105  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
 106  * behavior of a conformant.
 107  *
 108  * All of the functions listed on @ref Conformant namespace will work for
 109  * objects deriving from #Elm_Conformant_Smart_Class.
 110  */
 111 typedef struct _Elm_Conformant_Smart_Class
 112 {
 113    Elm_Layout_Smart_Class base;
 114
 115    int                    version;    /**< Version of this smart class definition */
 116 } Elm_Conformant_Smart_Class;
 117
 118 /**
 119  * Base layout smart data extended with conformant instance data.
 120  */
 121 typedef struct _Elm_Conformant_Smart_Data Elm_Conformant_Smart_Data;
 122 struct _Elm_Conformant_Smart_Data
 123 {
 124    Elm_Layout_Smart_Data          base;
 125    Evas_Object                   *portrait_indicator;
 126    Evas_Object                   *landscape_indicator;
 127    Evas_Object                   *softkey;
 128    Evas_Object                   *virtualkeypad;
 129    Evas_Object                   *clipboard;
 130    Evas_Object                   *scroller;
 131 #ifdef HAVE_ELEMENTARY_X
 132    Ecore_Event_Handler           *prop_hdl;
 133    Ecore_X_Virtual_Keyboard_State vkb_state;
 134    Ecore_X_Illume_Clipboard_State clipboard_state;
 135 #endif
 136    struct
 137    {
 138       Ecore_Animator *animator; // animaton timer
 139       double          start; // time started
 140       Evas_Coord      auto_x, auto_y; // desired delta
 141       Evas_Coord      x, y; // current delta
 142    } delta;
 143    Ecore_Job                     *show_region_job;
 144    Elm_Win_Indicator_Mode         indmode;
 145    Elm_Win_Indicator_Opacity_Mode ind_o_mode;
 146    Ecore_Timer                   *land_indi_timer;
 147    Ecore_Timer                   *port_indi_timer;
 148
 149    int                            rot;
 150 };
 151
 152 /* Enum to identify conformant swallow parts */
 153 typedef enum _Conformant_Part_Type Conformant_Part_Type;
 154 enum _Conformant_Part_Type
 155 {
 156    ELM_CONFORMANT_INDICATOR_PART      = 1,
 157    ELM_CONFORMANT_SOFTKEY_PART        = 2,
 158    ELM_CONFORMANT_VIRTUAL_KEYPAD_PART = 4,
 159    ELM_CONFORMANT_CLIPBOARD_PART    = 8
 160 };
 161
 162 /**
 163  * @}
 164  */
 165
 166 EAPI extern const char ELM_CONFORMANT_SMART_NAME[];
 167 EAPI const Elm_Conformant_Smart_Class *elm_conformant_smart_class_get(void);
 168
 169 #define ELM_CONFORMANT_DATA_GET(o, sd) \
 170   Elm_Conformant_Smart_Data * sd = evas_object_smart_data_get(o)
 171
 172 #define ELM_CONFORMANT_DATA_GET_OR_RETURN(o, ptr)    \
 173   ELM_CONFORMANT_DATA_GET(o, ptr);                   \
 174   if (!ptr)                                          \
 175     {                                                \
 176        CRITICAL("No widget data for object %p (%s)", \
 177                 o, evas_object_type_get(o));         \
 178        return;                                       \
 179     }
 180
 181 #define ELM_CONFORMANT_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 182   ELM_CONFORMANT_DATA_GET(o, ptr);                         \
 183   if (!ptr)                                                \
 184     {                                                      \
 185        CRITICAL("No widget data for object %p (%s)",       \
 186                 o, evas_object_type_get(o));               \
 187        return val;                                         \
 188     }
 189
 190 #define ELM_CONFORMANT_CHECK(obj)                     \
 191   if (!obj || !elm_widget_type_check                  \
 192         ((obj), ELM_CONFORMANT_SMART_NAME, __func__)) \
 193     return
 194
 195 #endif