elementary: let's install useful headers for c++
[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."
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
194 /**< base structure for all widget items that are not Elm_Widget themselves */
195 typedef struct _Elm_Widget_Item Elm_Widget_Item;
196
197 /**< accessibility information to be able to set and get from the access API */
198 typedef struct _Elm_Access_Info Elm_Access_Info;
199
200 /**< accessibility info item */
201 typedef struct _Elm_Access_Item Elm_Access_Item;
202
203 typedef void                  (*Elm_Widget_Text_Set_Cb)(void *data, const char *part, const char *text);
204 typedef void                  (*Elm_Widget_Content_Set_Cb)(void *data, const char *part, Evas_Object *content);
205 typedef const char           *(*Elm_Widget_Text_Get_Cb)(const void *data, const char *part);
206 typedef Evas_Object          *(*Elm_Widget_Content_Get_Cb)(const void *data, const char *part);
207 typedef Evas_Object          *(*Elm_Widget_Content_Unset_Cb)(const void *data, const char *part);
208 typedef void                  (*Elm_Widget_Signal_Emit_Cb)(void *data, const char *emission, const char *source);
209 typedef void                  (*Elm_Widget_Disable_Cb)(void *data);
210 typedef Eina_Bool             (*Elm_Widget_Del_Pre_Cb)(void *data);
211
212 #define ELM_ACCESS_TYPE    0    // when reading out widget or item this is read first
213 #define ELM_ACCESS_INFO    1    // next read is info - this is normally label
214 #define ELM_ACCESS_STATE   2    // if there is a state (eg checkbox) then read state out
215 #define ELM_ACCESS_CONTENT 3    // read ful content - eg all of the label, not a shortened version
216
217 #define ELM_ACCESS_DONE    -1   // sentence done - send done event here
218 #define ELM_ACCESS_CANCEL  -2   // stop reading immediately
219
220 typedef char *(*Elm_Access_Content_Cb)(void *data, Evas_Object *obj, Elm_Widget_Item *item);
221
222 struct _Elm_Access_Item
223 {
224    int                   type;
225    const void           *data;
226    Elm_Access_Content_Cb func;
227 };
228
229 struct _Elm_Access_Info
230 {
231    Eina_List   *items;
232    Ecore_Timer *delay_timer;
233 };
234
235 EAPI void             _elm_access_clear(Elm_Access_Info *ac);
236 EAPI void             _elm_access_text_set(Elm_Access_Info *ac, int type, const char *text);
237 EAPI void             _elm_access_callback_set(Elm_Access_Info *ac, int type, Elm_Access_Content_Cb func, const void *data);
238 EAPI char            *_elm_access_text_get(const Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item); /* this is ok it actually returns a strduped string - it's meant to! */
239 EAPI void             _elm_access_read(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item);
240 EAPI void             _elm_access_say(const char *txt);
241 EAPI Elm_Access_Info *_elm_access_object_get(const Evas_Object *obj);
242 EAPI Elm_Access_Info *_elm_access_item_get(const Elm_Widget_Item *it);
243 EAPI void             _elm_access_object_hilight(Evas_Object *obj);
244 EAPI void             _elm_access_object_unhilight(Evas_Object *obj);
245 EAPI void             _elm_access_object_hilight_disable(Evas *e);
246 EAPI void             _elm_access_object_register(Evas_Object *obj, Evas_Object *hoverobj);
247 EAPI void             _elm_access_item_register(Elm_Widget_Item *item, Evas_Object *hoverobj);
248 EAPI Eina_Bool        _elm_access_2nd_click_timeout(Evas_Object *obj);
249
250 /**< put this as the first member in your widget item struct */
251 #define ELM_WIDGET_ITEM       Elm_Widget_Item base
252
253 struct _Elm_Widget_Item
254 {
255 /* ef1 ~~ efl, el3 ~~ elm */
256 #define ELM_WIDGET_ITEM_MAGIC 0xef1e1301
257    EINA_MAGIC;
258 /* simple accessor macros */
259 #define VIEW(X)   X->base.view
260 #define WIDGET(X) X->base.widget
261    /**< the owner widget that owns this item */
262    Evas_Object                   *widget;
263    /**< the base view object */
264    Evas_Object                   *view;
265    /**< item specific data. used for del callback */
266    const void                    *data;
267    /**< user delete callback function */
268    Evas_Smart_Cb                  del_func;
269    /**< widget delete callback function. don't expose this callback call */
270    Elm_Widget_Del_Pre_Cb          del_pre_func;
271    Eina_List                     *callbacks;
272
273    Elm_Widget_Content_Set_Cb      content_set_func;
274    Elm_Widget_Content_Get_Cb      content_get_func;
275    Elm_Widget_Content_Unset_Cb    content_unset_func;
276    Elm_Widget_Text_Set_Cb         text_set_func;
277    Elm_Widget_Text_Get_Cb         text_get_func;
278    Elm_Widget_Signal_Emit_Cb      signal_emit_func;
279    Elm_Widget_Disable_Cb          disable_func;
280    Elm_Access_Info               *access;
281    const char                    *access_info;
282
283    Eina_Bool                      disabled : 1;
284    Eina_Bool                      walking : 1;
285    Eina_Bool                      delete_me : 1;
286 };
287
288 struct _Elm_Object_Item
289 {
290    ELM_WIDGET_ITEM;
291 };
292
293 #define ELM_NEW(t) calloc(1, sizeof(t))
294
295 EAPI Eina_Bool        elm_widget_api_check(int ver);
296 EAPI Evas_Object     *elm_widget_add(Evas *evas);
297 EAPI void             elm_widget_del_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
298 EAPI void             elm_widget_del_pre_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
299 EAPI void             elm_widget_focus_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
300 EAPI void             elm_widget_activate_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
301 EAPI void             elm_widget_disable_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
302 EAPI void             elm_widget_theme_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
303 EAPI void             elm_widget_translate_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
304 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));
305 EAPI void             elm_widget_changed_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
306 EAPI void             elm_widget_signal_emit_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj, const char *emission, const char *source));
307 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));
308 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));
309 EAPI void             elm_widget_theme(Evas_Object *obj);
310 EAPI void             elm_widget_theme_specific(Evas_Object *obj, Elm_Theme *th, Eina_Bool force);
311 EAPI void             elm_widget_translate(Evas_Object *obj);
312 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));
313 EAPI void             elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func)(void *data, Evas_Object *obj), void *data);
314 EAPI void             elm_widget_on_change_hook_set(Evas_Object *obj, void (*func)(void *data, Evas_Object *obj), void *data);
315 EAPI void             elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func)(void *data, Evas_Object *obj), void *data);
316 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));
317 EAPI void             elm_widget_text_set_hook_set(Evas_Object *obj, Elm_Widget_Text_Set_Cb func);
318 #define elm_widget_text_set_hook_set(obj, func)      elm_widget_text_set_hook_set(obj, (Elm_Widget_Text_Set_Cb)(func))
319 EAPI void             elm_widget_text_get_hook_set(Evas_Object *obj, Elm_Widget_Text_Get_Cb func);
320 #define elm_widget_text_get_hook_set(obj, func)      elm_widget_text_get_hook_set(obj, (Elm_Widget_Text_Get_Cb)(func))
321 EAPI void             elm_widget_content_set_hook_set(Evas_Object *obj, Elm_Widget_Content_Set_Cb func);
322 #define elm_widget_content_set_hook_set(obj, func)   elm_widget_content_set_hook_set(obj, (Elm_Widget_Content_Set_Cb)(func))
323 EAPI void             elm_widget_content_get_hook_set(Evas_Object *obj, Elm_Widget_Content_Get_Cb func);
324 #define elm_widget_content_get_hook_set(obj, func)   elm_widget_content_get_hook_set(obj, (Elm_Widget_Content_Get_Cb)(func))
325 EAPI void             elm_widget_content_unset_hook_set(Evas_Object *obj, Elm_Widget_Content_Unset_Cb func);
326 #define elm_widget_content_unset_hook_set(obj, func) elm_widget_content_unset_hook_set(obj, (Elm_Widget_Content_Unset_Cb)(func))
327 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));
328 EAPI void             elm_widget_data_set(Evas_Object *obj, void *data);
329 EAPI void            *elm_widget_data_get(const Evas_Object *obj);
330 EAPI void             elm_widget_sub_object_add(Evas_Object *obj, Evas_Object *sobj);
331 EAPI void             elm_widget_sub_object_del(Evas_Object *obj, Evas_Object *sobj);
332 EAPI void             elm_widget_resize_object_set(Evas_Object *obj, Evas_Object *sobj);
333 EAPI void             elm_widget_hover_object_set(Evas_Object *obj, Evas_Object *sobj);
334 EAPI void             elm_widget_signal_emit(Evas_Object *obj, const char *emission, const char *source);
335 EAPI void             elm_widget_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data);
336 EAPI void            *elm_widget_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func);
337 EAPI void             elm_widget_can_focus_set(Evas_Object *obj, Eina_Bool can_focus);
338 EAPI Eina_Bool        elm_widget_can_focus_get(const Evas_Object *obj);
339 EAPI Eina_Bool        elm_widget_child_can_focus_get(const Evas_Object *obj);
340 EAPI Eina_List       *elm_widget_can_focus_child_list_get(const Evas_Object *obj);
341 EAPI void             elm_widget_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable);
342 EAPI Eina_Bool        elm_widget_tree_unfocusable_get(const Evas_Object *obj);
343 EAPI void             elm_widget_highlight_ignore_set(Evas_Object *obj, Eina_Bool ignore);
344 EAPI Eina_Bool        elm_widget_highlight_ignore_get(const Evas_Object *obj);
345 EAPI void             elm_widget_highlight_in_theme_set(Evas_Object *obj, Eina_Bool highlight);
346 EAPI Eina_Bool        elm_widget_highlight_in_theme_get(const Evas_Object *obj);
347 EAPI Eina_Bool        elm_widget_focus_get(const Evas_Object *obj);
348 EAPI Evas_Object     *elm_widget_focused_object_get(const Evas_Object *obj);
349 EAPI Evas_Object     *elm_widget_top_get(const Evas_Object *obj);
350 EAPI Eina_Bool        elm_widget_is(const Evas_Object *obj);
351 EAPI Evas_Object     *elm_widget_parent_widget_get(const Evas_Object *obj);
352 EAPI void             elm_widget_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data);
353 EAPI void            *elm_widget_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data);
354 EAPI Eina_Bool        elm_widget_event_propagate(Evas_Object *obj, Evas_Callback_Type type, void *event_info, Evas_Event_Flags *event_flags);
355 EAPI void             elm_widget_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs);
356 EAPI void             elm_widget_focus_custom_chain_unset(Evas_Object *obj);
357 EAPI const Eina_List *elm_widget_focus_custom_chain_get(const Evas_Object *obj);
358 EAPI void             elm_widget_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
359 EAPI void             elm_widget_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child);
360 EAPI void             elm_widget_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir);
361 EAPI void             elm_widget_focus_direction_go(Evas_Object *obj, int x, int y);
362 EAPI Eina_Bool        elm_widget_focus_next_get(const Evas_Object *obj, Elm_Focus_Direction dir, Evas_Object **next);
363 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);
364 EAPI void             elm_widget_focus_set(Evas_Object *obj, int first);
365 EAPI void             elm_widget_focused_object_clear(Evas_Object *obj);
366 EAPI Evas_Object     *elm_widget_parent_get(const Evas_Object *obj);
367 EAPI Evas_Object     *elm_widget_parent2_get(const Evas_Object *obj);
368 EAPI void             elm_widget_parent2_set(Evas_Object *obj, Evas_Object *parent);
369 EAPI void             elm_widget_focus_steal(Evas_Object *obj);
370
371 /**
372  * @internal
373  *
374  * Restore the focus state of the sub-tree.
375  *
376  * This API will restore the focus state of the sub-tree to the latest
377  * state. If a sub-tree is unfocused and wants to get back to the latest
378  * focus state, this API will be helpful.
379  *
380  * @param obj The widget root of sub-tree
381  *
382  * @ingroup Widget
383  */
384 EAPI void             elm_widget_focus_restore(Evas_Object *obj);
385
386 EAPI void             elm_widget_activate(Evas_Object *obj);
387 EAPI void             elm_widget_change(Evas_Object *obj);
388 EAPI void             elm_widget_disabled_set(Evas_Object *obj, Eina_Bool disabled);
389 EAPI Eina_Bool        elm_widget_disabled_get(const Evas_Object *obj);
390 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);
391 EAPI void             elm_widget_show_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
392 EAPI void             elm_widget_focus_region_get(const Evas_Object *obj, Evas_Coord *x, Evas_Coord *y, Evas_Coord *w, Evas_Coord *h);
393 EAPI void             elm_widget_scroll_hold_push(Evas_Object *obj);
394 EAPI void             elm_widget_scroll_hold_pop(Evas_Object *obj);
395 EAPI int              elm_widget_scroll_hold_get(const Evas_Object *obj);
396 EAPI void             elm_widget_scroll_freeze_push(Evas_Object *obj);
397 EAPI void             elm_widget_scroll_freeze_pop(Evas_Object *obj);
398 EAPI int              elm_widget_scroll_freeze_get(const Evas_Object *obj);
399 EAPI void             elm_widget_scale_set(Evas_Object *obj, double scale);
400 EAPI double           elm_widget_scale_get(const Evas_Object *obj);
401 EAPI Eina_Bool        elm_widget_mirrored_get(const Evas_Object *obj);
402 EAPI void             elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
403 EAPI Eina_Bool        elm_widget_mirrored_automatic_get(const Evas_Object *obj);
404 EAPI void             elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
405 EAPI void             elm_widget_theme_set(Evas_Object *obj, Elm_Theme *th);
406 EAPI Elm_Theme       *elm_widget_theme_get(const Evas_Object *obj);
407 EAPI void             elm_widget_style_set(Evas_Object *obj, const char *style);
408 EAPI const char      *elm_widget_style_get(const Evas_Object *obj);
409 EAPI void             elm_widget_type_set(Evas_Object *obj, const char *type);
410 EAPI const char      *elm_widget_type_get(const Evas_Object *obj);
411 EAPI void             elm_widget_tooltip_add(Evas_Object *obj, Elm_Tooltip *tt);
412 EAPI void             elm_widget_tooltip_del(Evas_Object *obj, Elm_Tooltip *tt);
413 EAPI void             elm_widget_cursor_add(Evas_Object *obj, Elm_Cursor *cur);
414 EAPI void             elm_widget_cursor_del(Evas_Object *obj, Elm_Cursor *cur);
415 EAPI void             elm_widget_drag_lock_x_set(Evas_Object *obj, Eina_Bool lock);
416 EAPI void             elm_widget_drag_lock_y_set(Evas_Object *obj, Eina_Bool lock);
417 EAPI Eina_Bool        elm_widget_drag_lock_x_get(const Evas_Object *obj);
418 EAPI Eina_Bool        elm_widget_drag_lock_y_get(const Evas_Object *obj);
419 EAPI int              elm_widget_drag_child_locked_x_get(const Evas_Object *obj);
420 EAPI int              elm_widget_drag_child_locked_y_get(const Evas_Object *obj);
421 EAPI Eina_Bool        elm_widget_theme_object_set(Evas_Object *obj, Evas_Object *edj, const char *wname, const char *welement, const char *wstyle);
422 EAPI void             elm_widget_type_register(const char **ptr);
423 EAPI void             elm_widget_type_unregister(const char **ptr);
424 EAPI Eina_Bool        elm_widget_is_check(const Evas_Object *obj);
425 EAPI Eina_Bool        elm_widget_type_check(const Evas_Object *obj, const char *type, const char *func);
426 EAPI Evas_Object     *elm_widget_name_find(const Evas_Object *obj, const char *name, int recurse);
427 EAPI Eina_List       *elm_widget_stringlist_get(const char *str);
428 EAPI void             elm_widget_stringlist_free(Eina_List *list);
429 EAPI void             elm_widget_focus_hide_handle(Evas_Object *obj);
430 EAPI void             elm_widget_focus_mouse_up_handle(Evas_Object *obj);
431 EAPI void             elm_widget_focus_tree_unfocusable_handle(Evas_Object *obj);
432 EAPI void             elm_widget_focus_disabled_handle(Evas_Object *obj);
433 EAPI unsigned int     elm_widget_focus_order_get(const Evas_Object *obj);
434 EAPI void             elm_widget_text_part_set(Evas_Object *obj, const char *part, const char *label);
435 EAPI const char      *elm_widget_text_part_get(const Evas_Object *obj, const char *part);
436 EAPI void             elm_widget_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
437 EAPI const char      *elm_widget_translatable_text_part_get(const Evas_Object *obj, const char *part);
438 EAPI void             elm_widget_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
439 EAPI Evas_Object     *elm_widget_content_part_get(const Evas_Object *obj, const char *part);
440 EAPI Evas_Object     *elm_widget_content_part_unset(Evas_Object *obj, const char *part);
441 EAPI void             elm_widget_access_info_set(Evas_Object *obj, const char *txt);
442 EAPI const char      *elm_widget_access_info_get(const Evas_Object *obj);
443 EAPI Elm_Widget_Item *_elm_widget_item_new(Evas_Object *parent, size_t alloc_size);
444 EAPI void             _elm_widget_item_free(Elm_Widget_Item *item);
445 EAPI void             _elm_widget_item_del(Elm_Widget_Item *item);
446 EAPI void             _elm_widget_item_pre_notify_del(Elm_Widget_Item *item);
447 EAPI void             _elm_widget_item_del_cb_set(Elm_Widget_Item *item, Evas_Smart_Cb del_cb);
448 EAPI void             _elm_widget_item_data_set(Elm_Widget_Item *item, const void *data);
449 EAPI void            *_elm_widget_item_data_get(const Elm_Widget_Item *item);
450 EAPI void             _elm_widget_item_tooltip_text_set(Elm_Widget_Item *item, const char *text);
451 EAPI void             _elm_widget_item_tooltip_translatable_text_set(Elm_Widget_Item *item, const char *text);
452 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);
453 EAPI void             _elm_widget_item_tooltip_unset(Elm_Widget_Item *item);
454 EAPI void             _elm_widget_item_tooltip_style_set(Elm_Widget_Item *item, const char *style);
455 EAPI Eina_Bool        _elm_widget_item_tooltip_window_mode_set(Elm_Widget_Item *item, Eina_Bool disable);
456 EAPI Eina_Bool        _elm_widget_item_tooltip_window_mode_get(const Elm_Widget_Item *item);
457 EAPI const char      *_elm_widget_item_tooltip_style_get(const Elm_Widget_Item *item);
458 EAPI void             _elm_widget_item_cursor_set(Elm_Widget_Item *item, const char *cursor);
459 EAPI const char      *_elm_widget_item_cursor_get(const Elm_Widget_Item *item);
460 EAPI void             _elm_widget_item_cursor_unset(Elm_Widget_Item *item);
461 EAPI void             _elm_widget_item_cursor_style_set(Elm_Widget_Item *item, const char *style);
462 EAPI const char      *_elm_widget_item_cursor_style_get(const Elm_Widget_Item *item);
463 EAPI void             _elm_widget_item_cursor_engine_only_set(Elm_Widget_Item *item, Eina_Bool engine_only);
464 EAPI Eina_Bool        _elm_widget_item_cursor_engine_only_get(const Elm_Widget_Item *item);
465 EAPI void             _elm_widget_item_content_part_set(Elm_Widget_Item *item, const char *part, Evas_Object *content);
466 EAPI Evas_Object     *_elm_widget_item_content_part_get(const Elm_Widget_Item *item, const char *part);
467 EAPI Evas_Object     *_elm_widget_item_content_part_unset(Elm_Widget_Item *item, const char *part);
468 EAPI void             _elm_widget_item_text_part_set(Elm_Widget_Item *item, const char *part, const char *label);
469 EAPI const char      *_elm_widget_item_text_part_get(const Elm_Widget_Item *item, const char *part);
470 EAPI void             _elm_widget_item_signal_emit(Elm_Widget_Item *item, const char *emission, const char *source);
471 EAPI void             _elm_widget_item_content_set_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Set_Cb func);
472 EAPI void             _elm_widget_item_content_get_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Get_Cb func);
473 EAPI void             _elm_widget_item_content_unset_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Unset_Cb func);
474 EAPI void             _elm_widget_item_text_set_hook_set(Elm_Widget_Item *item, Elm_Widget_Text_Set_Cb func);
475 EAPI void             _elm_widget_item_text_get_hook_set(Elm_Widget_Item *item, Elm_Widget_Text_Get_Cb func);
476 EAPI void             _elm_widget_item_signal_emit_hook_set(Elm_Widget_Item *it, Elm_Widget_Signal_Emit_Cb func);
477 EAPI void             _elm_widget_item_access_info_set(Elm_Widget_Item *item, const char *txt);
478 EAPI void             _elm_widget_item_disabled_set(Elm_Widget_Item *item, Eina_Bool disabled);
479 EAPI Eina_Bool        _elm_widget_item_disabled_get(const Elm_Widget_Item *item);
480 EAPI void             _elm_widget_item_disable_hook_set(Elm_Widget_Item *item, Elm_Widget_Disable_Cb func);
481 EAPI void             _elm_widget_item_del_pre_hook_set(Elm_Widget_Item *item, Elm_Widget_Del_Pre_Cb func);
482 EAPI void             elm_widget_item_smart_callback_add(Elm_Widget_Item *item, const char *event, Elm_Object_Item_Smart_Cb func, const void *data);
483 EAPI void            *elm_widget_item_smart_callback_del(Elm_Widget_Item *item, const char *event, Elm_Object_Item_Smart_Cb func);
484 EAPI void             _elm_widget_item_smart_callback_call(Elm_Widget_Item *item, const char *event, void *event_info);
485
486 /* debug function. don't use it unless you are tracking parenting issues */
487 EAPI void             elm_widget_tree_dump(const Evas_Object *top);
488 EAPI void             elm_widget_tree_dot_dump(const Evas_Object *top, FILE *output);
489
490 /**
491  * Convenience macro to create new widget item, doing casts for you.
492  * @see _elm_widget_item_new()
493  * @param parent a valid elm_widget variant.
494  * @param type the C type that extends Elm_Widget_Item
495  */
496 #define elm_widget_item_new(parent, type) \
497   (type *)_elm_widget_item_new((parent), sizeof(type))
498 /**
499  * Convenience macro to free widget item, doing casts for you.
500  * @see _elm_widget_item_free()
501  * @param item a valid item.
502  */
503 #define elm_widget_item_free(item) \
504   _elm_widget_item_free((Elm_Widget_Item *)item)
505
506 /**
507  * Convenience macro to delete widget item, doing casts for you.
508  * @see _elm_widget_item_del()
509  * @param item a valid item.
510  */
511 #define elm_widget_item_del(item) \
512   _elm_widget_item_del((Elm_Widget_Item *)item)
513 /**
514  * Convenience macro to notify deletion of widget item, doing casts for you.
515  * @see _elm_widget_item_pre_notify_del()
516  */
517 #define elm_widget_item_pre_notify_del(item) \
518   _elm_widget_item_pre_notify_del((Elm_Widget_Item *)item)
519 /**
520  * Convenience macro to set deletion callback of widget item, doing casts for you.
521  * @see _elm_widget_item_del_cb_set()
522  */
523 #define elm_widget_item_del_cb_set(item, del_cb) \
524   _elm_widget_item_del_cb_set((Elm_Widget_Item *)item, del_cb)
525
526 /**
527  * Set item's data
528  * @see _elm_widget_item_data_set()
529  */
530 #define elm_widget_item_data_set(item, data) \
531   _elm_widget_item_data_set((Elm_Widget_Item *)item, data)
532 /**
533  * Get item's data
534  * @see _elm_widget_item_data_get()
535  */
536 #define elm_widget_item_data_get(item) \
537   _elm_widget_item_data_get((const Elm_Widget_Item *)item)
538
539 /**
540  * Convenience function to set widget item tooltip as a text string.
541  * @see _elm_widget_item_tooltip_text_set()
542  */
543 #define elm_widget_item_tooltip_text_set(item, text) \
544   _elm_widget_item_tooltip_text_set((Elm_Widget_Item *)item, text)
545 /**
546  * Convenience function to set widget item tooltip as a text string.
547  * @see _elm_widget_item_tooltip_text_set()
548  */
549 #define elm_widget_item_tooltip_translatable_text_set(item, text) \
550   _elm_widget_item_tooltip_translatable_text_set((Elm_Widget_Item *)item, text)
551 /**
552  * Convenience function to set widget item tooltip.
553  * @see _elm_widget_item_tooltip_content_cb_set()
554  */
555 #define elm_widget_item_tooltip_content_cb_set(item, func, data, del_cb) \
556   _elm_widget_item_tooltip_content_cb_set((Elm_Widget_Item *)item,       \
557                                           func, data, del_cb)
558 /**
559  * Convenience function to unset widget item tooltip.
560  * @see _elm_widget_item_tooltip_unset()
561  */
562 #define elm_widget_item_tooltip_unset(item) \
563   _elm_widget_item_tooltip_unset((Elm_Widget_Item *)item)
564 /**
565  * Convenience function to change item's tooltip style.
566  * @see _elm_widget_item_tooltip_style_set()
567  */
568 #define elm_widget_item_tooltip_style_set(item, style) \
569   _elm_widget_item_tooltip_style_set((Elm_Widget_Item *)item, style)
570
571 #define elm_widget_item_tooltip_window_mode_set(item, disable) \
572   _elm_widget_item_tooltip_window_mode_set((Elm_Widget_Item *)item, disable)
573
574 #define elm_widget_item_tooltip_window_mode_get(item) \
575   _elm_widget_item_tooltip_window_mode_get((Elm_Widget_Item *)item)
576 /**
577  * Convenience function to query item's tooltip style.
578  * @see _elm_widget_item_tooltip_style_get()
579  */
580 #define elm_widget_item_tooltip_style_get(item) \
581   _elm_widget_item_tooltip_style_get((const Elm_Widget_Item *)item)
582 /**
583  * Convenience function to set widget item cursor.
584  * @see _elm_widget_item_cursor_set()
585  */
586 #define elm_widget_item_cursor_set(item, cursor) \
587   _elm_widget_item_cursor_set((Elm_Widget_Item *)item, cursor)
588 /**
589  * Convenience function to get widget item cursor.
590  * @see _elm_widget_item_cursor_get()
591  */
592 #define elm_widget_item_cursor_get(item) \
593   _elm_widget_item_cursor_get((const Elm_Widget_Item *)item)
594 /**
595  * Convenience function to unset widget item cursor.
596  * @see _elm_widget_item_cursor_unset()
597  */
598 #define elm_widget_item_cursor_unset(item) \
599   _elm_widget_item_cursor_unset((Elm_Widget_Item *)item)
600 /**
601  * Convenience function to change item's cursor style.
602  * @see _elm_widget_item_cursor_style_set()
603  */
604 #define elm_widget_item_cursor_style_set(item, style) \
605   _elm_widget_item_cursor_style_set((Elm_Widget_Item *)item, style)
606 /**
607  * Convenience function to query item's cursor style.
608  * @see _elm_widget_item_cursor_style_get()
609  */
610 #define elm_widget_item_cursor_style_get(item) \
611   _elm_widget_item_cursor_style_get((const Elm_Widget_Item *)item)
612 /**
613  * Convenience function to change item's cursor engine_only.
614  * @see _elm_widget_item_cursor_engine_only_set()
615  */
616 #define elm_widget_item_cursor_engine_only_set(item, engine_only) \
617   _elm_widget_item_cursor_engine_only_set((Elm_Widget_Item *)item, engine_only)
618 /**
619  * Convenience function to query item's cursor engine_only.
620  * @see _elm_widget_item_cursor_engine_only_get()
621  */
622 #define elm_widget_item_cursor_engine_only_get(item) \
623   _elm_widget_item_cursor_engine_only_get((const Elm_Widget_Item *)item)
624 /**
625  * Convenience function to query item's content set hook.
626  * @see _elm_widget_item_content_set_hook_set()
627  */
628 #define elm_widget_item_content_set_hook_set(item, func) \
629   _elm_widget_item_content_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Set_Cb)func)
630 /**
631  * Convenience function to query item's content get hook.
632  * @see _elm_widget_item_content_get_hook_set()
633  */
634 #define elm_widget_item_content_get_hook_set(item, func) \
635   _elm_widget_item_content_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Get_Cb)func)
636 /**
637  * Convenience function to query item's content unset hook.
638  * @see _elm_widget_item_content_unset_hook_set()
639  */
640 #define elm_widget_item_content_unset_hook_set(item, func) \
641   _elm_widget_item_content_unset_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Unset_Cb)func)
642 /**
643  * Convenience function to query item's text set hook.
644  * @see _elm_widget_item_text_set_hook_set()
645  */
646 #define elm_widget_item_text_set_hook_set(item, func) \
647   _elm_widget_item_text_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Text_Set_Cb)func)
648 /**
649  * Convenience function to query item's text get hook.
650  * @see _elm_widget_item_text_get_hook_set()
651  */
652 #define elm_widget_item_text_get_hook_set(item, func) \
653   _elm_widget_item_text_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Text_Get_Cb)func)
654 /**
655  * Convenience function to query item's signal emit hook.
656  * @see _elm_widget_item_signal_emit_hook_set()
657  */
658 #define elm_widget_item_signal_emit_hook_set(item, func) \
659   _elm_widget_item_signal_emit_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Signal_Emit_Cb)func)
660 /**
661  * Convenience function to query disable get hook.
662  * @see _elm_widget_item_disabled_get()
663  */
664 #define elm_widget_item_disabled_get(item) \
665   _elm_widget_item_disabled_get((Elm_Widget_Item *)item)
666 /**
667  * Convenience function to query disable set hook.
668  * @see _elm_widget_item_disable_hook_set()
669  */
670 #define elm_widget_item_disable_hook_set(item, func) \
671   _elm_widget_item_disable_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Disable_Cb)func)
672 /**
673  * Convenience function to query del pre hook.
674  * @see _elm_widget_item_del_pre_hook_set()
675  */
676 #define elm_widget_item_del_pre_hook_set(item, func) \
677   _elm_widget_item_del_pre_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Del_Pre_Cb)func)
678 /**
679  * Convenience function to query callback call hook
680  * @see _elm_widget_item_smart_callback_call()
681  */
682 #define elm_widget_item_smart_callback_call(item, event, event_info) \
683   _elm_widget_item_smart_callback_call((Elm_Widget_Item *) item, event, event_info)
684
685 #define ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, ...)              \
686   ELM_WIDGET_ITEM_FREE_OR_RETURN(item, __VA_ARGS__);            \
687   do {                                                          \
688        if (((Elm_Widget_Item *)item)->delete_me) {              \
689             CRITICAL("Elm_Widget_Item " # item " is deleted!"); \
690             return __VA_ARGS__;                                 \
691          }                                                      \
692   } while (0)
693
694 #define ELM_WIDGET_ITEM_CHECK_OR_GOTO(item, label)              \
695   ELM_WIDGET_ITEM_FREE_OR_RETURN(item);                         \
696   do {                                                          \
697        if (((Elm_Widget_Item *)item)->delete_me) {              \
698             CRITICAL("Elm_Widget_Item " # item " is deleted!"); \
699             goto label;                                         \
700          }                                                      \
701   } while (0)
702
703 #define ELM_WIDGET_ITEM_FREE_OR_RETURN(item, ...)               \
704   do {                                                          \
705        if (!EINA_MAGIC_CHECK(item, ELM_WIDGET_ITEM_MAGIC)) {    \
706             EINA_MAGIC_FAIL(item, ELM_WIDGET_ITEM_MAGIC);       \
707             return __VA_ARGS__;                                 \
708          }                                                      \
709   } while (0)
710
711 #define ELM_SET_WIDTYPE(widtype, type)            \
712   do {                                            \
713        if (!widtype) {                            \
714             widtype = eina_stringshare_add(type); \
715             elm_widget_type_register(&widtype);   \
716          }                                        \
717     } while (0)
718
719 #define ELM_CHECK_WID_IS(obj) \
720   if (!elm_widget_is_check(obj)) return
721
722 #define ELM_CHECK_WIDTYPE(obj, widtype) \
723   if (!obj || !elm_widget_type_check((obj), (widtype), __func__)) return
724
725 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, ...)               \
726   ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
727   ELM_CHECK_WIDTYPE(it->base.widget, widtype) __VA_ARGS__;
728
729 #define ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(it, label)       \
730   ELM_WIDGET_ITEM_CHECK_OR_GOTO((Elm_Widget_Item *)it, label); \
731   if (!elm_widget_type_check((it->base.widget), (widtype), __func__)) goto label;
732
733 #define ELM_WIDGET_STANDARD_SETUP(wdat, wdtype, par, evas, ob, ret)        \
734   do {                                                                     \
735        EINA_SAFETY_ON_NULL_RETURN_VAL((par), (ret));                       \
736        evas = evas_object_evas_get(par); if (!(evas)) return (ret);        \
737        wdat = ELM_NEW(wdtype); if (!(wdat)) return (ret);                  \
738        ob = elm_widget_add(evas); if (!(ob)) { free(wdat); return (ret); } \
739     } while (0)
740
741 #define ELM_OBJ_ITEM_CHECK_OR_RETURN(it, ...) \
742    ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, __VA_ARGS__);
743
744 #define ELM_OBJ_ITEM_CHECK_OR_GOTO(it, label)      \
745   ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(it, label);
746
747 /**
748  * The drag and drop API.
749  * Currently experimental, and will change when it does dynamic type
750  * addition RSN.
751  *
752  * Here so applications can start to use it, if they ask elm nicely.
753  *
754  * And yes, elm_widget, should probably be elm_experimental...
755  * Complaints about this code should go to /dev/null, or failing that nash.
756  */
757 Eina_Bool elm_selection_selection_has_owner(void);
758 Eina_Bool elm_drop_target_add(Evas_Object *widget, Elm_Sel_Type, Elm_Drop_Cb, void *);
759 Eina_Bool elm_drop_target_del(Evas_Object *widget);
760 Eina_Bool elm_drag_start(Evas_Object *, Elm_Sel_Format, const char *, void (*)(void *, Evas_Object *), void *);
761
762 #endif