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