summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_naviframe_item_eo.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_naviframe_item_eo.h')
-rw-r--r--src/lib/elementary/elm_naviframe_item_eo.h99
1 files changed, 99 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_naviframe_item_eo.h b/src/lib/elementary/elm_naviframe_item_eo.h
new file mode 100644
index 0000000..d5b8684
--- /dev/null
+++ b/src/lib/elementary/elm_naviframe_item_eo.h
@@ -0,0 +1,99 @@
1#ifndef _ELM_NAVIFRAME_ITEM_EO_H_
2#define _ELM_NAVIFRAME_ITEM_EO_H_
3
4#ifndef _ELM_NAVIFRAME_ITEM_EO_CLASS_TYPE
5#define _ELM_NAVIFRAME_ITEM_EO_CLASS_TYPE
6
7typedef Eo Elm_Naviframe_Item;
8
9#endif
10
11#ifndef _ELM_NAVIFRAME_ITEM_EO_TYPES
12#define _ELM_NAVIFRAME_ITEM_EO_TYPES
13
14
15#endif
16/** Elementary naviframe item class
17 *
18 * @ingroup Elm_Naviframe_Item
19 */
20#define ELM_NAVIFRAME_ITEM_CLASS elm_naviframe_item_class_get()
21
22EWAPI const Efl_Class *elm_naviframe_item_class_get(void);
23
24/**
25 * @brief Pop the top item and delete the items between the top and the above
26 * one on the given item.
27 *
28 * The items between the top and the given item will be deleted first, and then
29 * the top item will be popped at last.
30 *
31 * @warning The pop callback function set by elm_naviframe_item_pop_cb_set is
32 * not called for items between the top item and the destination item since
33 * those items are deleted without being popped.
34 * @param[in] obj The object.
35 *
36 * @ingroup Elm_Naviframe_Item
37 */
38EOAPI void elm_obj_naviframe_item_pop_to(Eo *obj);
39
40/**
41 * @brief Get a value whether title area is enabled or not.
42 *
43 * @param[in] obj The object.
44 *
45 * @return If @c true, title area will be enabled, disabled otherwise
46 *
47 * @ingroup Elm_Naviframe_Item
48 */
49EOAPI Eina_Bool elm_obj_naviframe_item_title_enabled_get(const Eo *obj);
50
51/**
52 * @brief Enable/Disable the title area with transition effect
53 *
54 * When the title area is disabled, then the controls would be hidden so as to
55 * expand the content area to full-size.
56 *
57 * @param[in] obj The object.
58 * @param[in] enable If @c true, title area will be enabled, disabled otherwise
59 * @param[in] transition If @c true, transition effect of the title will be
60 * visible, invisible otherwise
61 *
62 * @ingroup Elm_Naviframe_Item
63 */
64EOAPI void elm_obj_naviframe_item_title_enabled_set(Eo *obj, Eina_Bool enable, Eina_Bool transition);
65
66/**
67 * @brief Promote an item already in the naviframe stack to the top of the
68 * stack.
69 *
70 * This will take the indicated item and promote it to the top of the stack as
71 * if it had been pushed there. The item must already be inside the naviframe
72 * stack to work.
73 * @param[in] obj The object.
74 *
75 * @ingroup Elm_Naviframe_Item
76 */
77EOAPI void elm_obj_naviframe_item_promote(Eo *obj);
78
79/**
80 * @brief Set a function to be called when an item of the naviframe is going to
81 * be popped.
82 *
83 * @warning Don't set "clicked" callback to the prev button additionally if the
84 * function does an exact same logic with this @c func. When hardware back key
85 * is pressed then both callbacks will be called. Warning: The pop callback
86 * function is called only if the item is popped. Therefore, the pop callback
87 * function is not called if the item is deleted without being popped.
88 *
89 * @param[in] obj The object.
90 * @param[in] func The callback function.
91 * @param[in] data Data to be passed to func call.
92 *
93 * @since 1.8
94 *
95 * @ingroup Elm_Naviframe_Item
96 */
97EOAPI void elm_obj_naviframe_item_pop_cb_set(Eo *obj, Elm_Naviframe_Item_Pop_Cb func, void *data);
98
99#endif