1 #ifndef ELM_WIDGET_LABEL_H
2 #define ELM_WIDGET_LABEL_H
4 #include "elm_widget_layout.h"
14 * @section elm-label-class The Elementary Label Class
16 * Elementary, besides having the @ref Label widget, exposes its
17 * foundation -- the Elementary Label Class -- in order to create other
18 * widgets which are a label with some more logic on top.
22 * @def ELM_LABEL_CLASS
24 * Use this macro to cast whichever subclass of
25 * #Elm_Label_Smart_Class into it, so to access its fields.
29 #define ELM_LABEL_CLASS(x) ((Elm_Label_Smart_Class *)x)
34 * Use this macro to cast whichever subdata of
35 * #Elm_Label_Smart_Data into it, so to access its fields.
39 #define ELM_LABEL_DATA(x) ((Elm_Label_Smart_Data *)x)
42 * @def ELM_LABEL_SMART_CLASS_VERSION
44 * Current version for Elementary label @b base smart class, a value
45 * which goes to _Elm_Label_Smart_Class::version.
49 #define ELM_LABEL_SMART_CLASS_VERSION 1
52 * @def ELM_LABEL_SMART_CLASS_INIT
54 * Initializer for a whole #Elm_Label_Smart_Class structure, with
55 * @c NULL values on its specific fields.
57 * @param smart_class_init initializer to use for the "base" field
58 * (#Evas_Smart_Class).
60 * @see EVAS_SMART_CLASS_INIT_NULL
61 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
62 * @see ELM_LABEL_SMART_CLASS_INIT_NULL
63 * @see ELM_LABEL_SMART_CLASS_INIT_NAME_VERSION
67 #define ELM_LABEL_SMART_CLASS_INIT(smart_class_init) \
68 {smart_class_init, ELM_LABEL_SMART_CLASS_VERSION}
71 * @def ELM_LABEL_SMART_CLASS_INIT_NULL
73 * Initializer to zero out a whole #Elm_Label_Smart_Class structure.
75 * @see ELM_LABEL_SMART_CLASS_INIT_NAME_VERSION
76 * @see ELM_LABEL_SMART_CLASS_INIT
80 #define ELM_LABEL_SMART_CLASS_INIT_NULL \
81 ELM_LABEL_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
84 * @def ELM_LABEL_SMART_CLASS_INIT_NAME_VERSION
86 * Initializer to zero out a whole #Elm_Label_Smart_Class structure and
87 * set its name and version.
89 * This is similar to #ELM_LABEL_SMART_CLASS_INIT_NULL, but it will
90 * also set the version field of #Elm_Label_Smart_Class (base field)
91 * to the latest #ELM_LABEL_SMART_CLASS_VERSION and name it to the
94 * It will keep a reference to the name field as a <c>"const char *"</c>,
95 * i.e., the name must be available while the structure is
96 * used (hint: static or global variable!) and must not be modified.
98 * @see ELM_LABEL_SMART_CLASS_INIT_NULL
99 * @see ELM_LABEL_SMART_CLASS_INIT
103 #define ELM_LABEL_SMART_CLASS_INIT_NAME_VERSION(name) \
104 ELM_LABEL_SMART_CLASS_INIT \
105 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
108 * Elementary label base smart class. This inherits directly from
109 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
110 * behavior of a label.
112 * All of the functions listed on @ref Label namespace will work for
113 * objects deriving from #Elm_Label_Smart_Class.
115 typedef struct _Elm_Label_Smart_Class
117 Elm_Layout_Smart_Class base;
119 int version; /**< Version of this smart class definition */
120 } Elm_Label_Smart_Class;
123 * Base layout smart data extended with label instance data.
125 typedef struct _Elm_Label_Smart_Data Elm_Label_Smart_Data;
126 struct _Elm_Label_Smart_Data
128 Elm_Layout_Smart_Data base;
131 double slide_duration;
134 Elm_Wrap_Type linewrap;
135 Elm_Label_Slide_Mode slide_mode;
137 // TIZEN_ONLY(131028): Support item, anchor formats
138 Ecore_Timer *longpress_timer;
140 Eina_List *item_providers;
141 Evas_Coord down_x, down_y;
142 Eina_Bool mouse_down_flag : 1;
144 Eina_Bool ellipsis : 1;
145 Eina_Bool slide_ellipsis : 1;
148 // TIZEN_ONLY(131028): Support item, anchor formats
149 typedef struct _Sel Sel;
152 Evas_Textblock_Rectangle rect;
153 Evas_Object *obj_fg, *obj_bg, *obj, *sobj;
156 typedef struct _Elm_Label_Anchor_Data Elm_Label_Anchor_Data;
157 struct _Elm_Label_Anchor_Data
162 Evas_Textblock_Cursor *start, *end;
164 Evas_Coord down_x, down_y;
165 Eina_Bool mouse_down_flag : 1;
169 typedef struct _Elm_Label_Item_Provider Elm_Label_Item_Provider;
170 struct _Elm_Label_Item_Provider
172 Evas_Object *(*func)(void *data, Evas_Object * entry, const char *item);
175 ///////////////////////////
180 EAPI extern const char ELM_LABEL_SMART_NAME[];
181 EAPI const Elm_Label_Smart_Class *elm_label_smart_class_get(void);
183 #define ELM_LABEL_DATA_GET(o, sd) \
184 Elm_Label_Smart_Data * sd = evas_object_smart_data_get(o)
186 #define ELM_LABEL_DATA_GET_OR_RETURN(o, ptr) \
187 ELM_LABEL_DATA_GET(o, ptr); \
190 CRITICAL("No widget data for object %p (%s)", \
191 o, evas_object_type_get(o)); \
195 #define ELM_LABEL_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
196 ELM_LABEL_DATA_GET(o, ptr); \
199 CRITICAL("No widget data for object %p (%s)", \
200 o, evas_object_type_get(o)); \
204 #define ELM_LABEL_CHECK(obj) \
205 if (!obj || !elm_widget_type_check \
206 ((obj), ELM_LABEL_SMART_NAME, __func__)) \