mobile/src/lib/elm_widget_diskselector.h

   1 #ifndef ELM_WIDGET_DISKSELECTOR_H
   2 #define ELM_WIDGET_DISKSELECTOR_H
   3
   4 #include "elm_interface_scrollable.h"
   5
   6 /**
   7  * @addtogroup Widget
   8  * @{
   9  *
  10  * @section elm-diskselector-class The Elementary Diskselector Class
  11  *
  12  * Elementary, besides having the @ref Diskselector widget, exposes its
  13  * foundation -- the Elementary Diskselector Class -- in order to create other
  14  * widgets which are a diskselector with some more logic on top.
  15  */
  16
  17 /**
  18  * @def ELM_DISKSELECTOR_CLASS
  19  *
  20  * Use this macro to cast whichever subclass of
  21  * #Elm_Diskselector_Smart_Class into it, so to access its fields.
  22  *
  23  * @ingroup Widget
  24  */
  25 #define ELM_DISKSELECTOR_CLASS(x) ((Elm_Diskselector_Smart_Class *)x)
  26
  27 /**
  28  * @def ELM_DISKSELECTOR_DATA
  29  *
  30  * Use this macro to cast whichever subdata of
  31  * #Elm_Diskselector_Smart_Data into it, so to access its fields.
  32  *
  33  * @ingroup Widget
  34  */
  35 #define ELM_DISKSELECTOR_DATA(x)  ((Elm_Diskselector_Smart_Data *)x)
  36
  37 /**
  38  * @def ELM_DISKSELECTOR_SMART_CLASS_VERSION
  39  *
  40  * Current version for Elementary diskselector @b base smart class, a value
  41  * which goes to _Elm_Diskselector_Smart_Class::version.
  42  *
  43  * @ingroup Widget
  44  */
  45 #define ELM_DISKSELECTOR_SMART_CLASS_VERSION 1
  46
  47 /**
  48  * @def ELM_DISKSELECTOR_SMART_CLASS_INIT
  49  *
  50  * Initializer for a whole #Elm_Diskselector_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_DISKSELECTOR_SMART_CLASS_INIT_NULL
  59  * @see ELM_DISKSELECTOR_SMART_CLASS_INIT_NAME_VERSION
  60  *
  61  * @ingroup Widget
  62  */
  63 #define ELM_DISKSELECTOR_SMART_CLASS_INIT(smart_class_init) \
  64   {smart_class_init, ELM_DISKSELECTOR_SMART_CLASS_VERSION}
  65
  66 /**
  67  * @def ELM_DISKSELECTOR_SMART_CLASS_INIT_NULL
  68  *
  69  * Initializer to zero out a whole #Elm_Diskselector_Smart_Class structure.
  70  *
  71  * @see ELM_DISKSELECTOR_SMART_CLASS_INIT_NAME_VERSION
  72  * @see ELM_DISKSELECTOR_SMART_CLASS_INIT
  73  *
  74  * @ingroup Widget
  75  */
  76 #define ELM_DISKSELECTOR_SMART_CLASS_INIT_NULL \
  77   ELM_DISKSELECTOR_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  78
  79 /**
  80  * @def ELM_DISKSELECTOR_SMART_CLASS_INIT_NAME_VERSION
  81  *
  82  * Initializer to zero out a whole #Elm_Diskselector_Smart_Class structure and
  83  * set its name and version.
  84  *
  85  * This is similar to #ELM_DISKSELECTOR_SMART_CLASS_INIT_NULL, but it will
  86  * also set the version field of #Elm_Diskselector_Smart_Class (base field)
  87  * to the latest #ELM_DISKSELECTOR_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_DISKSELECTOR_SMART_CLASS_INIT_NULL
  95  * @see ELM_DISKSELECTOR_SMART_CLASS_INIT
  96  *
  97  * @ingroup Widget
  98  */
  99 #define ELM_DISKSELECTOR_SMART_CLASS_INIT_NAME_VERSION(name) \
 100   ELM_DISKSELECTOR_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
 101
 102 /**
 103  * Elementary diskselector base smart class. This inherits directly from
 104  * #Elm_Widget_Smart_Class and is meant to build widgets extending the
 105  * behavior of a diskselector.
 106  *
 107  * All of the functions listed on @ref Diskselector namespace will work for
 108  * objects deriving from #Elm_Diskselector_Smart_Class.
 109  */
 110 typedef struct _Elm_Diskselector_Smart_Class
 111 {
 112    Elm_Widget_Smart_Class base;
 113
 114    int                    version; /**< Version of this smart class definition */
 115 } Elm_Diskselector_Smart_Class;
 116
 117 /**
 118  * Base widget smart data extended with diskselector instance data.
 119  */
 120 typedef struct _Elm_Diskselector_Smart_Data Elm_Diskselector_Smart_Data;
 121 typedef struct _Elm_Diskselector_Item       Elm_Diskselector_Item;
 122
 123 struct _Elm_Diskselector_Smart_Data
 124 {
 125    Elm_Widget_Smart_Data                 base; /* base widget smart data as
 126                                                 * first member obligatory, as
 127                                                 * we're inheriting from it */
 128
 129    Evas_Object                          *hit_rect;
 130    const Elm_Scrollable_Smart_Interface *s_iface;
 131
 132    Evas_Object                          *main_box;
 133    Elm_Diskselector_Item                *selected_item;
 134    Elm_Diskselector_Item                *first;
 135    Elm_Diskselector_Item                *second;
 136    Elm_Diskselector_Item                *s_last;
 137    Elm_Diskselector_Item                *last;
 138    Eina_List                            *items;
 139    Eina_List                            *r_items;
 140    Eina_List                            *over_items;
 141    Eina_List                            *under_items;
 142    Eina_List                            *left_blanks;
 143    Eina_List                            *right_blanks;
 144    Ecore_Idle_Enterer                   *idler;
 145    Ecore_Idle_Enterer                   *check_idler;
 146
 147    int                                   item_count, len_threshold, len_side,
 148                                          display_item_num;
 149    Evas_Coord                            minw, minh;
 150
 151    Eina_Bool                             init : 1;
 152    Eina_Bool                             round : 1;
 153    Eina_Bool                             display_item_num_by_api : 1;
 154    Eina_Bool                             left_boundary_reached:1;
 155    Eina_Bool                             right_boundary_reached:1;
 156 };
 157
 158 struct _Elm_Diskselector_Item
 159 {
 160    ELM_WIDGET_ITEM;
 161
 162    Eina_List    *node;
 163    Evas_Object  *icon;
 164    const char   *label;
 165    Evas_Smart_Cb func;
 166 };
 167
 168 /**
 169  * @}
 170  */
 171
 172 EAPI extern const char ELM_DISKSELECTOR_SMART_NAME[];
 173 EAPI const Elm_Diskselector_Smart_Class
 174 *elm_diskselector_smart_class_get(void);
 175
 176 #define ELM_DISKSELECTOR_DATA_GET(o, sd) \
 177   Elm_Diskselector_Smart_Data * sd = evas_object_smart_data_get(o)
 178
 179 #define ELM_DISKSELECTOR_DATA_GET_OR_RETURN(o, ptr)  \
 180   ELM_DISKSELECTOR_DATA_GET(o, ptr);                 \
 181   if (!ptr)                                          \
 182     {                                                \
 183        CRITICAL("No widget data for object %p (%s)", \
 184                 o, evas_object_type_get(o));         \
 185        return;                                       \
 186     }
 187
 188 #define ELM_DISKSELECTOR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 189   ELM_DISKSELECTOR_DATA_GET(o, ptr);                         \
 190   if (!ptr)                                                  \
 191     {                                                        \
 192        CRITICAL("No widget data for object %p (%s)",         \
 193                 o, evas_object_type_get(o));                 \
 194        return val;                                           \
 195     }
 196
 197 #define ELM_DISKSELECTOR_CHECK(obj)                                          \
 198   if (!obj || !elm_widget_type_check((obj),                                  \
 199                                      ELM_DISKSELECTOR_SMART_NAME, __func__)) \
 200     return
 201
 202 #define ELM_DISKSELECTOR_ITEM_CHECK(it)                     \
 203   ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
 204   ELM_DISKSELECTOR_CHECK(it->base.widget);
 205
 206 #define ELM_DISKSELECTOR_ITEM_CHECK_OR_RETURN(it, ...)                 \
 207   ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
 208   ELM_DISKSELECTOR_CHECK(it->base.widget) __VA_ARGS__;
 209
 210 #define ELM_DISKSELECTOR_ITEM_CHECK_OR_GOTO(it, label)         \
 211   ELM_WIDGET_ITEM_CHECK_OR_GOTO((Elm_Widget_Item *)it, label); \
 212   if (!it->base.widget || !elm_widget_type_check               \
 213         ((it->base.widget), ELM_DISKSELECTOR_SMART_NAME, __func__)) goto label;
 214
 215 #endif