3d, gesturelayer, index, naviframe, transit, fileselector, frame, glview, layout...

[framework/uifw/elementary.git] / src / lib / elc_naviframe.h

diff --git a/src/lib/elc_naviframe.h b/src/lib/elc_naviframe.h
index d51f9e4..d43d209 100644 (file)
--- a/src/lib/elc_naviframe.h
+++ b/src/lib/elc_naviframe.h
@@ -6,7 +6,7 @@
  *
  * Naviframe provides functions to switch different pages with stack
  * mechanism. It means if one page(item) needs to be changed to the new one,
- * then naviframe would push the new page to it's internal stack. Of course,
+ * then naviframe would push the new page to its internal stack. Of course,
  * it can be back to the previous page by popping the top page. Naviframe
  * provides some transition effect while the pages are switching (same as
  * pager).
@@ -26,11 +26,16 @@
  * @li "default" - Title label in the title area of the current page
  * @li "subtitle" - Sub-title label in the title area of the current page
  *
- * Signals that you can add callback for are:
+ * Signals that you can add callbacks for are:
  * @li "transition,finished" - When the transition is finished in changing the
  * item
  * @li "title,clicked" - User clicked title area
  *
+ * Item Signals that you can add callbacks for are:
+ * @li "show,begin" - When the item is started to be top item.
+ * @li "hide,finished" - When a new top item is finished to push onto the
+ * item.
+ *
  * Default content parts of the naviframe items that you can use content hooks
  * for are:
  * @li "default" - The main content of the page
@@ -108,6 +113,7 @@ EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *titl
 /**
  * @brief Insert a new item into the naviframe before item @p before.
  *
+ * @param obj The naviframe object
  * @param before The naviframe item to insert before.
  * @param title_label The label in the title area. The name of the title
  *        label part is "elm.text.title"
@@ -134,11 +140,12 @@ EAPI Elm_Object_Item *elm_naviframe_item_push(Evas_Object *obj, const char *titl
  *
  * @ingroup Naviframe
  */
-EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style);
+EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Evas_Object *obj, Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style);
 
 /**
  * @brief Insert a new item into the naviframe after item @p after.
  *
+ * @param obj The naviframe object
  * @param after The naviframe item to insert after.
  * @param title_label The label in the title area. The name of the title
  *        label part is "elm.text.title"
@@ -165,7 +172,7 @@ EAPI Elm_Object_Item *elm_naviframe_item_insert_before(Elm_Object_Item *before,
  *
  * @ingroup Naviframe
  */
-EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style);
+EAPI Elm_Object_Item *elm_naviframe_item_insert_after(Evas_Object *obj, Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style);
 
 /**
  * @brief Pop an item that is on top of the stack
@@ -339,6 +346,7 @@ EAPI Eina_Bool        elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *
  * @param obj The naviframe object
  * @return An Eina_List of naviframe items, #Elm_Object_Item,
  * or @c NULL on failure.
+ * @note The returned list MUST be freed.
  *
  * @ingroup Naviframe
  */
@@ -378,30 +386,6 @@ EAPI void             elm_naviframe_event_enabled_set(Evas_Object *obj, Eina_Boo
 EAPI Eina_Bool        elm_naviframe_event_enabled_get(const Evas_Object *obj);
 
 /**
- * @brief Set the default item style.
- *
- * Default item style will be used with items who's style is NULL
- *
- * @param obj The naviframe object
- * @param style The style
- *
- * @ingroup Naviframe
- */
-EAPI void             elm_naviframe_item_style_default_set(Evas_Object *obj, const char *style);
-
-/**
- * @brief Get the default item style
- *
- * @param obj The naviframe object
- * @return the default item style
- *
- * @see elm_naviframe_item_style_default_set()
- *
- * @ingroup Naviframe
- */
-EAPI const char      *elm_naviframe_item_style_default_get(const Evas_Object *obj);
-
-/**
  * @brief Simple version of item_push.
  *
  * @see elm_naviframe_item_push