elm_list.h: added documentations for label parameter of item insertion.

The label parameter is copied inside the list. So if an application dynamically
allocated the label, the application should free the label after tem insertion
call.
This commit is contained in:
Daniel Juyung Seo 2013-04-18 02:50:39 +09:00
parent fbdd64e1cb
commit 22841e0c11
1 changed files with 20 additions and 0 deletions

View File

@ -667,6 +667,10 @@ EAPI Elm_Object_Select_Mode elm_list_select_mode_get(const Evas_Object *ob
* If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
*
* @note Remember that the label parameter is copied inside the list. So if an
* application dynamically allocated the label, the application should free the
* label after this call.
*
* Simple example (with no function callback or data associated):
* @code
* li = elm_list_add(win);
@ -718,6 +722,10 @@ EAPI Elm_Object_Item *elm_list_item_append(Evas_Object *obj, const
* If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
*
* @note Remember that the label parameter is copied inside the list. So if an
* application dynamically allocated the label, the application should free the
* label after this call.
*
* @see elm_list_item_append() for a simple code example.
* @see elm_list_select_mode_set()
* @see elm_object_item_del()
@ -760,6 +768,10 @@ EAPI Elm_Object_Item *elm_list_item_prepend(Evas_Object *obj, cons
* If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
*
* @note Remember that the label parameter is copied inside the list. So if an
* application dynamically allocated the label, the application should free the
* label after this call.
*
* @see elm_list_item_append() for a simple code example.
* @see elm_list_select_mode_set()
* @see elm_object_item_del()
@ -802,6 +814,10 @@ EAPI Elm_Object_Item *elm_list_item_insert_before(Evas_Object *obj
* If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
*
* @note Remember that the label parameter is copied inside the list. So if an
* application dynamically allocated the label, the application should free the
* label after this call.
*
* @see elm_list_item_append() for a simple code example.
* @see elm_list_select_mode_set()
* @see elm_object_item_del()
@ -852,6 +868,10 @@ EAPI Elm_Object_Item *elm_list_item_insert_after(Evas_Object *obj,
* If such function isn't needed, just passing
* @c NULL as @p func is enough. The same should be done for @p data.
*
* @note Remember that the label parameter is copied inside the list. So if an
* application dynamically allocated the label, the application should free the
* label after this call.
*
* @see elm_list_item_append() for a simple code example.
* @see elm_list_select_mode_set()
* @see elm_object_item_del()