From c0bbc38df9237ec76ed563165c2816b3f02bd829 Mon Sep 17 00:00:00 2001 From: Daniel Juyung Seo Date: Mon, 11 Mar 2013 20:52:57 +0900 Subject: [PATCH] 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(). --- src/lib/elm_gengrid.h | 6 +----- src/lib/elm_list.h | 5 +++-- src/lib/elm_menu.h | 8 +++++--- src/lib/elm_segment_control.h | 5 +++-- src/lib/elm_toolbar.h | 5 +++-- 5 files changed, 15 insertions(+), 14 deletions(-) diff --git a/src/lib/elm_gengrid.h b/src/lib/elm_gengrid.h index 8b95ce8..b7aef75 100644 --- a/src/lib/elm_gengrid.h +++ b/src/lib/elm_gengrid.h @@ -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. diff --git a/src/lib/elm_list.h b/src/lib/elm_list.h index f002217..9afcf50 100644 --- a/src/lib/elm_list.h +++ b/src/lib/elm_list.h @@ -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. * diff --git a/src/lib/elm_menu.h b/src/lib/elm_menu.h index 323655d..46a18f5 100644 --- a/src/lib/elm_menu.h +++ b/src/lib/elm_menu.h @@ -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! * diff --git a/src/lib/elm_segment_control.h b/src/lib/elm_segment_control.h index 7cebe62..55afe60 100644 --- a/src/lib/elm_segment_control.h +++ b/src/lib/elm_segment_control.h @@ -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. * diff --git a/src/lib/elm_toolbar.h b/src/lib/elm_toolbar.h index 4b1011b..47f44bd 100644 --- a/src/lib/elm_toolbar.h +++ b/src/lib/elm_toolbar.h @@ -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 */ -- 2.7.4