make sure to pass const to these funcs when getting.
[framework/uifw/elementary.git] / src / lib / elm_widget.h
index ff48025..ccba907 100644 (file)
 
 typedef struct _Elm_Tooltip     Elm_Tooltip;
 typedef struct _Elm_Cursor      Elm_Cursor;
-typedef struct _Elm_Widget_Item Elm_Widget_Item; /**< base structure for all widget items that are not Elm_Widget themselves */
 
-typedef struct _Elm_Access_Info Elm_Access_Info; /**< accessibility information to be able to set and get from the access API */
-typedef struct _Elm_Access_Item Elm_Access_Item; /**< accessibility info item */
+/**< base structure for all widget items that are not Elm_Widget themselves */
+typedef struct _Elm_Widget_Item Elm_Widget_Item;
 
-typedef void                  (*Elm_Widget_On_Text_Set_Cb)(void *data, const char *part, const char *text);
-typedef void                  (*Elm_Widget_On_Content_Set_Cb)(void *data, const char *part, Evas_Object *content);
-typedef const char           *(*Elm_Widget_On_Text_Get_Cb)(const void *data, const char *part);
-typedef Evas_Object          *(*Elm_Widget_On_Content_Get_Cb)(const void *data, const char *part);
-typedef Evas_Object          *(*Elm_Widget_On_Content_Unset_Cb)(const void *data, const char *part);
-typedef void                  (*Elm_Widget_On_Signal_Emit_Cb)(void *data, const char *emission, const char *source);
-typedef void                  (*Elm_Widget_On_Disable_Set_Cb)(void *data);
+/**< accessibility information to be able to set and get from the access API */
+typedef struct _Elm_Access_Info Elm_Access_Info;
+
+/**< accessibility info item */
+typedef struct _Elm_Access_Item Elm_Access_Item;
+
+typedef void                  (*Elm_Widget_Text_Set_Cb)(void *data, const char *part, const char *text);
+typedef void                  (*Elm_Widget_Content_Set_Cb)(void *data, const char *part, Evas_Object *content);
+typedef const char           *(*Elm_Widget_Text_Get_Cb)(const void *data, const char *part);
+typedef Evas_Object          *(*Elm_Widget_Content_Get_Cb)(const void *data, const char *part);
+typedef Evas_Object          *(*Elm_Widget_Content_Unset_Cb)(const void *data, const char *part);
+typedef void                  (*Elm_Widget_Signal_Emit_Cb)(void *data, const char *emission, const char *source);
+typedef void                  (*Elm_Widget_Disable_Cb)(void *data);
+typedef Eina_Bool             (*Elm_Widget_Del_Pre_Cb)(void *data);
 
 #define ELM_ACCESS_TYPE    0    // when reading out widget or item this is read first
 #define ELM_ACCESS_INFO    1    // next read is info - this is normally label
@@ -229,11 +235,11 @@ struct _Elm_Access_Info
 EAPI void             _elm_access_clear(Elm_Access_Info *ac);
 EAPI void             _elm_access_text_set(Elm_Access_Info *ac, int type, const char *text);
 EAPI void             _elm_access_callback_set(Elm_Access_Info *ac, int type, Elm_Access_Content_Cb func, const void *data);
-EAPI char            *_elm_access_text_get(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item);
+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! */
 EAPI void             _elm_access_read(Elm_Access_Info *ac, int type, Evas_Object *obj, Elm_Widget_Item *item);
 EAPI void             _elm_access_say(const char *txt);
-EAPI Elm_Access_Info *_elm_access_object_get(Evas_Object *obj);
-EAPI Elm_Access_Info *_elm_access_item_get(Elm_Widget_Item *it);
+EAPI Elm_Access_Info *_elm_access_object_get(const Evas_Object *obj);
+EAPI Elm_Access_Info *_elm_access_item_get(const Elm_Widget_Item *it);
 EAPI void             _elm_access_object_hilight(Evas_Object *obj);
 EAPI void             _elm_access_object_unhilight(Evas_Object *obj);
 EAPI void             _elm_access_object_hilight_disable(Evas *e);
@@ -241,27 +247,35 @@ EAPI void             _elm_access_object_register(Evas_Object *obj, Evas_Object
 EAPI void             _elm_access_item_register(Elm_Widget_Item *item, Evas_Object *hoverobj);
 EAPI Eina_Bool        _elm_access_2nd_click_timeout(Evas_Object *obj);
 
-#define ELM_WIDGET_ITEM       Elm_Widget_Item base /**< put this as the first member in your widget item struct */
+/**< put this as the first member in your widget item struct */
+#define ELM_WIDGET_ITEM       Elm_Widget_Item base
+
 struct _Elm_Widget_Item
 {
-   /* ef1 ~~ efl, el3 ~~ elm */
+/* ef1 ~~ efl, el3 ~~ elm */
 #define ELM_WIDGET_ITEM_MAGIC 0xef1e1301
    EINA_MAGIC;
-
 /* simple accessor macros */
 #define VIEW(X)   X->base.view
 #define WIDGET(X) X->base.widget
-   Evas_Object                   *widget; /**< the owner widget that owns this item */
-   Evas_Object                   *view; /**< the base view object */
-   const void                    *data; /**< item specific data */
-   Evas_Smart_Cb                  del_cb; /**< used to notify the item is being deleted */
-   Elm_Widget_On_Content_Set_Cb   on_content_set_func;
-   Elm_Widget_On_Content_Get_Cb   on_content_get_func;
-   Elm_Widget_On_Content_Unset_Cb on_content_unset_func;
-   Elm_Widget_On_Text_Set_Cb      on_text_set_func;
-   Elm_Widget_On_Text_Get_Cb      on_text_get_func;
-   Elm_Widget_On_Signal_Emit_Cb   on_signal_emit_func;
-   Elm_Widget_On_Disable_Set_Cb   disable_func;
+   /**< the owner widget that owns this item */
+   Evas_Object                   *widget;
+   /**< the base view object */
+   Evas_Object                   *view;
+   /**< item specific data. used for del callback */
+   const void                    *data;
+   /**< user delete callback function */
+   Evas_Smart_Cb                  del_func;
+   /**< widget delete callback function. don't expose this callback call */
+   Elm_Widget_Del_Pre_Cb          del_pre_func;
+
+   Elm_Widget_Content_Set_Cb      content_set_func;
+   Elm_Widget_Content_Get_Cb      content_get_func;
+   Elm_Widget_Content_Unset_Cb    content_unset_func;
+   Elm_Widget_Text_Set_Cb         text_set_func;
+   Elm_Widget_Text_Get_Cb         text_get_func;
+   Elm_Widget_Signal_Emit_Cb      signal_emit_func;
+   Elm_Widget_Disable_Cb          disable_func;
    Elm_Access_Info               *access;
    const char                    *access_info;
    Eina_Bool                      disabled : 1;
@@ -276,10 +290,6 @@ struct _Elm_Object_Item
 
 #define ELM_NEW(t) calloc(1, sizeof(t))
 
-#define ELM_OBJ_ITEM_CHECK_OR_RETURN(it, ...)                            \
-  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)(it), __VA_ARGS__); \
-  ELM_CHECK_WIDTYPE(it->base.widget, widtype) __VA_ARGS__;
-
 EAPI Eina_Bool        elm_widget_api_check(int ver);
 EAPI Evas_Object     *elm_widget_add(Evas *evas);
 EAPI void             elm_widget_del_hook_set(Evas_Object *obj, void (*func)(Evas_Object *obj));
@@ -302,16 +312,16 @@ EAPI void             elm_widget_on_focus_hook_set(Evas_Object *obj, void (*func
 EAPI void             elm_widget_on_change_hook_set(Evas_Object *obj, void (*func)(void *data, Evas_Object *obj), void *data);
 EAPI void             elm_widget_on_show_region_hook_set(Evas_Object *obj, void (*func)(void *data, Evas_Object *obj), void *data);
 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));
-EAPI void             elm_widget_text_set_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Set_Cb func);
-#define elm_widget_text_set_hook_set(obj, func)      elm_widget_text_set_hook_set(obj, (Elm_Widget_On_Text_Set_Cb)(func))
-EAPI void             elm_widget_text_get_hook_set(Evas_Object *obj, Elm_Widget_On_Text_Get_Cb func);
-#define elm_widget_text_get_hook_set(obj, func)      elm_widget_text_get_hook_set(obj, (Elm_Widget_On_Text_Get_Cb)(func))
-EAPI void             elm_widget_content_set_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Set_Cb func);
-#define elm_widget_content_set_hook_set(obj, func)   elm_widget_content_set_hook_set(obj, (Elm_Widget_On_Content_Set_Cb)(func))
-EAPI void             elm_widget_content_get_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Get_Cb func);
-#define elm_widget_content_get_hook_set(obj, func)   elm_widget_content_get_hook_set(obj, (Elm_Widget_On_Content_Get_Cb)(func))
-EAPI void             elm_widget_content_unset_hook_set(Evas_Object *obj, Elm_Widget_On_Content_Unset_Cb func);
-#define elm_widget_content_unset_hook_set(obj, func) elm_widget_content_unset_hook_set(obj, (Elm_Widget_On_Content_Unset_Cb)(func))
+EAPI void             elm_widget_text_set_hook_set(Evas_Object *obj, Elm_Widget_Text_Set_Cb func);
+#define elm_widget_text_set_hook_set(obj, func)      elm_widget_text_set_hook_set(obj, (Elm_Widget_Text_Set_Cb)(func))
+EAPI void             elm_widget_text_get_hook_set(Evas_Object *obj, Elm_Widget_Text_Get_Cb func);
+#define elm_widget_text_get_hook_set(obj, func)      elm_widget_text_get_hook_set(obj, (Elm_Widget_Text_Get_Cb)(func))
+EAPI void             elm_widget_content_set_hook_set(Evas_Object *obj, Elm_Widget_Content_Set_Cb func);
+#define elm_widget_content_set_hook_set(obj, func)   elm_widget_content_set_hook_set(obj, (Elm_Widget_Content_Set_Cb)(func))
+EAPI void             elm_widget_content_get_hook_set(Evas_Object *obj, Elm_Widget_Content_Get_Cb func);
+#define elm_widget_content_get_hook_set(obj, func)   elm_widget_content_get_hook_set(obj, (Elm_Widget_Content_Get_Cb)(func))
+EAPI void             elm_widget_content_unset_hook_set(Evas_Object *obj, Elm_Widget_Content_Unset_Cb func);
+#define elm_widget_content_unset_hook_set(obj, func) elm_widget_content_unset_hook_set(obj, (Elm_Widget_Content_Unset_Cb)(func))
 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));
 EAPI void             elm_widget_data_set(Evas_Object *obj, void *data);
 EAPI void            *elm_widget_data_get(const Evas_Object *obj);
@@ -361,8 +371,8 @@ EAPI void             elm_widget_focus_steal(Evas_Object *obj);
  *
  * Restore the focus state of the sub-tree.
  *
- * This API will restore the focus state of the sub-tree to the lastest
- * state. If a sub-tree is unfocused and wants to get back to the lastest
+ * This API will restore the focus state of the sub-tree to the latest
+ * state. If a sub-tree is unfocused and wants to get back to the latest
  * focus state, this API will be helpful.
  *
  * @param obj The widget root of sub-tree
@@ -386,12 +396,10 @@ EAPI void             elm_widget_scroll_freeze_pop(Evas_Object *obj);
 EAPI int              elm_widget_scroll_freeze_get(const Evas_Object *obj);
 EAPI void             elm_widget_scale_set(Evas_Object *obj, double scale);
 EAPI double           elm_widget_scale_get(const Evas_Object *obj);
-EAPI Eina_Bool
-                      elm_widget_mirrored_get(const Evas_Object *obj)
-EINA_ARG_NONNULL(1);
-EAPI void             elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
-EAPI Eina_Bool        elm_widget_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
-EAPI void             elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
+EAPI Eina_Bool        elm_widget_mirrored_get(const Evas_Object *obj);
+EAPI void             elm_widget_mirrored_set(Evas_Object *obj, Eina_Bool mirrored);
+EAPI Eina_Bool        elm_widget_mirrored_automatic_get(const Evas_Object *obj);
+EAPI void             elm_widget_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic);
 EAPI void             elm_widget_theme_set(Evas_Object *obj, Elm_Theme *th);
 EAPI Elm_Theme       *elm_widget_theme_get(const Evas_Object *obj);
 EAPI void             elm_widget_style_set(Evas_Object *obj, const char *style);
@@ -428,8 +436,9 @@ EAPI void             elm_widget_content_part_set(Evas_Object *obj, const char *
 EAPI Evas_Object     *elm_widget_content_part_get(const Evas_Object *obj, const char *part);
 EAPI Evas_Object     *elm_widget_content_part_unset(Evas_Object *obj, const char *part);
 EAPI void             elm_widget_access_info_set(Evas_Object *obj, const char *txt);
-EAPI const char      *elm_widget_access_info_get(Evas_Object *obj);
+EAPI const char      *elm_widget_access_info_get(const Evas_Object *obj);
 EAPI Elm_Widget_Item *_elm_widget_item_new(Evas_Object *parent, size_t alloc_size);
+EAPI void             _elm_widget_item_free(Elm_Widget_Item *item);
 EAPI void             _elm_widget_item_del(Elm_Widget_Item *item);
 EAPI void             _elm_widget_item_pre_notify_del(Elm_Widget_Item *item);
 EAPI void             _elm_widget_item_del_cb_set(Elm_Widget_Item *item, Evas_Smart_Cb del_cb);
@@ -456,16 +465,17 @@ EAPI Evas_Object     *_elm_widget_item_content_part_unset(Elm_Widget_Item *item,
 EAPI void             _elm_widget_item_text_part_set(Elm_Widget_Item *item, const char *part, const char *label);
 EAPI const char      *_elm_widget_item_text_part_get(const Elm_Widget_Item *item, const char *part);
 EAPI void             _elm_widget_item_signal_emit(Elm_Widget_Item *item, const char *emission, const char *source);
-EAPI void             _elm_widget_item_content_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Set_Cb func);
-EAPI void             _elm_widget_item_content_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Get_Cb func);
-EAPI void             _elm_widget_item_content_unset_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Content_Unset_Cb func);
-EAPI void             _elm_widget_item_text_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Set_Cb func);
-EAPI void             _elm_widget_item_text_get_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Text_Get_Cb func);
-EAPI void             _elm_widget_item_signal_emit_hook_set(Elm_Widget_Item *it, Elm_Widget_On_Signal_Emit_Cb func);
+EAPI void             _elm_widget_item_content_set_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Set_Cb func);
+EAPI void             _elm_widget_item_content_get_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Get_Cb func);
+EAPI void             _elm_widget_item_content_unset_hook_set(Elm_Widget_Item *item, Elm_Widget_Content_Unset_Cb func);
+EAPI void             _elm_widget_item_text_set_hook_set(Elm_Widget_Item *item, Elm_Widget_Text_Set_Cb func);
+EAPI void             _elm_widget_item_text_get_hook_set(Elm_Widget_Item *item, Elm_Widget_Text_Get_Cb func);
+EAPI void             _elm_widget_item_signal_emit_hook_set(Elm_Widget_Item *it, Elm_Widget_Signal_Emit_Cb func);
 EAPI void             _elm_widget_item_access_info_set(Elm_Widget_Item *item, const char *txt);
 EAPI void             _elm_widget_item_disabled_set(Elm_Widget_Item *item, Eina_Bool disabled);
 EAPI Eina_Bool        _elm_widget_item_disabled_get(const Elm_Widget_Item *item);
-EAPI void             _elm_widget_item_disable_set_hook_set(Elm_Widget_Item *item, Elm_Widget_On_Disable_Set_Cb func);
+EAPI void             _elm_widget_item_disable_hook_set(Elm_Widget_Item *item, Elm_Widget_Disable_Cb func);
+EAPI void             _elm_widget_item_del_pre_hook_set(Elm_Widget_Item *item, Elm_Widget_Del_Pre_Cb func);
 
 /* debug function. don't use it unless you are tracking parenting issues */
 EAPI void             elm_widget_tree_dump(const Evas_Object *top);
@@ -480,6 +490,14 @@ EAPI void             elm_widget_tree_dot_dump(const Evas_Object *top, FILE *out
 #define elm_widget_item_new(parent, type) \
   (type *)_elm_widget_item_new((parent), sizeof(type))
 /**
+ * Convenience macro to free widget item, doing casts for you.
+ * @see _elm_widget_item_free()
+ * @param item a valid item.
+ */
+#define elm_widget_item_free(item) \
+  _elm_widget_item_free((Elm_Widget_Item *)item)
+
+/**
  * Convenience macro to delete widget item, doing casts for you.
  * @see _elm_widget_item_del()
  * @param item a valid item.
@@ -602,52 +620,55 @@ EAPI void             elm_widget_tree_dot_dump(const Evas_Object *top, FILE *out
  * @see _elm_widget_item_content_set_hook_set()
  */
 #define elm_widget_item_content_set_hook_set(item, func) \
-  _elm_widget_item_content_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Set_Cb)func)
+  _elm_widget_item_content_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Set_Cb)func)
 /**
  * Convenience function to query item's content get hook.
  * @see _elm_widget_item_content_get_hook_set()
  */
 #define elm_widget_item_content_get_hook_set(item, func) \
-  _elm_widget_item_content_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Get_Cb)func)
+  _elm_widget_item_content_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Get_Cb)func)
 /**
  * Convenience function to query item's content unset hook.
  * @see _elm_widget_item_content_unset_hook_set()
  */
 #define elm_widget_item_content_unset_hook_set(item, func) \
-  _elm_widget_item_content_unset_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Content_Unset_Cb)func)
+  _elm_widget_item_content_unset_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Content_Unset_Cb)func)
 /**
  * Convenience function to query item's text set hook.
  * @see _elm_widget_item_text_set_hook_set()
  */
 #define elm_widget_item_text_set_hook_set(item, func) \
-  _elm_widget_item_text_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Set_Cb)func)
+  _elm_widget_item_text_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Text_Set_Cb)func)
 /**
  * Convenience function to query item's text get hook.
  * @see _elm_widget_item_text_get_hook_set()
  */
 #define elm_widget_item_text_get_hook_set(item, func) \
-  _elm_widget_item_text_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Text_Get_Cb)func)
+  _elm_widget_item_text_get_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Text_Get_Cb)func)
 /**
  * Convenience function to query item's signal emit hook.
  * @see _elm_widget_item_signal_emit_hook_set()
  */
 #define elm_widget_item_signal_emit_hook_set(item, func) \
-  _elm_widget_item_signal_emit_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Signal_Emit_Cb)func)
+  _elm_widget_item_signal_emit_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Signal_Emit_Cb)func)
 /**
  * Convenience function to query disable get hook.
  * @see _elm_widget_item_disabled_get()
  */
 #define elm_widget_item_disabled_get(item) \
   _elm_widget_item_disabled_get((Elm_Widget_Item *)item)
-
-EAPI Eina_Bool _elm_widget_item_disabled_get(const Elm_Widget_Item *item);
-
 /**
  * Convenience function to query disable set hook.
- * @see _elm_widget_item_disable_set_hook_set()
+ * @see _elm_widget_item_disable_hook_set()
  */
-#define elm_widget_item_disable_set_hook_set(item, func) \
-  _elm_widget_item_disable_set_hook_set((Elm_Widget_Item *)item, (Elm_Widget_On_Disable_Set_Cb)func)
+#define elm_widget_item_disable_hook_set(item, func) \
+  _elm_widget_item_disable_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Disable_Cb)func)
+/**
+ * Convenience function to query del pre hook.
+ * @see _elm_widget_item_del_pre_hook_set()
+ */
+#define elm_widget_item_del_pre_hook_set(item, func) \
+  _elm_widget_item_del_pre_hook_set((Elm_Widget_Item *)item, (Elm_Widget_Del_Pre_Cb)func)
 
 #define ELM_WIDGET_ITEM_CHECK_OR_RETURN(item, ...)           \
   do {                                                       \
@@ -703,6 +724,12 @@ EAPI Eina_Bool _elm_widget_item_disabled_get(const Elm_Widget_Item *item);
        ob = elm_widget_add(evas); if (!(ob)) { free(wdat); return (ret); } \
     } while (0)
 
+#define ELM_OBJ_ITEM_CHECK_OR_RETURN(it, ...) \
+   ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(it, __VA_ARGS__);
+
+#define ELM_OBJ_ITEM_CHECK_OR_GOTO(it, label)      \
+  ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_GOTO(it, label);
+
 /**
  * The drag and drop API.
  * Currently experimental, and will change when it does dynamic type