forked from enlightenment/efl
elm gengrid,list,menu,segment_control,toolbar.h: updated documentation with regarding to elm_xxx_item_object_get().
More informative documentation about the returned actual object by elm_xxx_item_object_get().
This commit is contained in:
parent
554b936d07
commit
7d0dcd5c12
|
@ -176,11 +176,7 @@
|
|||
* @c event_info parameter is the gengrid item that was unselected.
|
||||
* - @c "realized" - This is called when the item in the gengrid
|
||||
* has its implementing Evas object instantiated, de facto. @c
|
||||
* event_info is the gengrid item that was created. The object
|
||||
* may be deleted at any time, so it is highly advised to the
|
||||
* caller @b not to use the object pointer returned from
|
||||
* elm_gengrid_item_object_get(), because it may point to freed
|
||||
* objects.
|
||||
* event_info is the gengrid item that was created.
|
||||
* - @c "unrealized" - This is called when the implementing Evas
|
||||
* object for this item is deleted. @c event_info is the gengrid
|
||||
* item that was deleted.
|
||||
|
|
|
@ -1020,10 +1020,11 @@ EAPI void elm_list_item_show(Elm_Object_Item *it);
|
|||
EAPI void elm_list_item_bring_in(Elm_Object_Item *it);
|
||||
|
||||
/**
|
||||
* Gets the base object of the item.
|
||||
* Get the real Evas(Edje) object created to implement the view of a given
|
||||
* list @p item.
|
||||
*
|
||||
* @param it The list item
|
||||
* @return The base object associated with @p item
|
||||
* @return The base Edje object associated with @p it.
|
||||
*
|
||||
* Base object is the @c Evas_Object that represents that item.
|
||||
*
|
||||
|
|
|
@ -228,10 +228,12 @@ EAPI void elm_menu_close(Evas_Object *obj);
|
|||
EAPI const Eina_List *elm_menu_items_get(const Evas_Object *obj);
|
||||
|
||||
/**
|
||||
* @brief Get the Evas_Object of an Elm_Object_Item
|
||||
* Get the real Evas(Edje) object created to implement the view of a given
|
||||
* menu @p item.
|
||||
*
|
||||
* @param it The menu item object.
|
||||
* @return The edje object containing the swallowed content
|
||||
* @param it The menu item.
|
||||
* @return The base Edje object containing the swallowed content associated with
|
||||
* @p it.
|
||||
*
|
||||
* @warning Don't manipulate this object!
|
||||
*
|
||||
|
|
|
@ -370,10 +370,11 @@ EAPI Evas_Object *elm_segment_control_item_icon_get(const Evas_Object *obj,
|
|||
EAPI int elm_segment_control_item_index_get(const Elm_Object_Item *it);
|
||||
|
||||
/**
|
||||
* Get the base object of the item.
|
||||
* Get the real Evas(Edje) object created to implement the view of a given
|
||||
* segment_control @p item.
|
||||
*
|
||||
* @param it The segment control item.
|
||||
* @return The base object associated with @p it.
|
||||
* @return The base Edje object associated with @p it.
|
||||
*
|
||||
* Base object is the @c Evas_Object that represents that item.
|
||||
*
|
||||
|
|
|
@ -513,10 +513,11 @@ EAPI void elm_toolbar_item_icon_set(Elm_Object_Item *it,
|
|||
EAPI const char *elm_toolbar_item_icon_get(const Elm_Object_Item *it);
|
||||
|
||||
/**
|
||||
* Get the object of @p item.
|
||||
* Get the real Evas(Edje) object created to implement the view of a given
|
||||
* toolbar @p item.
|
||||
*
|
||||
* @param it The toolbar item.
|
||||
* @return The object
|
||||
* @return The base Edje object associated with @p it.
|
||||
*
|
||||
* @ingroup Toolbar
|
||||
*/
|
||||
|
|
Loading…
Reference in New Issue