4 /* DO NOT USE THIS HEADER UNLESS YOU ARE PREPARED FOR BREAKING OF YOUR
5 * CODE. THIS IS ELEMENTARY'S INTERNAL WIDGET API (for now) AND IS NOT
6 * FINAL. CALL elm_widget_api_check(ELM_INTERNAL_API_VERSION) TO CHECK IT
9 * How to make your own widget? like this:
11 * #include <Elementary.h>
12 * #include "elm_priv.h"
14 * typedef struct _Widget_Data Widget_Data;
19 * // add any other widget data here too
22 * static const char *widtype = NULL;
23 * static void _del_hook(Evas_Object *obj);
24 * static void _theme_hook(Evas_Object *obj);
25 * static void _disable_hook(Evas_Object *obj);
26 * static void _sizing_eval(Evas_Object *obj);
27 * static void _on_focus_hook(void *data, Evas_Object *obj);
29 * static const char SIG_CLICKED[] = "clicked";
30 * static const Evas_Smart_Cb_Description _signals[] = {
36 * _del_hook(Evas_Object *obj)
38 * Widget_Data *wd = elm_widget_data_get(obj);
40 * // delete hook - on delete of object delete object struct etc.
45 * _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
47 * Widget_Data *wd = elm_widget_data_get(obj);
49 * // handle focus going in and out - optional, but if you want to, set
50 * // this hook and handle it (eg emit a signal to an edje obj)
51 * if (elm_widget_focus_get(obj))
53 * edje_object_signal_emit(wd->sub, "elm,action,focus", "elm");
54 * evas_object_focus_set(wd->sub, EINA_TRUE);
58 * edje_object_signal_emit(wd->sub, "elm,action,unfocus", "elm");
59 * evas_object_focus_set(wd->sub, EINA_FALSE);
64 * _theme_hook(Evas_Object *obj)
66 * Widget_Data *wd = elm_widget_data_get(obj);
68 * // handle change in theme/scale etc.
69 * elm_widget_theme_object_set(obj, wd->sub, "mywidget", "base",
70 * elm_widget_style_get(obj));
74 * _disable_hook(Evas_Object *obj)
76 * Widget_Data *wd = elm_widget_data_get(obj);
78 * // optional, but handle if the widget gets disabled or not
79 * if (elm_widget_disabled_get(obj))
80 * edje_object_signal_emit(wd->sub, "elm,state,disabled", "elm");
82 * edje_object_signal_emit(wd->sub, "elm,state,enabled", "elm");
86 * _sizing_eval(Evas_Object *obj)
88 * Widget_Data *wd = elm_widget_data_get(obj);
89 * Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
91 * elm_coords_finger_size_adjust(1, &minw, 1, &minh);
92 * edje_object_size_min_restricted_calc(wd->sub, &minw, &minh, minw, minh);
93 * elm_coords_finger_size_adjust(1, &minw, 1, &minh);
94 * evas_object_size_hint_min_set(obj, minw, minh);
95 * evas_object_size_hint_max_set(obj, maxw, maxh);
98 * // actual api to create your widget. add more to manipulate it as needed
99 * // mark your calls with EAPI to make them "external api" calls.
101 * elm_mywidget_add(Evas_Object *parent)
107 * // ALWAYS call this - this checks that your widget matches that of
108 * // elementary and that the api hasn't broken. if it has this returns
109 * // false and you need to handle this error gracefully
110 * if (!elm_widget_api_check(ELM_INTERNAL_API_VERSION)) return NULL;
112 * // standard widget setup and allocate wd, create obj given parent etc.
113 * ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
115 * // give it a type name and set up a mywidget type string if needed
116 * ELM_SET_WIDTYPE(widtype, "mywidget");
117 * elm_widget_type_set(obj, "mywidget");
118 * // tell the parent widget that we are a sub object
119 * elm_widget_sub_object_add(parent, obj);
120 * // setup hooks we need (some are optional)
121 * elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
122 * elm_widget_data_set(obj, wd);
123 * elm_widget_del_hook_set(obj, _del_hook);
124 * elm_widget_theme_hook_set(obj, _theme_hook);
125 * elm_widget_disable_hook_set(obj, _disable_hook);
126 * // this widget can focus (true means yes it can, false means it can't)
127 * elm_widget_can_focus_set(obj, EINA_TRUE);
129 * // for this widget we will add 1 sub object that is an edje object
130 * wd->sub = edje_object_add(e);
131 * // set the theme. this follows a scheme for group name like this:
132 * // "elm/WIDGETNAME/ELEMENT/STYLE"
133 * // so here it will be:
134 * // "elm/mywidget/base/default"
135 * // changing style changes style name from default (all widgets start
136 * // with the default style) and element is for your widget internal
137 * // structure as you see fit
138 * elm_widget_theme_object_set(obj, wd->sub, "mywidget", "base", "default");
139 * // listen to a signal from the edje object to produce widget smart
140 * // callback (like click)
141 * edje_object_signal_callback_add(wd->sub, "elm,action,click", "",
142 * _signal_clicked, obj);
143 * // set this sub object as the "resize object". widgets get 1 resize
144 * // object that is resized along with the object wrapper.
145 * elm_widget_resize_object_set(obj, wd->sub);
147 * // evaluate sizing of the widget (minimum size calc etc.). optional but
148 * // not a bad idea to do here. it will get queued for later anyway
151 * // register the smart callback descriptions so we can have some runtime
152 * // info as to what the smart callback strings mean
153 * evas_object_smart_callbacks_descriptions_set(obj, _signals);
157 * // example - do "whatever" to the widget (here just emit a signal)
159 * elm_mywidget_whatever(Evas_Object *obj)
161 * // check if type is correct - check will return if it fails
162 * ELM_CHECK_WIDTYPE(obj, widtype);
163 * // get widget data - type is correct and sane by this point, so this
164 * // should never fail
165 * Widget_Data *wd = elm_widget_data_get(obj);
166 * // do whatever you like
167 * edje_object_signal_emit(wd->sub, "elm,state,action,whatever", "elm");
170 * // you can add more - you need to see elementary's code to know how to
171 * // handle all cases. remember this api is not stable and may change. it's
176 #ifndef ELM_INTERNAL_API_ARGESFSDFEFC
177 # warning "You are using an internal elementary API. This API is not stable"
178 # warning "and is subject to change. You use this at your own risk."
179 # warning "Remember to call elm_widget_api_check(ELM_INTERNAL_API_VERSION);"
180 # warning "in your widgets before you call any other elm_widget calls to do"
181 # warning "a correct runtime version check. Also remember - you don't NEED"
182 # warning "to make an Elementary widget is almost ALL cases. You can easily"
183 # warning "make a smart object with Evas's API and do everything you need"
184 # warning "there. You only need a widget if you want to seamlessly be part"
185 # warning "of the focus tree and want to transparently become a container"
186 # warning "for any number of child Elementary widgets"
187 //# error "ERROR. Compile aborted." // Note : Do not merge this from upstream.
189 #define ELM_INTERNAL_API_VERSION 7000
191 typedef struct _Elm_Tooltip Elm_Tooltip;
192 typedef struct _Elm_Cursor Elm_Cursor;
193 typedef struct _Elm_Widget_Item Elm_Widget_Item; /**< base structure for all widget items that are not Elm_Widget themselves */
195 typedef struct _Elm_Access_Info Elm_Access_Info; /**< accessibility information to be able to set and get from the access API */
196 typedef struct _Elm_Access_Item Elm_Access_Item; /**< accessibility info item */
198 typedef void (*Elm_Widget_On_Text_Set_Cb)(void *data, const char *part, const char *text);
199 typedef void (*Elm_Widget_On_Content_Set_Cb)(void *data, const char *part, Evas_Object *content);
200 typedef const char *(*Elm_Widget_On_Text_Get_Cb)(const void *data, const char *part);
201 typedef Evas_Object *(*Elm_Widget_On_Content_Get_Cb)(const void *data, const char *part);
202 typedef Evas_Object *(*Elm_Widget_On_Content_Unset_Cb)(const void *data, const char *part);
203 typedef void (*Elm_Widget_On_Signal_Emit_Cb)(void *data, const char *emission, const char *source);
205 #define ELM_ACCESS_TYPE 0 // when reading out widget or item this is read first
206 #define ELM_ACCESS_INFO 1 // next read is info - this is normally label
207 #define ELM_ACCESS_STATE 2 // if there is a state (eg checkbox) then read state out
208 #define ELM_ACCESS_CONTENT 3 // read ful content - eg all of the label, not a shortened version
210 #define ELM_ACCESS_DONE -1 // sentence done - send done event here
211 #define ELM_ACCESS_CANCEL -2 // stop reading immediately
213 typedef char *(*Elm_Access_Content_Cb)(void *data, Evas_Object *obj, Elm_Widget_Item *item);
215 struct _Elm_Access_Item
219 Elm_Access_Content_Cb func;
222 struct _Elm_Access_Info
225 Ecore_Timer *delay_timer;
228 EAPI void _elm_access_clear(Elm_Access_Info *ac);
229 EAPI void _elm_access_text_set(Elm_Access_Info *ac, int type, const char *text);
230 EAPI void _elm_access_callback_set(Elm_Access_Info *ac, int type, Elm_Access_Content_Cb func, const void *data);
231 EAPI char *_elm_access_text_get(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item);
232 EAPI void _elm_access_read(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item);
233 EAPI void _elm_access_say(const char *txt);
234 EAPI Elm_Access_Info *_elm_access_object_get(Evas_Object *obj);
235 EAPI Elm_Access_Info *_elm_access_item_get(Elm_Widget_Item *it);
236 EAPI void _elm_access_object_hilight(Evas_Object *obj);
237 EAPI void _elm_access_object_unhilight(Evas_Object *obj);
238 EAPI void _elm_access_object_hilight_disable(Evas *e);
239 EAPI void _elm_access_object_register(Evas_Object *obj, Evas_Object *hoverobj);
240 EAPI void _elm_access_item_register(Elm_Widget_Item *item, Evas_Object *hoverobj);
241 EAPI Eina_Bool _elm_access_2nd_click_timeout(Evas_Object *obj);
243 #define ELM_WIDGET_ITEM Elm_Widget_Item base /**< put this as the first member in your widget item struct */
244 struct _Elm_Widget_Item
246 /* ef1 ~~ efl, el3 ~~ elm */
247 #define ELM_WIDGET_ITEM_MAGIC 0xef1e1301
250 /* simple accessor macros */
251 #define VIEW(X) X->base.view
252 #define WIDGET(X) X->base.widget
253 Evas_Object *widget; /**< the owner widget that owns this item */
254 Evas_Object *view; /**< the base view object */
255 const void *data; /**< item specific data */
256 Evas_Smart_Cb del_cb; /**< used to notify the item is being deleted */
257 Elm_Widget_On_Content_Set_Cb on_content_set_func;
258 Elm_Widget_On_Content_Get_Cb on_content_get_func;
259 Elm_Widget_On_Content_Unset_Cb on_content_unset_func;
260 Elm_Widget_On_Text_Set_Cb on_text_set_func;
261 Elm_Widget_On_Text_Get_Cb on_text_get_func;
262 Elm_Widget_On_Signal_Emit_Cb on_signal_emit_func;
263 Elm_Access_Info *access;
264 const char *access_info;
265 /* widget variations should have data from here and on */
266 /* @todo: TODO check if this is enough for 1.0 release, maybe add padding! */
269 struct _Elm_Object_Item
274 #define ELM_NEW(t) calloc(1, sizeof(t))
276 #define ELM_OBJ_ITEM_CHECK_OR_RETURN(it, ...) \
277 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *) (it), __VA_ARGS__); \
278 ELM_CHECK_WIDTYPE(it->base.widget, widtype) __VA_ARGS__;
280 EAPI Eina_Bool elm_widget_api_check(int ver);
281 EAPI Evas_Object *elm_widget_add(Evas *evas);
282 EAPI void elm_widget_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
283 EAPI void elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
284 EAPI void elm_widget_focus_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
285 EAPI void elm_widget_activate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
286 EAPI void elm_widget_disable_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
287 EAPI void elm_widget_theme_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
288 EAPI void elm_widget_translate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
289 EAPI void elm_widget_event_hook_set(Evas_Object *obj, Eina_Bool (*func) (Evas_Object *obj, Evas_Object *source, Evas_Callback_Type type, void *event_info));
290 EAPI void elm_widget_changed_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
291 EAPI void elm_widget_signal_emit_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source));
292 EAPI void elm_widget_signal_callback_add_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data));
293 EAPI void elm_widget_signal_callback_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func_cb, void *data));
294 EAPI void elm_widget_theme(Evas_Object *obj);
295 EAPI void elm_widget_theme_specific(Evas_Object *obj, Elm_Theme *th, Eina_Bool force);
296 EAPI void elm_widget_translate(Evas_Object *obj);
297 EAPI void elm_widget_focus_next_hook_set(Evas_Object *obj, Eina_Bool (*func) (const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next));
298 EAPI void elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
299 EAPI void elm_widget_on_change_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
300 EAPI void elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
301 EAPI void elm_widget_focus_region_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h));
302 EAPI void elm_widget_text_set_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Set_Cb func);
303 #define elm_widget_text_set_hook_set(obj, func) elm_widget_text_set_hook_set(obj, (Elm_Widget_On_Text_Set_Cb)(func))
304 EAPI void elm_widget_text_get_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Get_Cb func);
305 #define elm_widget_text_get_hook_set(obj, func) elm_widget_text_get_hook_set(obj, (Elm_Widget_On_Text_Get_Cb)(func))
306 EAPI void elm_widget_content_set_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Set_Cb func);
307 #define elm_widget_content_set_hook_set(obj, func) elm_widget_content_set_hook_set(obj, (Elm_Widget_On_Content_Set_Cb)(func))
308 EAPI void elm_widget_content_get_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Get_Cb func);
309 #define elm_widget_content_get_hook_set(obj, func) elm_widget_content_get_hook_set(obj, (Elm_Widget_On_Content_Get_Cb)(func))
310 EAPI void elm_widget_content_unset_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Unset_Cb func);
311 #define elm_widget_content_unset_hook_set(obj, func) elm_widget_content_unset_hook_set(obj, (Elm_Widget_On_Content_Unset_Cb)(func))
312 EAPI void elm_widget_on_focus_region_hook_set(Evas_Object *obj, void (*func) (const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h));
313 EAPI void elm_widget_data_set(Evas_Object *obj, void *data);
314 EAPI void *elm_widget_data_get(const Evas_Object *obj);
315 EAPI void elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj);
316 EAPI void elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj);
317 EAPI void elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj);
318 EAPI void elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj);
319 EAPI void elm_widget_signal_emit(Evas_Object *obj, const char *emission, const char *source);
320 EAPI void elm_widget_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data);
321 EAPI void *elm_widget_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source));
322 EAPI void elm_widget_can_focus_set(Evas_Object *obj, Eina_Bool can_focus);
323 EAPI Eina_Bool elm_widget_can_focus_get(const Evas_Object *obj);
324 EAPI Eina_Bool elm_widget_child_can_focus_get(const Evas_Object *obj);
325 EAPI void elm_widget_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable);
326 EAPI Eina_Bool elm_widget_tree_unfocusable_get(const Evas_Object *obj);
327 EAPI void elm_widget_highlight_ignore_set(Evas_Object *obj, Eina_Bool ignore);
328 EAPI Eina_Bool elm_widget_highlight_ignore_get(const Evas_Object *obj);
329 EAPI void elm_widget_highlight_in_theme_set(Evas_Object *obj, Eina_Bool highlight);
330 EAPI Eina_Bool elm_widget_highlight_in_theme_get(const Evas_Object *obj);
331 EAPI Eina_Bool elm_widget_focus_get(const Evas_Object *obj);
332 EAPI Evas_Object *elm_widget_focused_object_get(const Evas_Object *obj);
333 EAPI Evas_Object *elm_widget_top_get(const Evas_Object *obj);
334 EAPI Eina_Bool elm_widget_is(const Evas_Object *obj);
335 EAPI Evas_Object *elm_widget_parent_widget_get(const Evas_Object *obj);
336 EAPI void elm_widget_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data);
337 EAPI void *elm_widget_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data);
338 EAPI Eina_Bool elm_widget_event_propagate(Evas_Object *obj, Evas_Callback_Type type, void *event_info, Evas_Event_Flags *event_flags);
339 EAPI void elm_widget_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs);
340 EAPI void elm_widget_focus_custom_chain_unset(Evas_Object *obj);
341 EAPI const Eina_List *elm_widget_focus_custom_chain_get(const Evas_Object *obj);
342 EAPI void elm_widget_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
343 EAPI void elm_widget_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
344 EAPI void elm_widget_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir);
345 EAPI void elm_widget_focus_direction_go(Evas_Object *obj, int x, int y);
346 EAPI Eina_Bool elm_widget_focus_next_get(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next);
347 EAPI Eina_Bool elm_widget_focus_list_next_get(const Evas_Object *obj, const Eina_List *items, void *(*list_data_get) (const Eina_List *list), Elm_Focus_Direction dir, Evas_Object **next);
348 EAPI void elm_widget_focus_set(Evas_Object *obj, int first);
349 EAPI void elm_widget_focused_object_clear(Evas_Object *obj);
350 EAPI Evas_Object *elm_widget_parent_get(const Evas_Object *obj);
351 EAPI void elm_widget_focus_steal(Evas_Object *obj);
356 * Restore the focus state of the sub-tree.
358 * This API will restore the focus state of the sub-tree to the lastest
359 * state. If a sub-tree is unfocused and wants to get back to the lastest
360 * focus state, this API will be helpful.
362 * @param obj The widget root of sub-tree
366 EAPI void elm_widget_focus_restore(Evas_Object *obj);
368 EAPI void elm_widget_activate(Evas_Object *obj);
369 EAPI void elm_widget_change(Evas_Object *obj);
370 EAPI void elm_widget_disabled_set(Evas_Object *obj, Eina_Bool disabled);
371 EAPI Eina_Bool elm_widget_disabled_get(const Evas_Object *obj);
372 EAPI void elm_widget_show_region_set(Evas_Object *obj, Evas_Coord x, Evas_Coord y, Evas_Coord w, Evas_Coord h, Eina_Bool forceshow);
373 EAPI void elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
374 EAPI void elm_widget_focus_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
375 EAPI void elm_widget_scroll_hold_push(Evas_Object *obj);
376 EAPI void elm_widget_scroll_hold_pop(Evas_Object *obj);
377 EAPI int elm_widget_scroll_hold_get(const Evas_Object *obj);
378 EAPI void elm_widget_scroll_freeze_push(Evas_Object *obj);
379 EAPI void elm_widget_scroll_freeze_pop(Evas_Object *obj);
380 EAPI int elm_widget_scroll_freeze_get(const Evas_Object *obj);
381 EAPI void elm_widget_scale_set(Evas_Object *obj, double scale);
382 EAPI double elm_widget_scale_get(const Evas_Object *obj);
383 EAPI Eina_Bool elm_widget_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
384 EAPI void elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
385 EAPI Eina_Bool elm_widget_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
386 EAPI void elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
387 EAPI void elm_widget_theme_set(Evas_Object *obj, Elm_Theme *th);
388 EAPI Elm_Theme *elm_widget_theme_get(const Evas_Object *obj);
389 EAPI void elm_widget_style_set(Evas_Object *obj, const char *style);
390 EAPI const char *elm_widget_style_get(const Evas_Object *obj);
391 EAPI void elm_widget_type_set(Evas_Object *obj, const char *type);
392 EAPI const char *elm_widget_type_get(const Evas_Object *obj);
393 EAPI void elm_widget_tooltip_add(Evas_Object *obj, Elm_Tooltip *tt);
394 EAPI void elm_widget_tooltip_del(Evas_Object *obj, Elm_Tooltip *tt);
395 EAPI void elm_widget_cursor_add(Evas_Object *obj, Elm_Cursor *cur);
396 EAPI void elm_widget_cursor_del(Evas_Object *obj, Elm_Cursor *cur);
397 EAPI void elm_widget_drag_lock_x_set(Evas_Object *obj, Eina_Bool lock);
398 EAPI void elm_widget_drag_lock_y_set(Evas_Object *obj, Eina_Bool lock);
399 EAPI Eina_Bool elm_widget_drag_lock_x_get(const Evas_Object *obj);
400 EAPI Eina_Bool elm_widget_drag_lock_y_get(const Evas_Object *obj);
401 EAPI int elm_widget_drag_child_locked_x_get(const Evas_Object *obj);
402 EAPI int elm_widget_drag_child_locked_y_get(const Evas_Object *obj);
403 EAPI Eina_Bool elm_widget_theme_object_set(Evas_Object *obj, Evas_Object *edj, const char *wname, const char *welement, const char *wstyle);
404 EAPI void elm_widget_type_register(const char **ptr);
405 EAPI void elm_widget_type_unregister(const char **ptr);
406 EAPI Eina_Bool elm_widget_type_check(const Evas_Object *obj, const char *type);
407 EAPI Eina_List *elm_widget_stringlist_get(const char *str);
408 EAPI void elm_widget_stringlist_free(Eina_List *list);
409 EAPI void elm_widget_focus_hide_handle(Evas_Object *obj);
410 EAPI void elm_widget_focus_mouse_up_handle(Evas_Object *obj);
411 EAPI void elm_widget_focus_tree_unfocusable_handle(Evas_Object *obj);
412 EAPI void elm_widget_focus_disabled_handle(Evas_Object *obj);
413 EAPI void elm_widget_text_part_set(Evas_Object *obj, const char *part, const char *label);
414 EAPI const char *elm_widget_text_part_get(const Evas_Object *obj, const char *part);
415 EAPI void elm_widget_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
416 EAPI const char *elm_widget_translatable_text_part_get(const Evas_Object *obj, const char *part);
417 EAPI void elm_widget_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
418 EAPI Evas_Object *elm_widget_content_part_get(const Evas_Object *obj, const char *part);
419 EAPI Evas_Object *elm_widget_content_part_unset(Evas_Object *obj, const char *part);
420 EAPI void elm_widget_access_info_set(Evas_Object *obj, const char *txt);
421 EAPI const char *elm_widget_access_info_get(Evas_Object *obj);
422 EAPI Elm_Widget_Item *_elm_widget_item_new(Evas_Object *parent, size_t alloc_size);
423 EAPI void _elm_widget_item_del(Elm_Widget_Item *item);
424 EAPI void _elm_widget_item_pre_notify_del(Elm_Widget_Item *item);
425 EAPI void _elm_widget_item_del_cb_set(Elm_Widget_Item *item, Evas_Smart_Cb del_cb);
426 EAPI void _elm_widget_item_data_set(Elm_Widget_Item *item, const void *data);
427 EAPI void *_elm_widget_item_data_get(const Elm_Widget_Item *item);
428 EAPI void _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item, const char *text);
429 EAPI void _elm_widget_item_tooltip_translatable_text_set(Elm_Widget_Item *item, const char *text);
430 EAPI void _elm_widget_item_tooltip_content_cb_set(Elm_Widget_Item *item, Elm_Tooltip_Item_Content_Cb func, const void *data, Evas_Smart_Cb del_cb);
431 EAPI void _elm_widget_item_tooltip_unset(Elm_Widget_Item *item);
432 EAPI void _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item, const char *style);
433 EAPI const char *_elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item);
434 EAPI void _elm_widget_item_cursor_set(Elm_Widget_Item *item, const char *cursor);
435 EAPI const char *_elm_widget_item_cursor_get(const Elm_Widget_Item *item);
436 EAPI void _elm_widget_item_cursor_unset(Elm_Widget_Item *item);
437 EAPI void _elm_widget_item_cursor_style_set(Elm_Widget_Item *item, const char *style);
438 EAPI const char *_elm_widget_item_cursor_style_get(const Elm_Widget_Item *item);
439 EAPI void _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item, Eina_Bool engine_only);
440 EAPI Eina_Bool _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item);
441 EAPI void _elm_widget_item_content_part_set(Elm_Widget_Item *item, const char *part, Evas_Object *content);
442 EAPI Evas_Object *_elm_widget_item_content_part_get(const Elm_Widget_Item *item, const char *part);
443 EAPI Evas_Object *_elm_widget_item_content_part_unset(Elm_Widget_Item *item, const char *part);
444 EAPI void _elm_widget_item_text_part_set(Elm_Widget_Item *item, const char *part, const char *label);
445 EAPI const char *_elm_widget_item_text_part_get(const Elm_Widget_Item *item, const char *part);
446 EAPI void _elm_widget_item_signal_emit(Elm_Widget_Item *item, const char *emission, const char *source);
447 EAPI void _elm_widget_item_content_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Set_Cb func);
448 EAPI void _elm_widget_item_content_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Get_Cb func);
449 EAPI void _elm_widget_item_content_unset_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Unset_Cb func);
450 EAPI void _elm_widget_item_text_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Set_Cb func);
451 EAPI void _elm_widget_item_text_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Get_Cb func);
452 EAPI void _elm_widget_item_signal_emit_hook_set(Elm_Widget_Item *it, Elm_Widget_On_Signal_Emit_Cb func);
453 EAPI void _elm_widget_item_access_info_set(Elm_Widget_Item *item, const char *txt);
456 /* debug function. don't use it unless you are tracking parenting issues */
457 EAPI void elm_widget_tree_dump(const Evas_Object *top);
458 EAPI void elm_widget_tree_dot_dump(const Evas_Object *top, FILE *output);
461 * Convenience macro to create new widget item, doing casts for you.
462 * @see _elm_widget_item_new()
463 * @param parent a valid elm_widget variant.
464 * @param type the C type that extends Elm_Widget_Item
466 #define elm_widget_item_new(parent, type) \
467 (type *)_elm_widget_item_new((parent), sizeof(type))
469 * Convenience macro to delete widget item, doing casts for you.
470 * @see _elm_widget_item_del()
471 * @param item a valid item.
473 #define elm_widget_item_del(item) \
474 _elm_widget_item_del((Elm_Widget_Item *)item)
476 * Convenience macro to notify deletion of widget item, doing casts for you.
477 * @see _elm_widget_item_pre_notify_del()
479 #define elm_widget_item_pre_notify_del(item) \
480 _elm_widget_item_pre_notify_del((Elm_Widget_Item *)item)
482 * Convenience macro to set deletion callback of widget item, doing casts for you.
483 * @see _elm_widget_item_del_cb_set()
485 #define elm_widget_item_del_cb_set(item, del_cb) \
486 _elm_widget_item_del_cb_set((Elm_Widget_Item *)item, del_cb)
490 * @see _elm_widget_item_data_set()
492 #define elm_widget_item_data_set(item, data) \
493 _elm_widget_item_data_set((Elm_Widget_Item *)item, data)
496 * @see _elm_widget_item_data_get()
498 #define elm_widget_item_data_get(item) \
499 _elm_widget_item_data_get((const Elm_Widget_Item *)item)
502 * Convenience function to set widget item tooltip as a text string.
503 * @see _elm_widget_item_tooltip_text_set()
505 #define elm_widget_item_tooltip_text_set(item, text) \
506 _elm_widget_item_tooltip_text_set((Elm_Widget_Item *)item, text)
508 * Convenience function to set widget item tooltip as a text string.
509 * @see _elm_widget_item_tooltip_text_set()
511 #define elm_widget_item_tooltip_translatable_text_set(item, text) \
512 _elm_widget_item_tooltip_translatable_text_set((Elm_Widget_Item *)item, text)
514 * Convenience function to set widget item tooltip.
515 * @see _elm_widget_item_tooltip_content_cb_set()
517 #define elm_widget_item_tooltip_content_cb_set(item, func, data, del_cb) \
518 _elm_widget_item_tooltip_content_cb_set((Elm_Widget_Item *)item, \
521 * Convenience function to unset widget item tooltip.
522 * @see _elm_widget_item_tooltip_unset()
524 #define elm_widget_item_tooltip_unset(item) \
525 _elm_widget_item_tooltip_unset((Elm_Widget_Item *)item)
527 * Convenience function to change item's tooltip style.
528 * @see _elm_widget_item_tooltip_style_set()
530 #define elm_widget_item_tooltip_style_set(item, style) \
531 _elm_widget_item_tooltip_style_set((Elm_Widget_Item *)item, style)
533 * Convenience function to query item's tooltip style.
534 * @see _elm_widget_item_tooltip_style_get()
536 #define elm_widget_item_tooltip_style_get(item) \
537 _elm_widget_item_tooltip_style_get((const Elm_Widget_Item *)item)
539 * Convenience function to set widget item cursor.
540 * @see _elm_widget_item_cursor_set()
542 #define elm_widget_item_cursor_set(item, cursor) \
543 _elm_widget_item_cursor_set((Elm_Widget_Item *)item, cursor)
545 * Convenience function to get widget item cursor.
546 * @see _elm_widget_item_cursor_get()
548 #define elm_widget_item_cursor_get(item) \
549 _elm_widget_item_cursor_get((const Elm_Widget_Item *)item)
551 * Convenience function to unset widget item cursor.
552 * @see _elm_widget_item_cursor_unset()
554 #define elm_widget_item_cursor_unset(item) \
555 _elm_widget_item_cursor_unset((Elm_Widget_Item *)item)
557 * Convenience function to change item's cursor style.
558 * @see _elm_widget_item_cursor_style_set()
560 #define elm_widget_item_cursor_style_set(item, style) \
561 _elm_widget_item_cursor_style_set((Elm_Widget_Item *)item, style)
563 * Convenience function to query item's cursor style.
564 * @see _elm_widget_item_cursor_style_get()
566 #define elm_widget_item_cursor_style_get(item) \
567 _elm_widget_item_cursor_style_get((const Elm_Widget_Item *)item)
569 * Convenience function to change item's cursor engine_only.
570 * @see _elm_widget_item_cursor_engine_only_set()
572 #define elm_widget_item_cursor_engine_only_set(item, engine_only) \
573 _elm_widget_item_cursor_engine_only_set((Elm_Widget_Item *)item, engine_only)
575 * Convenience function to query item's cursor engine_only.
576 * @see _elm_widget_item_cursor_engine_only_get()
578 #define elm_widget_item_cursor_engine_only_get(item) \
579 _elm_widget_item_cursor_engine_only_get((const Elm_Widget_Item *)item)
581 * Convenience function to query item's content part set.
582 * @see _elm_widget_item_content_part_set()
584 #define elm_widget_item_content_part_set(item, part, content) \
585 _elm_widget_item_content_part_set((Elm_Widget_Item *)item, part, content)
587 * Convenience function to query item's content part get.
588 * @see _elm_widget_item_content_part_get()
590 #define elm_widget_item_content_part_get(item, part) \
591 _elm_widget_item_content_part_get((const Elm_Widget_Item *)item, part)
593 * Convenience function to query item's content part unset.
594 * @see _elm_widget_item_content_part_unset()
596 #define elm_widget_item_content_part_unset(item, part) \
597 _elm_widget_item_content_part_unset((Elm_Widget_Item *)item, part)
599 * Convenience function to query item's text part set.
600 * @see _elm_widget_item_text_part_set()
602 #define elm_widget_item_text_part_set(item, part, label) \
603 _elm_widget_item_text_part_set((Elm_Widget_Item *)item, part, label)
605 * Convenience function to query item's text part get.
606 * @see _elm_widget_item_text_part_get()
608 #define elm_widget_item_text_part_get(item, part) \
609 _elm_widget_item_text_part_get((const Elm_Widget_Item *)item, part)
611 * Convenience function to query item's signal emit.
612 * @see _elm_widget_item_signal_emit()
614 #define elm_widget_item_signal_emit(item, emission, source) \
615 _elm_widget_item_signal_emit((Elm_Widget_Item *)item, emission, source)
617 * Convenience function to query item's content set hook.
618 * @see _elm_widget_item_content_set_hook_set()
620 #define elm_widget_item_content_set_hook_set(item, func) \
621 _elm_widget_item_content_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Set_Cb)func)
623 * Convenience function to query item's content get hook.
624 * @see _elm_widget_item_content_get_hook_set()
626 #define elm_widget_item_content_get_hook_set(item, func) \
627 _elm_widget_item_content_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Get_Cb)func)
629 * Convenience function to query item's content unset hook.
630 * @see _elm_widget_item_content_unset_hook_set()
632 #define elm_widget_item_content_unset_hook_set(item, func) \
633 _elm_widget_item_content_unset_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Unset_Cb)func)
635 * Convenience function to query item's text set hook.
636 * @see _elm_widget_item_text_set_hook_set()
638 #define elm_widget_item_text_set_hook_set(item, func) \
639 _elm_widget_item_text_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Set_Cb)func)
641 * Convenience function to query item's text get hook.
642 * @see _elm_widget_item_text_get_hook_set()
644 #define elm_widget_item_text_get_hook_set(item, func) \
645 _elm_widget_item_text_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Get_Cb)func)
647 * Convenience function to query item's signal emit hook.
648 * @see _elm_widget_item_signal_emit_hook_set()
650 #define elm_widget_item_signal_emit_hook_set(item, func) \
651 _elm_widget_item_signal_emit_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Signal_Emit_Cb)func)
654 #define ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, ...) \
657 CRITICAL("Elm_Widget_Item " # item " is NULL!"); \
658 return __VA_ARGS__; \
660 if (!EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC)) { \
661 EINA_MAGIC_FAIL(item, ELM_WIDGET_ITEM_MAGIC); \
662 return __VA_ARGS__; \
666 #define ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, label) \
669 CRITICAL("Elm_Widget_Item " # item " is NULL!"); \
672 if (!EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC)) { \
673 EINA_MAGIC_FAIL(item, ELM_WIDGET_ITEM_MAGIC); \
678 #define ELM_SET_WIDTYPE(widtype, type) \
681 widtype = eina_stringshare_add(type); \
682 elm_widget_type_register(&widtype); \
686 #define ELM_CHECK_WIDTYPE(obj, widtype) \
687 if (!elm_widget_type_check((obj), (widtype))) return
689 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, ...) \
690 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
691 ELM_CHECK_WIDTYPE(it->base.widget, widtype) __VA_ARGS__;
693 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(it, label) \
694 ELM_WIDGET_ITEM_CHECK_OR_GOTO((Elm_Widget_Item *)it, label); \
695 if (!elm_widget_type_check((it->base.widget), (widtype))) goto label;
697 #define ELM_WIDGET_STANDARD_SETUP(wdat, wdtype, par, evas, ob, ret) \
699 EINA_SAFETY_ON_NULL_RETURN_VAL((par), (ret)); \
700 evas = evas_object_evas_get(par); if (!(evas)) return (ret); \
701 wdat = ELM_NEW(wdtype); if (!(wdat)) return (ret); \
702 ob = elm_widget_add(evas); if (!(ob)) { free(wdat); return (ret); } \
706 * The drag and drop API.
707 * Currently experimental, and will change when it does dynamic type
710 * Here so applications can start to use it, if they ask elm nicely.
712 * And yes, elm_widget, should probably be elm_experimental...
713 * Complaints about this code should go to /dev/null, or failing that nash.
715 typedef struct _Elm_Selection_Data Elm_Selection_Data;
717 typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
719 typedef enum _Elm_Sel_Type
729 typedef enum _Elm_Sel_Format
731 /** Plain unformated text: Used for things that don't want rich markup */
732 ELM_SEL_FORMAT_TEXT = 0x01,
733 /** Edje textblock markup, including inline images */
734 ELM_SEL_FORMAT_MARKUP = 0x02,
736 ELM_SEL_FORMAT_IMAGE = 0x04,
738 ELM_SEL_FORMAT_VCARD = 0x08,
739 /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
740 ELM_SEL_FORMAT_HTML = 0x10,
743 struct _Elm_Selection_Data
746 Elm_Sel_Format format;
751 Eina_Bool elm_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const char *buf);
752 Eina_Bool elm_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);
753 Eina_Bool elm_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
754 Eina_Bool elm_drop_target_add(Evas_Object *widget, Elm_Sel_Type, Elm_Drop_Cb, void *);
755 Eina_Bool elm_drop_target_del(Evas_Object *widget);
756 Eina_Bool elm_drag_start(Evas_Object *, Elm_Sel_Format, const char *, void (*)(void *,Evas_Object*),void*);