src/lib/elm_widget_datetime.h

   1 #ifndef ELM_WIDGET_DATETIME_H
   2 #define ELM_WIDGET_DATETIME_H
   3
   4 #include "elm_widget_layout.h"
   5
   6 /**
   7  * @addtogroup Widget
   8  * @{
   9  *
  10  * @section elm-datetime-class The Elementary Datetime Class
  11  *
  12  * Elementary, besides having the @ref Datetime widget, exposes its
  13  * foundation -- the Elementary Datetime Class -- in order to create other
  14  * widgets which are a datetime with some more logic on top.
  15  */
  16
  17 /**
  18  * @def ELM_DATETIME_CLASS
  19  *
  20  * Use this macro to cast whichever subclass of
  21  * #Elm_Datetime_Smart_Class into it, so to access its fields.
  22  *
  23  * @ingroup Widget
  24  */
  25 #define ELM_DATETIME_CLASS(x) ((Elm_Datetime_Smart_Class *)x)
  26
  27 /**
  28  * @def ELM_DATETIME_DATA
  29  *
  30  * Use this macro to cast whichever subdata of
  31  * #Elm_Datetime_Smart_Data into it, so to access its fields.
  32  *
  33  * @ingroup Widget
  34  */
  35 #define ELM_DATETIME_DATA(x)  ((Elm_Datetime_Smart_Data *)x)
  36
  37 /**
  38  * @def ELM_DATETIME_SMART_CLASS_VERSION
  39  *
  40  * Current version for Elementary datetime @b base smart class, a value
  41  * which goes to _Elm_Datetime_Smart_Class::version.
  42  *
  43  * @ingroup Widget
  44  */
  45 #define ELM_DATETIME_SMART_CLASS_VERSION 1
  46
  47 /**
  48  * @def ELM_DATETIME_SMART_CLASS_INIT
  49  *
  50  * Initializer for a whole #Elm_Datetime_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_DATETIME_SMART_CLASS_INIT_NULL
  59  * @see ELM_DATETIME_SMART_CLASS_INIT_NAME_VERSION
  60  *
  61  * @ingroup Widget
  62  */
  63 #define ELM_DATETIME_SMART_CLASS_INIT(smart_class_init) \
  64   {smart_class_init, ELM_DATETIME_SMART_CLASS_VERSION}
  65
  66 /**
  67  * @def ELM_DATETIME_SMART_CLASS_INIT_NULL
  68  *
  69  * Initializer to zero out a whole #Elm_Datetime_Smart_Class structure.
  70  *
  71  * @see ELM_DATETIME_SMART_CLASS_INIT_NAME_VERSION
  72  * @see ELM_DATETIME_SMART_CLASS_INIT
  73  *
  74  * @ingroup Widget
  75  */
  76 #define ELM_DATETIME_SMART_CLASS_INIT_NULL \
  77   ELM_DATETIME_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  78
  79 /**
  80  * @def ELM_DATETIME_SMART_CLASS_INIT_NAME_VERSION
  81  *
  82  * Initializer to zero out a whole #Elm_Datetime_Smart_Class structure and
  83  * set its name and version.
  84  *
  85  * This is similar to #ELM_DATETIME_SMART_CLASS_INIT_NULL, but it will
  86  * also set the version field of #Elm_Datetime_Smart_Class (base field)
  87  * to the latest #ELM_DATETIME_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_DATETIME_SMART_CLASS_INIT_NULL
  95  * @see ELM_DATETIME_SMART_CLASS_INIT
  96  *
  97  * @ingroup Widget
  98  */
  99 #define ELM_DATETIME_SMART_CLASS_INIT_NAME_VERSION(name) \
 100   ELM_DATETIME_SMART_CLASS_INIT                          \
 101     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
 102
 103 /**
 104  * Elementary datetime base smart class. This inherits directly from
 105  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
 106  * behavior of a datetime.
 107  *
 108  * All of the functions listed on @ref Datetime namespace will work for
 109  * objects deriving from #Elm_Datetime_Smart_Class.
 110  */
 111 typedef struct _Elm_Datetime_Smart_Class
 112 {
 113    Elm_Layout_Smart_Class base;
 114
 115    int                    version;    /**< Version of this smart class definition */
 116 } Elm_Datetime_Smart_Class;
 117
 118 /**
 119  * Base layout smart data extended with datetime instance data.
 120  */
 121 typedef struct _Elm_Datetime_Smart_Data Elm_Datetime_Smart_Data;
 122 typedef struct _Datetime_Field          Datetime_Field;
 123 typedef struct _Datetime_Mod_Api        Datetime_Mod_Api;
 124 typedef struct _Format_Map              Format_Map;
 125
 126 #define ELM_DATETIME_TYPE_COUNT           6
 127 #define ELM_DATETIME_MAX_FORMAT_LEN       64
 128 #define ELM_DATETIME_MAX_FIELD_FORMAT_LEN 3
 129
 130 struct _Datetime_Field
 131 {
 132    Evas_Object            *item_obj;
 133    char                    fmt[ELM_DATETIME_MAX_FIELD_FORMAT_LEN];
 134    Elm_Datetime_Field_Type type;
 135    const char             *separator;
 136    int                     location;  /* location of the field as per
 137                                        * current format */
 138    int                     min, max;
 139    Eina_Bool               fmt_exist : 1;  /* whether field format is
 140                                             * present or not */
 141    Eina_Bool               visible : 1;  /* whether field can be
 142                                           * visible or not */
 143 };
 144
 145 struct _Datetime_Mod_Api
 146 {
 147    Elm_Datetime_Module_Data *(*obj_hook)(Evas_Object * obj);
 148    void                      (*obj_unhook)(Elm_Datetime_Module_Data *mdata);
 149    void                      (*obj_hide)(Elm_Datetime_Module_Data *mdata);
 150    Evas_Object              *(*field_create)(Elm_Datetime_Module_Data * mdata,
 151                                              Elm_Datetime_Field_Type ftype);
 152    void                      (*field_value_display)(Elm_Datetime_Module_Data
 153                                                     *mdata,
 154                                                     Evas_Object *obj);
 155 };
 156
 157 struct _Elm_Datetime_Smart_Data
 158 {
 159    Elm_Layout_Smart_Data     base;
 160
 161    /* fixed set of fields. */
 162    Datetime_Field            field_list[ELM_DATETIME_TYPE_COUNT];
 163    struct tm                 curr_time, min_limit, max_limit;
 164    Elm_Datetime_Module_Data *mod_data;
 165    char                      format[ELM_DATETIME_MAX_FORMAT_LEN];
 166    Evas_Object              *access_obj;
 167    Eina_Bool                 user_format : 1;  /* whether user set
 168                                                 * format or default
 169                                                 * format. */
 170 };
 171
 172 struct _Format_Map
 173 {
 174    char *fmt_char;
 175    int   def_min;
 176    int   def_max;
 177    char *ignore_sep;
 178 };
 179
 180 /**
 181  * @}
 182  */
 183
 184 EAPI extern const char ELM_DATETIME_SMART_NAME[];
 185 EAPI const Elm_Datetime_Smart_Class *elm_datetime_smart_class_get(void);
 186
 187 #define ELM_DATETIME_DATA_GET(o, sd) \
 188   Elm_Datetime_Smart_Data * sd = evas_object_smart_data_get(o)
 189
 190 #define ELM_DATETIME_DATA_GET_OR_RETURN(o, ptr)      \
 191   ELM_DATETIME_DATA_GET(o, ptr);                     \
 192   if (!ptr)                                          \
 193     {                                                \
 194        CRITICAL("No widget data for object %p (%s)", \
 195                 o, evas_object_type_get(o));         \
 196        return;                                       \
 197     }
 198
 199 #define ELM_DATETIME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 200   ELM_DATETIME_DATA_GET(o, ptr);                         \
 201   if (!ptr)                                              \
 202     {                                                    \
 203        CRITICAL("No widget data for object %p (%s)",     \
 204                 o, evas_object_type_get(o));             \
 205        return val;                                       \
 206     }
 207
 208 #define ELM_DATETIME_CHECK(obj)                                      \
 209   if (!obj || !elm_widget_type_check((obj), ELM_DATETIME_SMART_NAME, \
 210                                      __func__))                      \
 211     return
 212
 213 #endif