*
* 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).
* Since each item could keep the different styles, users could keep the
* same look & feel for the pages or different styles for the items in it's
* application.
- *
- * Default content parts of the naviframe that you can use content hooks for are:
+ *
+ * Default content parts of the naviframe that you can use content hooks for
+ * are:
* @li "default" - The main content of the current page
- *
- * Signals that you can add callback for are:
- * @li "transition,finished" - When the transition is finished in changing
- * the item
+ * @li "icon" - An icon in the title area of the current page
+ * @li "prev_btn" - A button of the current page to go to the previous page
+ * @li "next_btn" - A button of the current page to go to the next page
+ *
+ * Default text parts of the naviframe that you can use for are:
+ * @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 callbacks for are:
+ * @li "transition,finished" - When the transition is finished in changing the
+ * item
* @li "title,clicked" - User clicked title area
*
- * Default content parts of the naviframe items that you can use content hooks for are:
+ * Default content parts of the naviframe items that you can use content hooks
+ * for are:
* @li "default" - The main content of the page
* @li "icon" - An icon in the title area
* @li "prev_btn" - A button to go to the previous page
* @li "subtitle" - Sub-title label in the title area
*
* Supported elm_object common APIs.
- * @li elm_object_signal_emit
+ * @li @ref elm_object_signal_emit
+ * @li @ref elm_object_part_text_set
+ * @li @ref elm_object_part_text_get
+ * @li @ref elm_object_part_content_set
+ * @li @ref elm_object_part_content_get
+ * @li @ref elm_object_part_content_unset
*
* Supported elm_object_item common APIs.
- * @li elm_object_item_part_text_set
- * @li elm_object_item_part_text_get
- * @li elm_object_item_part_content_set
- * @li elm_object_item_part_content_get
- * @li elm_object_item_part_content_unset
- * @li elm_object_item_signal_emit
+ * @li @ref elm_object_item_part_text_set
+ * @li @ref elm_object_item_part_text_get
+ * @li @ref elm_object_item_part_content_set
+ * @li @ref elm_object_item_part_content_get
+ * @li @ref elm_object_item_part_content_unset
+ * @li @ref elm_object_item_signal_emit
*/
/**
/**
* @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"
*
* @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"
*
* @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
* @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
*/
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
*/
EAPI void elm_naviframe_item_simple_promote(Evas_Object *obj, Evas_Object *content);
-
/**
* @}
*/
projects / framework / uifw / elementary.git / blobdiff