Merge "elm_widget - added item signal emit function naviframe - filled the signal...
[framework/uifw/elementary.git] / src / lib / elm_widget.h
1 #ifndef ELM_WIDGET_H
2 #define ELM_WIDGET_H
3
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
7  * AT RUNTIME
8  *
9  * How to make your own widget? like this:
10  *
11  * #include <Elementary.h>
12  * #include "elm_priv.h"
13  *
14  * typedef struct _Widget_Data Widget_Data;
15  *
16  * struct _Widget_Data
17  * {
18  *   Evas_Object *sub;
19  *   // add any other widget data here too
20  * };
21  *
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);
28  *
29  * static const char SIG_CLICKED[] = "clicked";
30  * static const Evas_Smart_Cb_Description _signals[] = {
31  *   {SIG_CLICKED, ""},
32  *   {NULL, NULL}
33  * };
34  *
35  * static void
36  * _del_hook(Evas_Object *obj)
37  * {
38  *    Widget_Data *wd = elm_widget_data_get(obj);
39  *    if (!wd) return;
40  *    // delete hook - on delete of object delete object struct etc.
41  *    free(wd);
42  * }
43  *
44  * static void
45  * _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
46  * {
47  *    Widget_Data *wd = elm_widget_data_get(obj);
48  *    if (!wd) return;
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))
52  *      {
53  *         edje_object_signal_emit(wd->sub, "elm,action,focus", "elm");
54  *         evas_object_focus_set(wd->sub, EINA_TRUE);
55  *      }
56  *    else
57  *      {
58  *         edje_object_signal_emit(wd->sub, "elm,action,unfocus", "elm");
59  *         evas_object_focus_set(wd->sub, EINA_FALSE);
60  *      }
61  * }
62  *
63  * static void
64  * _theme_hook(Evas_Object *obj)
65  * {
66  *    Widget_Data *wd = elm_widget_data_get(obj);
67  *    if (!wd) return;
68  *    // handle change in theme/scale etc.
69  *    elm_widget_theme_object_set(obj, wd->sub, "mywidget", "base",
70  *                                elm_widget_style_get(obj));
71  * }
72  *
73  * static void
74  * _disable_hook(Evas_Object *obj)
75  * {
76  *    Widget_Data *wd = elm_widget_data_get(obj);
77  *    if (!wd) return;
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");
81  *    else
82  *      edje_object_signal_emit(wd->sub, "elm,state,enabled", "elm");
83  * }
84  *
85  * static void
86  * _sizing_eval(Evas_Object *obj)
87  * {
88  *    Widget_Data *wd = elm_widget_data_get(obj);
89  *    Evas_Coord minw = -1, minh = -1, maxw = -1, maxh = -1;
90  *    if (!wd) return;
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);
96  * }
97  *
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.
100  * EAPI Evas_Object *
101  * elm_mywidget_add(Evas_Object *parent)
102  * {
103  *    Evas_Object *obj;
104  *    Evas *e;
105  *    Widget_Data *wd;
106  *
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;
111  *
112  *    // standard widget setup and allocate wd, create obj given parent etc.
113  *    ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
114  *
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);
128  *
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);
146  *
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
149  *    _sizing_eval(obj);
150  *
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);
154  *    return obj;
155  * }
156  *
157  * // example - do "whatever" to the widget (here just emit a signal)
158  * EAPI void
159  * elm_mywidget_whatever(Evas_Object *obj)
160  * {
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");
168  * }
169  *
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
172  * // internal
173  *
174  */
175
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.
188 #endif
189 #define ELM_INTERNAL_API_VERSION 7000
190
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 */
194
195 typedef void (*Elm_Widget_On_Text_Set_Cb)(void *data, const char *part, const char *text);
196 typedef void (*Elm_Widget_On_Content_Set_Cb)(void *data, const char *part, Evas_Object *content);
197 typedef const char *(*Elm_Widget_On_Text_Get_Cb)(const void *data, const char *part);
198 typedef Evas_Object *(*Elm_Widget_On_Content_Get_Cb)(const void *data, const char *part);
199 typedef Evas_Object *(*Elm_Widget_On_Content_Unset_Cb)(const void *data, const char *part);
200 typedef void (*Elm_Widget_On_Signal_Emit_Cb)(void *data, const char *emission, const char *source);
201
202 struct _Elm_Widget_Item
203 {
204    /* ef1 ~~ efl, el3 ~~ elm */
205 #define ELM_WIDGET_ITEM_MAGIC 0xef1e1301
206    EINA_MAGIC;
207
208    Evas_Object   *widget; /**< the owner widget that owns this item */
209    Evas_Object   *view; /**< the base view object */
210    const void    *data; /**< item specific data */
211    Evas_Smart_Cb  del_cb; /**< used to notify the item is being deleted */
212    Elm_Widget_On_Content_Set_Cb on_content_set_func;
213    Elm_Widget_On_Content_Get_Cb on_content_get_func;
214    Elm_Widget_On_Content_Unset_Cb on_content_unset_func;
215    Elm_Widget_On_Text_Set_Cb on_text_set_func;
216    Elm_Widget_On_Text_Get_Cb on_text_get_func;
217    Elm_Widget_On_Signal_Emit_Cb on_signal_emit_func;
218    /* widget variations should have data from here and on */
219    /* @todo: TODO check if this is enough for 1.0 release, maybe add padding! */
220 };
221
222 struct _Elm_Object_Item
223 {
224    Elm_Widget_Item it;
225 };
226
227 #define ELM_NEW(t) calloc(1, sizeof(t))
228
229 #define ELM_CAST(p) ((void *)(p))
230
231 #define ELM_OBJ_ITEM_CHECK_OR_RETURN(it, ...)                               \
232    ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *) (it), __VA_ARGS__);  \
233    ELM_CHECK_WIDTYPE(it->it.widget, widtype) __VA_ARGS__;
234
235 EAPI Eina_Bool        elm_widget_api_check(int ver);
236 EAPI Evas_Object     *elm_widget_add(Evas *evas);
237 EAPI void             elm_widget_del_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
238 EAPI void             elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
239 EAPI void             elm_widget_focus_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
240 EAPI void             elm_widget_activate_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
241 EAPI void             elm_widget_disable_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
242 EAPI void             elm_widget_theme_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
243 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));
244 EAPI void             elm_widget_changed_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj));
245 EAPI void             elm_widget_signal_emit_hook_set(Evas_Object *obj, void (*func) (Evas_Object *obj, const char *emission, const char *source));
246 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));
247 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));
248 EAPI void             elm_widget_theme(Evas_Object *obj);
249 EAPI void             elm_widget_theme_specific(Evas_Object *obj, Elm_Theme *th, Eina_Bool force);
250 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));
251 EAPI void             elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
252 EAPI void             elm_widget_on_change_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
253 EAPI void             elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func) (void *data, Evas_Object *obj), void *data);
254 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));
255 EAPI void             elm_widget_text_set_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Set_Cb func);
256 #define elm_widget_text_set_hook_set(obj, func) elm_widget_text_set_hook_set(obj, (Elm_Widget_On_Text_Set_Cb)(func))
257 EAPI void             elm_widget_text_get_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Get_Cb func);
258 #define elm_widget_text_get_hook_set(obj, func) elm_widget_text_get_hook_set(obj, (Elm_Widget_On_Text_Get_Cb)(func))
259 EAPI void             elm_widget_content_set_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Set_Cb func);
260 #define elm_widget_content_set_hook_set(obj, func) elm_widget_content_set_hook_set(obj, (Elm_Widget_On_Content_Set_Cb)(func))
261 EAPI void             elm_widget_content_get_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Get_Cb func);
262 #define elm_widget_content_get_hook_set(obj, func) elm_widget_content_get_hook_set(obj, (Elm_Widget_On_Content_Get_Cb)(func))
263 EAPI void             elm_widget_content_unset_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Unset_Cb func);
264 #define elm_widget_content_unset_hook_set(obj, func) elm_widget_content_unset_hook_set(obj, (Elm_Widget_On_Content_Unset_Cb)(func))
265 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));
266 EAPI void             elm_widget_data_set(Evas_Object *obj, void *data);
267 EAPI void            *elm_widget_data_get(const Evas_Object *obj);
268 EAPI void             elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj);
269 EAPI void             elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj);
270 EAPI void             elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj);
271 EAPI void             elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj);
272 EAPI void             elm_widget_signal_emit(Evas_Object *obj, const char *emission, const char *source);
273 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);
274 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));
275 EAPI void             elm_widget_can_focus_set(Evas_Object *obj, Eina_Bool can_focus);
276 EAPI Eina_Bool        elm_widget_can_focus_get(const Evas_Object *obj);
277 EAPI Eina_Bool        elm_widget_child_can_focus_get(const Evas_Object *obj);
278 EAPI void             elm_widget_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable);
279 EAPI Eina_Bool        elm_widget_tree_unfocusable_get(const Evas_Object *obj);
280 EAPI void             elm_widget_highlight_ignore_set(Evas_Object *obj, Eina_Bool ignore);
281 EAPI Eina_Bool        elm_widget_highlight_ignore_get(const Evas_Object *obj);
282 EAPI void             elm_widget_highlight_in_theme_set(Evas_Object *obj, Eina_Bool highlight);
283 EAPI Eina_Bool        elm_widget_highlight_in_theme_get(const Evas_Object *obj);
284 EAPI Eina_Bool        elm_widget_focus_get(const Evas_Object *obj);
285 EAPI Evas_Object     *elm_widget_focused_object_get(const Evas_Object *obj);
286 EAPI Evas_Object     *elm_widget_top_get(const Evas_Object *obj);
287 EAPI Eina_Bool        elm_widget_is(const Evas_Object *obj);
288 EAPI Evas_Object     *elm_widget_parent_widget_get(const Evas_Object *obj);
289 EAPI void             elm_widget_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data);
290 EAPI void            *elm_widget_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data);
291 EAPI Eina_Bool        elm_widget_event_propagate(Evas_Object *obj, Evas_Callback_Type type, void *event_info, Evas_Event_Flags *event_flags);
292 EAPI void             elm_widget_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs);
293 EAPI void             elm_widget_focus_custom_chain_unset(Evas_Object *obj);
294 EAPI const Eina_List *elm_widget_focus_custom_chain_get(const Evas_Object *obj);
295 EAPI void             elm_widget_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
296 EAPI void             elm_widget_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
297 EAPI void             elm_widget_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir);
298 EAPI void             elm_widget_focus_direction_go(Evas_Object *obj, int x, int y);
299 EAPI Eina_Bool        elm_widget_focus_next_get(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next);
300 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);
301 EAPI void             elm_widget_focus_set(Evas_Object *obj, int first);
302 EAPI void             elm_widget_focused_object_clear(Evas_Object *obj);
303 EAPI Evas_Object     *elm_widget_parent_get(const Evas_Object *obj);
304 EAPI void             elm_widget_focus_steal(Evas_Object *obj);
305
306 /**
307  * @internal
308  *
309  * Restore the focus state of the sub-tree.
310  *
311  * This API will restore the focus state of the sub-tree to the lastest
312  * state. If a sub-tree is unfocused and wants to get back to the lastest
313  * focus state, this API will be helpful.
314  *
315  * @param obj The widget root of sub-tree
316  *
317  * @ingroup Widget
318  */
319 EAPI void             elm_widget_focus_restore(Evas_Object *obj);
320
321 EAPI void             elm_widget_activate(Evas_Object *obj);
322 EAPI void             elm_widget_change(Evas_Object *obj);
323 EAPI void             elm_widget_disabled_set(Evas_Object *obj, Eina_Bool disabled);
324 EAPI Eina_Bool        elm_widget_disabled_get(const Evas_Object *obj);
325 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);
326 EAPI void             elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
327 EAPI void             elm_widget_focus_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
328 EAPI void             elm_widget_scroll_hold_push(Evas_Object *obj);
329 EAPI void             elm_widget_scroll_hold_pop(Evas_Object *obj);
330 EAPI int              elm_widget_scroll_hold_get(const Evas_Object *obj);
331 EAPI void             elm_widget_scroll_freeze_push(Evas_Object *obj);
332 EAPI void             elm_widget_scroll_freeze_pop(Evas_Object *obj);
333 EAPI int              elm_widget_scroll_freeze_get(const Evas_Object *obj);
334 EAPI void             elm_widget_scale_set(Evas_Object *obj, double scale);
335 EAPI double           elm_widget_scale_get(const Evas_Object *obj);
336 EAPI Eina_Bool        elm_widget_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
337 EAPI void             elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
338 EAPI Eina_Bool        elm_widget_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
339 EAPI void             elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
340 EAPI void             elm_widget_theme_set(Evas_Object *obj, Elm_Theme *th);
341 EAPI Elm_Theme       *elm_widget_theme_get(const Evas_Object *obj);
342 EAPI void             elm_widget_style_set(Evas_Object *obj, const char *style);
343 EAPI const char      *elm_widget_style_get(const Evas_Object *obj);
344 EAPI void             elm_widget_type_set(Evas_Object *obj, const char *type);
345 EAPI const char      *elm_widget_type_get(const Evas_Object *obj);
346 EAPI void             elm_widget_tooltip_add(Evas_Object *obj, Elm_Tooltip *tt);
347 EAPI void             elm_widget_tooltip_del(Evas_Object *obj, Elm_Tooltip *tt);
348 EAPI void             elm_widget_cursor_add(Evas_Object *obj, Elm_Cursor *cur);
349 EAPI void             elm_widget_cursor_del(Evas_Object *obj, Elm_Cursor *cur);
350 EAPI void             elm_widget_drag_lock_x_set(Evas_Object *obj, Eina_Bool lock);
351 EAPI void             elm_widget_drag_lock_y_set(Evas_Object *obj, Eina_Bool lock);
352 EAPI Eina_Bool        elm_widget_drag_lock_x_get(const Evas_Object *obj);
353 EAPI Eina_Bool        elm_widget_drag_lock_y_get(const Evas_Object *obj);
354 EAPI int              elm_widget_drag_child_locked_x_get(const Evas_Object *obj);
355 EAPI int              elm_widget_drag_child_locked_y_get(const Evas_Object *obj);
356 EAPI Eina_Bool        elm_widget_theme_object_set(Evas_Object *obj, Evas_Object *edj, const char *wname, const char *welement, const char *wstyle);
357 EAPI void             elm_widget_type_register(const char **ptr);
358 EAPI void             elm_widget_type_unregister(const char **ptr);
359 EAPI Eina_Bool        elm_widget_type_check(const Evas_Object *obj, const char *type);
360 EAPI Eina_List       *elm_widget_stringlist_get(const char *str);
361 EAPI void             elm_widget_stringlist_free(Eina_List *list);
362 EAPI void             elm_widget_focus_hide_handle(Evas_Object *obj);
363 EAPI void             elm_widget_focus_mouse_down_handle(Evas_Object *obj);
364 EAPI void             elm_widget_focus_tree_unfocusable_handle(Evas_Object *obj);
365 EAPI void             elm_widget_focus_disabled_handle(Evas_Object *obj);
366 EAPI void             elm_widget_text_part_set(Evas_Object *obj, const char *part, const char *label);
367 EAPI const char      *elm_widget_text_part_get(const Evas_Object *obj, const char *part);
368 EAPI void             elm_widget_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
369 EAPI Evas_Object     *elm_widget_content_part_get(const Evas_Object *obj, const char *part);
370 EAPI Evas_Object     *elm_widget_content_part_unset(Evas_Object *obj, const char *part);
371 EAPI Elm_Widget_Item *_elm_widget_item_new(Evas_Object *parent, size_t alloc_size);
372 EAPI void             _elm_widget_item_del(Elm_Widget_Item *item);
373 EAPI void             _elm_widget_item_pre_notify_del(Elm_Widget_Item *item);
374 EAPI void             _elm_widget_item_del_cb_set(Elm_Widget_Item *item, Evas_Smart_Cb del_cb);
375 EAPI void             _elm_widget_item_data_set(Elm_Widget_Item *item, const void *data);
376 EAPI void            *_elm_widget_item_data_get(const Elm_Widget_Item *item);
377 EAPI void             _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item, const char *text);
378 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);
379 EAPI void             _elm_widget_item_tooltip_unset(Elm_Widget_Item *item);
380 EAPI void             _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item, const char *style);
381 EAPI const char      *_elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item);
382 EAPI void             _elm_widget_item_cursor_set(Elm_Widget_Item *item, const char *cursor);
383 EAPI const char      *_elm_widget_item_cursor_get(const Elm_Widget_Item *item);
384 EAPI void             _elm_widget_item_cursor_unset(Elm_Widget_Item *item);
385 EAPI void             _elm_widget_item_cursor_style_set(Elm_Widget_Item *item, const char *style);
386 EAPI const char      *_elm_widget_item_cursor_style_get(const Elm_Widget_Item *item);
387 EAPI void             _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item, Eina_Bool engine_only);
388 EAPI Eina_Bool        _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item);
389 EAPI void             _elm_widget_item_content_part_set(Elm_Widget_Item *item, const char *part, Evas_Object *content);
390 EAPI Evas_Object     *_elm_widget_item_content_part_get(const Elm_Widget_Item *item, const char *part);
391 EAPI Evas_Object     *_elm_widget_item_content_part_unset(Elm_Widget_Item *item, const char *part);
392 EAPI void             _elm_widget_item_text_part_set(Elm_Widget_Item *item, const char *part, const char *label);
393 EAPI const char      *_elm_widget_item_text_part_get(const Elm_Widget_Item *item, const char *part);
394 EAPI void             _elm_widget_item_content_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Set_Cb func);
395 EAPI void             _elm_widget_item_content_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Get_Cb func);
396 EAPI void             _elm_widget_item_content_unset_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Unset_Cb func);
397 EAPI void             _elm_widget_item_text_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Set_Cb func);
398 EAPI void             _elm_widget_item_text_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Get_Cb func);
399 EAPI void             _elm_widget_item_signal_emit_hook_set(Elm_Widget_Item *it, Elm_Widget_On_Signal_Emit_Cb func);
400
401 /* debug function. don't use it unless you are tracking parenting issues */
402 EAPI void             elm_widget_tree_dump(const Evas_Object *top);
403 EAPI void             elm_widget_tree_dot_dump(const Evas_Object *top, FILE *output);
404
405 /**
406  * Convenience macro to create new widget item, doing casts for you.
407  * @see _elm_widget_item_new()
408  * @param parent a valid elm_widget variant.
409  * @param type the C type that extends Elm_Widget_Item
410  */
411 #define elm_widget_item_new(parent, type) \
412   (type *)_elm_widget_item_new((parent), sizeof(type))
413 /**
414  * Convenience macro to delete widget item, doing casts for you.
415  * @see _elm_widget_item_del()
416  * @param item a valid item.
417  */
418 #define elm_widget_item_del(item) \
419   _elm_widget_item_del((Elm_Widget_Item *)item)
420 /**
421  * Convenience macro to notify deletion of widget item, doing casts for you.
422  * @see _elm_widget_item_pre_notify_del()
423  */
424 #define elm_widget_item_pre_notify_del(item) \
425   _elm_widget_item_pre_notify_del((Elm_Widget_Item *)item)
426 /**
427  * Convenience macro to set deletion callback of widget item, doing casts for you.
428  * @see _elm_widget_item_del_cb_set()
429  */
430 #define elm_widget_item_del_cb_set(item, del_cb) \
431   _elm_widget_item_del_cb_set((Elm_Widget_Item *)item, del_cb)
432
433 /**
434  * Set item's data
435  * @see _elm_widget_item_data_set()
436  */
437 #define elm_widget_item_data_set(item, data) \
438   _elm_widget_item_data_set((Elm_Widget_Item *)item, data)
439 /**
440  * Get item's data
441  * @see _elm_widget_item_data_get()
442  */
443 #define elm_widget_item_data_get(item) \
444   _elm_widget_item_data_get((const Elm_Widget_Item *)item)
445
446 /**
447  * Convenience function to set widget item tooltip as a text string.
448  * @see _elm_widget_item_tooltip_text_set()
449  */
450 #define elm_widget_item_tooltip_text_set(item, text) \
451   _elm_widget_item_tooltip_text_set((Elm_Widget_Item *)item, text)
452 /**
453  * Convenience function to set widget item tooltip.
454  * @see _elm_widget_item_tooltip_content_cb_set()
455  */
456 #define elm_widget_item_tooltip_content_cb_set(item, func, data, del_cb) \
457   _elm_widget_item_tooltip_content_cb_set((Elm_Widget_Item *)item, \
458                                           func, data, del_cb)
459 /**
460  * Convenience function to unset widget item tooltip.
461  * @see _elm_widget_item_tooltip_unset()
462  */
463 #define elm_widget_item_tooltip_unset(item) \
464   _elm_widget_item_tooltip_unset((Elm_Widget_Item *)item)
465 /**
466  * Convenience function to change item's tooltip style.
467  * @see _elm_widget_item_tooltip_style_set()
468  */
469 #define elm_widget_item_tooltip_style_set(item, style) \
470   _elm_widget_item_tooltip_style_set((Elm_Widget_Item *)item, style)
471 /**
472  * Convenience function to query item's tooltip style.
473  * @see _elm_widget_item_tooltip_style_get()
474  */
475 #define elm_widget_item_tooltip_style_get(item) \
476   _elm_widget_item_tooltip_style_get((const Elm_Widget_Item *)item)
477 /**
478  * Convenience function to set widget item cursor.
479  * @see _elm_widget_item_cursor_set()
480  */
481 #define elm_widget_item_cursor_set(item, cursor) \
482   _elm_widget_item_cursor_set((Elm_Widget_Item *)item, cursor)
483 /**
484  * Convenience function to get widget item cursor.
485  * @see _elm_widget_item_cursor_get()
486  */
487 #define elm_widget_item_cursor_get(item) \
488   _elm_widget_item_cursor_get((const Elm_Widget_Item *)item)
489 /**
490  * Convenience function to unset widget item cursor.
491  * @see _elm_widget_item_cursor_unset()
492  */
493 #define elm_widget_item_cursor_unset(item) \
494   _elm_widget_item_cursor_unset((Elm_Widget_Item *)item)
495 /**
496  * Convenience function to change item's cursor style.
497  * @see _elm_widget_item_cursor_style_set()
498  */
499 #define elm_widget_item_cursor_style_set(item, style) \
500   _elm_widget_item_cursor_style_set((Elm_Widget_Item *)item, style)
501 /**
502  * Convenience function to query item's cursor style.
503  * @see _elm_widget_item_cursor_style_get()
504  */
505 #define elm_widget_item_cursor_style_get(item) \
506   _elm_widget_item_cursor_style_get((const Elm_Widget_Item *)item)
507 /**
508  * Convenience function to change item's cursor engine_only.
509  * @see _elm_widget_item_cursor_engine_only_set()
510  */
511 #define elm_widget_item_cursor_engine_only_set(item, engine_only) \
512   _elm_widget_item_cursor_engine_only_set((Elm_Widget_Item *)item, engine_only)
513 /**
514  * Convenience function to query item's cursor engine_only.
515  * @see _elm_widget_item_cursor_engine_only_get()
516  */
517 #define elm_widget_item_cursor_engine_only_get(item) \
518   _elm_widget_item_cursor_engine_only_get((const Elm_Widget_Item *)item)
519 /**
520  * Convenience function to query item's content part set.
521  * @see _elm_widget_item_content_part_set()
522  */
523 #define elm_widget_item_content_part_set(item, part, content) \
524   _elm_widget_item_content_part_set((Elm_Widget_Item *)item, part, content)
525 /**
526  * Convenience function to query item's content part get.
527  * @see _elm_widget_item_content_part_get()
528  */
529 #define elm_widget_item_content_part_get(item, part) \
530   _elm_widget_item_content_part_get((const Elm_Widget_Item *)item, part)
531 /**
532  * Convenience function to query item's content part unset.
533  * @see _elm_widget_item_content_part_unset()
534  */
535 #define elm_widget_item_content_part_unset(item, part) \
536   _elm_widget_item_content_part_unset((Elm_Widget_Item *)item, part)
537 /**
538  * Convenience function to query item's text part set.
539  * @see _elm_widget_item_text_part_set()
540  */
541 #define elm_widget_item_text_part_set(item, part, label) \
542   _elm_widget_item_text_part_set((Elm_Widget_Item *)item, part, label)
543 /**
544  * Convenience function to query item's text part get.
545  * @see _elm_widget_item_text_part_get()
546  */
547 #define elm_widget_item_text_part_get(item, part) \
548   _elm_widget_item_text_part_get((const Elm_Widget_Item *)item, part)
549 /**
550  * Convenience function to query item's signal emit.
551  * @see _elm_widget_item_signal_emit()
552  */
553 #define elm_widget_item_signal_emit(item, emission, source) \
554   _elm_widget_item_signal_emit((Elm_Widget_Item *)item, emission, source)
555 /**
556  * Convenience function to query item's content set hook.
557  * @see _elm_widget_item_content_set_hook_set()
558  */
559 #define elm_widget_item_content_set_hook_set(item, func) \
560   _elm_widget_item_content_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Set_Cb)func)
561 /**
562  * Convenience function to query item's content get hook.
563  * @see _elm_widget_item_content_get_hook_set()
564  */
565 #define elm_widget_item_content_get_hook_set(item, func) \
566   _elm_widget_item_content_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Get_Cb)func)
567 /**
568  * Convenience function to query item's content unset hook.
569  * @see _elm_widget_item_content_unset_hook_set()
570  */
571 #define elm_widget_item_content_unset_hook_set(item, func) \
572   _elm_widget_item_content_unset_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Unset_Cb)func)
573 /**
574  * Convenience function to query item's text set hook.
575  * @see _elm_widget_item_text_set_hook_set()
576  */
577 #define elm_widget_item_text_set_hook_set(item, func) \
578   _elm_widget_item_text_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Set_Cb)func)
579 /**
580  * Convenience function to query item's text get hook.
581  * @see _elm_widget_item_text_get_hook_set()
582  */
583 #define elm_widget_item_text_get_hook_set(item, func) \
584   _elm_widget_item_text_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Get_Cb)func)
585 /**
586  * Convenience function to query item's signal emit hook.
587  * @see _elm_widget_item_signal_emit_hook_set()
588  */
589 #define elm_widget_item_signal_emit_hook_set(item, func) \
590   _elm_widget_item_signal_emit_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Signal_Emit_Cb)func)
591
592 /**
593  * Cast and ensure the given pointer is an Elm_Widget_Item or return NULL.
594  */
595 #define ELM_WIDGET_ITEM(item) \
596    (((item) && (EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC))) ? \
597        ((Elm_Widget_Item *)(item)) : NULL)
598
599 #define ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, ...) \
600    do { \
601       if (!item) { \
602          CRITICAL("Elm_Widget_Item " # item " is NULL!"); \
603          return __VA_ARGS__; \
604       } \
605       if (!EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC)) { \
606          EINA_MAGIC_FAIL(item, ELM_WIDGET_ITEM_MAGIC); \
607          return __VA_ARGS__; \
608       } \
609    } while (0)
610
611 #define ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, label) \
612    do { \
613       if (!item) { \
614          CRITICAL("Elm_Widget_Item " # item " is NULL!"); \
615          goto label; \
616       } \
617       if (!EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC)) { \
618          EINA_MAGIC_FAIL(item, ELM_WIDGET_ITEM_MAGIC); \
619          goto label; \
620       } \
621    } while (0)
622
623 #define ELM_SET_WIDTYPE(widtype, type) \
624    do { \
625       if (!widtype) { \
626          widtype = eina_stringshare_add(type); \
627          elm_widget_type_register(&widtype); \
628       } \
629    } while (0)
630
631 #define ELM_CHECK_WIDTYPE(obj, widtype) \
632    if (!elm_widget_type_check((obj), (widtype))) return
633
634 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, ...)                \
635    ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
636    ELM_CHECK_WIDTYPE(it->base.widget, widtype) __VA_ARGS__;
637
638 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(it, label)                \
639    ELM_WIDGET_ITEM_CHECK_OR_GOTO((Elm_Widget_Item *)it, label);         \
640    if (!elm_widget_type_check((it->base.widget), (widtype))) goto label;
641
642 #define ELM_WIDGET_STANDARD_SETUP(wdat, wdtype, par, evas, ob, ret) \
643    do { \
644       EINA_SAFETY_ON_NULL_RETURN_VAL((par), (ret)); \
645       evas = evas_object_evas_get(par); if (!(evas)) return (ret); \
646       wdat = ELM_NEW(wdtype); if (!(wdat)) return (ret); \
647       ob = elm_widget_add(evas); if (!(ob)) { free(wdat); return (ret); } \
648    } while (0)
649
650 /**
651  * The drag and drop API.
652  * Currently experimental, and will change when it does dynamic type
653  * addition RSN.
654  *
655  * Here so applications can start to use it, if they ask elm nicely.
656  *
657  * And yes, elm_widget, should probably be elm_experimental...
658  * Complaints about this code should go to /dev/null, or failing that nash.
659  */
660 typedef struct _Elm_Selection_Data Elm_Selection_Data;
661
662 typedef Eina_Bool (*Elm_Drop_Cb) (void *d, Evas_Object *o, Elm_Selection_Data *data);
663
664 typedef enum _Elm_Sel_Type
665 {
666    ELM_SEL_PRIMARY,
667    ELM_SEL_SECONDARY,
668    ELM_SEL_CLIPBOARD,
669    ELM_SEL_XDND,
670
671    ELM_SEL_MAX,
672 } Elm_Sel_Type;
673
674 typedef enum _Elm_Sel_Format
675 {
676    /** Plain unformated text: Used for things that don't want rich markup */
677    ELM_SEL_FORMAT_TEXT   = 0x01,
678    /** Edje textblock markup, including inline images */
679    ELM_SEL_FORMAT_MARKUP = 0x02,
680    /** Images */
681    ELM_SEL_FORMAT_IMAGE  = 0x04,
682    /** Vcards */
683    ELM_SEL_FORMAT_VCARD =  0x08,
684    /** Raw HTMLish things for widgets that want that stuff (hello webkit!) */
685    ELM_SEL_FORMAT_HTML = 0x10,
686 } Elm_Sel_Format;
687
688 struct _Elm_Selection_Data
689 {
690    int                   x, y;
691    Elm_Sel_Format        format;
692    void                 *data;
693    int                   len;
694 };
695
696 Eina_Bool            elm_selection_set(Elm_Sel_Type selection, Evas_Object *widget, Elm_Sel_Format format, const char *buf);
697 Eina_Bool            elm_selection_clear(Elm_Sel_Type selection, Evas_Object *widget);
698 Eina_Bool            elm_selection_get(Elm_Sel_Type selection, Elm_Sel_Format format, Evas_Object *widget, Elm_Drop_Cb datacb, void *udata);
699 Eina_Bool            elm_drop_target_add(Evas_Object *widget, Elm_Sel_Type, Elm_Drop_Cb, void *);
700 Eina_Bool            elm_drop_target_del(Evas_Object *widget);
701 Eina_Bool            elm_drag_start(Evas_Object *, Elm_Sel_Format, const char *, void (*)(void *,Evas_Object*),void*);
702
703 #endif