src/lib/elm_widget_calendar.h

   1 #ifndef ELM_WIDGET_CALENDAR_H
   2 #define ELM_WIDGET_CALENDAR_H
   3
   4 #include "elm_widget_layout.h"
   5
   6 /**
   7  * @addtogroup Widget
   8  * @{
   9  *
  10  * @section elm-calendar-class The Elementary Calendar Class
  11  *
  12  * Elementary, besides having the @ref Calendar widget, exposes its
  13  * foundation -- the Elementary Calendar Class -- in order to create other
  14  * widgets which are a calendar with some more logic on top.
  15  */
  16
  17 /**
  18  * @def ELM_CALENDAR_CLASS
  19  *
  20  * Use this macro to cast whichever subclass of
  21  * #Elm_Calendar_Smart_Class into it, so to access its fields.
  22  *
  23  * @ingroup Widget
  24  */
  25 #define ELM_CALENDAR_CLASS(x) ((Elm_Calendar_Smart_Class *)x)
  26
  27 /**
  28  * @def ELM_CALENDAR_DATA
  29  *
  30  * Use this macro to cast whichever subdata of
  31  * #Elm_Calendar_Smart_Data into it, so to access its fields.
  32  *
  33  * @ingroup Widget
  34  */
  35 #define ELM_CALENDAR_DATA(x)  ((Elm_Calendar_Smart_Data *)x)
  36
  37 /**
  38  * @def ELM_CALENDAR_SMART_CLASS_VERSION
  39  *
  40  * Current version for Elementary calendar @b base smart class, a value
  41  * which goes to _Elm_Calendar_Smart_Class::version.
  42  *
  43  * @ingroup Widget
  44  */
  45 #define ELM_CALENDAR_SMART_CLASS_VERSION 1
  46
  47 /**
  48  * @def ELM_CALENDAR_SMART_CLASS_INIT
  49  *
  50  * Initializer for a whole #Elm_Calendar_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_CALENDAR_SMART_CLASS_INIT_NULL
  59  * @see ELM_CALENDAR_SMART_CLASS_INIT_NAME_VERSION
  60  *
  61  * @ingroup Widget
  62  */
  63 #define ELM_CALENDAR_SMART_CLASS_INIT(smart_class_init) \
  64   {smart_class_init, ELM_CALENDAR_SMART_CLASS_VERSION}
  65
  66 /**
  67  * @def ELM_CALENDAR_SMART_CLASS_INIT_NULL
  68  *
  69  * Initializer to zero out a whole #Elm_Calendar_Smart_Class structure.
  70  *
  71  * @see ELM_CALENDAR_SMART_CLASS_INIT_NAME_VERSION
  72  * @see ELM_CALENDAR_SMART_CLASS_INIT
  73  *
  74  * @ingroup Widget
  75  */
  76 #define ELM_CALENDAR_SMART_CLASS_INIT_NULL \
  77   ELM_CALENDAR_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  78
  79 /**
  80  * @def ELM_CALENDAR_SMART_CLASS_INIT_NAME_VERSION
  81  *
  82  * Initializer to zero out a whole #Elm_Calendar_Smart_Class structure and
  83  * set its name and version.
  84  *
  85  * This is similar to #ELM_CALENDAR_SMART_CLASS_INIT_NULL, but it will
  86  * also set the version field of #Elm_Calendar_Smart_Class (base field)
  87  * to the latest #ELM_CALENDAR_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_CALENDAR_SMART_CLASS_INIT_NULL
  95  * @see ELM_CALENDAR_SMART_CLASS_INIT
  96  *
  97  * @ingroup Widget
  98  */
  99 #define ELM_CALENDAR_SMART_CLASS_INIT_NAME_VERSION(name) \
 100   ELM_CALENDAR_SMART_CLASS_INIT                          \
 101     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
 102
 103 /**
 104  * Elementary calendar base smart class. This inherits directly from
 105  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
 106  * behavior of a calendar.
 107  *
 108  * All of the functions listed on @ref Calendar namespace will work for
 109  * objects deriving from #Elm_Calendar_Smart_Class.
 110  */
 111 typedef struct _Elm_Calendar_Smart_Class
 112 {
 113    Elm_Layout_Smart_Class base;
 114
 115    int                    version;    /**< Version of this smart class definition */
 116 } Elm_Calendar_Smart_Class;
 117
 118 /**
 119  * Base layout smart data extended with calendar instance data.
 120  */
 121 typedef struct _Elm_Calendar_Smart_Data Elm_Calendar_Smart_Data;
 122
 123 typedef enum _Day_Color // EINA_DEPRECATED
 124 {
 125    DAY_WEEKDAY = 0,
 126    DAY_SATURDAY = 1,
 127    DAY_SUNDAY = 2
 128 } Day_Color;
 129
 130 struct _Elm_Calendar_Smart_Data
 131 {
 132    Elm_Layout_Smart_Data    base;
 133
 134    Eina_List               *marks;
 135    double                   interval, first_interval;
 136    int                      year_min, year_max, spin_speed;
 137    int                      today_it, selected_it, first_day_it;
 138    Elm_Calendar_Weekday     first_week_day;
 139    Ecore_Timer             *spin, *update_timer;
 140    Elm_Calendar_Format_Cb   format_func;
 141    const char              *weekdays[ELM_DAY_LAST];
 142    struct tm                current_time, selected_time, shown_time;
 143    Day_Color                day_color[42]; // EINA_DEPRECATED
 144    Elm_Calendar_Select_Mode select_mode;
 145    Evas_Object             *inc_btn_access;
 146    Evas_Object             *dec_btn_access;
 147    Evas_Object             *month_access;
 148    Eina_Bool                selected : 1;
 149    Elm_Calendar_Selectable  selectable;
 150 };
 151
 152 struct _Elm_Calendar_Mark
 153 {
 154    Evas_Object                  *obj;
 155    Eina_List                    *node;
 156    struct tm                     mark_time;
 157    const char                   *mark_type;
 158    Elm_Calendar_Mark_Repeat_Type repeat;
 159 };
 160
 161 /**
 162  * @}
 163  */
 164
 165 EAPI extern const char ELM_CALENDAR_SMART_NAME[];
 166 EAPI const Elm_Calendar_Smart_Class *elm_calendar_smart_class_get(void);
 167
 168 #define ELM_CALENDAR_DATA_GET(o, sd) \
 169   Elm_Calendar_Smart_Data * sd = evas_object_smart_data_get(o)
 170
 171 #define ELM_CALENDAR_DATA_GET_OR_RETURN(o, ptr)      \
 172   ELM_CALENDAR_DATA_GET(o, ptr);                     \
 173   if (!ptr)                                          \
 174     {                                                \
 175        CRITICAL("No widget data for object %p (%s)", \
 176                 o, evas_object_type_get(o));         \
 177        return;                                       \
 178     }
 179
 180 #define ELM_CALENDAR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 181   ELM_CALENDAR_DATA_GET(o, ptr);                         \
 182   if (!ptr)                                              \
 183     {                                                    \
 184        CRITICAL("No widget data for object %p (%s)",     \
 185                 o, evas_object_type_get(o));             \
 186        return val;                                       \
 187     }
 188
 189 #define ELM_CALENDAR_CHECK(obj)                                      \
 190   if (!obj || !elm_widget_type_check((obj), ELM_CALENDAR_SMART_NAME, \
 191                                      __func__))                      \
 192     return
 193
 194 #endif