summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_naviframe_eo.legacy.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_naviframe_eo.legacy.h')
-rw-r--r--src/lib/elementary/elm_naviframe_eo.legacy.h246
1 files changed, 246 insertions, 0 deletions
diff --git a/src/lib/elementary/elm_naviframe_eo.legacy.h b/src/lib/elementary/elm_naviframe_eo.legacy.h
new file mode 100644
index 0000000..155e751
--- /dev/null
+++ b/src/lib/elementary/elm_naviframe_eo.legacy.h
@@ -0,0 +1,246 @@
1#ifndef _ELM_NAVIFRAME_EO_LEGACY_H_
2#define _ELM_NAVIFRAME_EO_LEGACY_H_
3
4#ifndef _ELM_NAVIFRAME_EO_CLASS_TYPE
5#define _ELM_NAVIFRAME_EO_CLASS_TYPE
6
7typedef Eo Elm_Naviframe;
8
9#endif
10
11#ifndef _ELM_NAVIFRAME_EO_TYPES
12#define _ELM_NAVIFRAME_EO_TYPES
13
14
15#endif
16
17/**
18 * @brief Control the event enabled when pushing/popping items
19 *
20 * If @c enabled is @c true, the contents of the naviframe item will receives
21 * events from mouse and keyboard during view changing such as item push/pop.
22 *
23 * @warning Events will be blocked by calling evas_object_freeze_events_set()
24 * internally. So don't call the API whiling pushing/popping items.
25 *
26 * @param[in] obj The object.
27 * @param[in] enabled Events are received when enabled is @c true, and ignored
28 * otherwise.
29 *
30 * @ingroup Elm_Naviframe_Group
31 */
32EAPI void elm_naviframe_event_enabled_set(Elm_Naviframe *obj, Eina_Bool enabled);
33
34/**
35 * @brief Control the event enabled when pushing/popping items
36 *
37 * If @c enabled is @c true, the contents of the naviframe item will receives
38 * events from mouse and keyboard during view changing such as item push/pop.
39 *
40 * @warning Events will be blocked by calling evas_object_freeze_events_set()
41 * internally. So don't call the API whiling pushing/popping items.
42 *
43 * @param[in] obj The object.
44 *
45 * @return Events are received when enabled is @c true, and ignored otherwise.
46 *
47 * @ingroup Elm_Naviframe_Group
48 */
49EAPI Eina_Bool elm_naviframe_event_enabled_get(const Elm_Naviframe *obj);
50
51/**
52 * @brief Preserve the content objects when items are popped.
53 *
54 * @param[in] obj The object.
55 * @param[in] preserve Enable the preserve mode if @c true, disable otherwise
56 *
57 * @ingroup Elm_Naviframe_Group
58 */
59EAPI void elm_naviframe_content_preserve_on_pop_set(Elm_Naviframe *obj, Eina_Bool preserve);
60
61/**
62 * @brief Preserve the content objects when items are popped.
63 *
64 * @param[in] obj The object.
65 *
66 * @return Enable the preserve mode if @c true, disable otherwise
67 *
68 * @ingroup Elm_Naviframe_Group
69 */
70EAPI Eina_Bool elm_naviframe_content_preserve_on_pop_get(const Elm_Naviframe *obj);
71
72/**
73 * @brief Control if creating prev button automatically or not
74 *
75 * @param[in] obj The object.
76 * @param[in] auto_pushed If @c true, the previous button(back button) will be
77 * created internally when you pass the @c NULL to the prev_btn parameter in
78 * elm_naviframe_item_push
79 *
80 * @ingroup Elm_Naviframe_Group
81 */
82EAPI void elm_naviframe_prev_btn_auto_pushed_set(Elm_Naviframe *obj, Eina_Bool auto_pushed);
83
84/**
85 * @brief Control if creating prev button automatically or not
86 *
87 * @param[in] obj The object.
88 *
89 * @return If @c true, the previous button(back button) will be created
90 * internally when you pass the @c NULL to the prev_btn parameter in
91 * elm_naviframe_item_push
92 *
93 * @ingroup Elm_Naviframe_Group
94 */
95EAPI Eina_Bool elm_naviframe_prev_btn_auto_pushed_get(const Elm_Naviframe *obj);
96
97/**
98 * @brief Get a list of all the naviframe items.
99 *
100 * @param[in] obj The object.
101 *
102 * @return A list of naviframe items, @ref Elm_Widget_Item, or @c NULL on
103 * failure. Note: The returned list MUST be freed.
104 *
105 * @ingroup Elm_Naviframe_Group
106 */
107EAPI Eina_List *elm_naviframe_items_get(const Elm_Naviframe *obj) EINA_WARN_UNUSED_RESULT;
108
109/**
110 * @brief Get a top item on the naviframe stack
111 *
112 * @param[in] obj The object.
113 *
114 * @return The top item on the naviframe stack or @c NULL, if the stack is
115 * empty
116 *
117 * @ingroup Elm_Naviframe_Group
118 */
119EAPI Elm_Widget_Item *elm_naviframe_top_item_get(const Elm_Naviframe *obj);
120
121/**
122 * @brief Get a bottom item on the naviframe stack
123 *
124 * @param[in] obj The object.
125 *
126 * @return The bottom item on the naviframe stack or @c NULL, if the stack is
127 * empty
128 *
129 * @ingroup Elm_Naviframe_Group
130 */
131EAPI Elm_Widget_Item *elm_naviframe_bottom_item_get(const Elm_Naviframe *obj);
132
133/**
134 * @brief Pop an item that is on top of the stack
135 *
136 * This pops an item that is on the top(visible) of the naviframe, makes it
137 * disappear, then deletes the item. The item that was underneath it on the
138 * stack will become visible.
139 *
140 * When pop transition animation is in progress, new pop operation is blocked
141 * until current pop operation is complete.
142 *
143 * @param[in] obj The object.
144 *
145 * @return @c NULL or the content object(if the
146 * elm_naviframe_content_preserve_on_pop_get is true).
147 *
148 * @ingroup Elm_Naviframe_Group
149 */
150EAPI Efl_Canvas_Object *elm_naviframe_item_pop(Elm_Naviframe *obj);
151
152/**
153 * @brief Insert a new item into the naviframe before item @c before.
154 *
155 * The item is inserted into the naviframe straight away without any transition
156 * operations. This item will be deleted when it is popped.
157 *
158 * @param[in] obj The object.
159 * @param[in] before The naviframe item to insert before.
160 * @param[in] title_label The label in the title area. The name of the title
161 * label part is "elm.text.title"
162 * @param[in] prev_btn The button to go to the previous item. If it is NULL,
163 * then naviframe will create a back button automatically. The name of the
164 * prev_btn part is "elm.swallow.prev_btn"
165 * @param[in] next_btn The button to go to the next item. Or It could be just
166 * an extra function button. The name of the next_btn part is
167 * "elm.swallow.next_btn"
168 * @param[in] content The main content object. The name of content part is
169 * "elm.swallow.content"
170 * @param[in] item_style The current item style name. @c NULL would be default.
171 *
172 * @return The created item or @c NULL upon failure.
173 *
174 * @ingroup Elm_Naviframe_Group
175 */
176EAPI Elm_Widget_Item *elm_naviframe_item_insert_before(Elm_Naviframe *obj, Elm_Widget_Item *before, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
177
178/**
179 * @brief Push a new item to the top of the naviframe stack (and show it).
180 *
181 * The item pushed becomes one page of the naviframe, this item will be deleted
182 * when it is popped.
183 *
184 * When push transition animation is in progress, pop operation is blocked
185 * until push is complete.
186 *
187 * The following styles are available for this item: "default"
188 *
189 * @param[in] obj The object.
190 * @param[in] title_label The label in the title area. The name of the title
191 * label part is "elm.text.title"
192 * @param[in] prev_btn The button to go to the previous item. If it is NULL,
193 * then naviframe will create a back button automatically. The name of the
194 * prev_btn part is "elm.swallow.prev_btn"
195 * @param[in] next_btn The button to go to the next item. Or It could be just
196 * an extra function button. The name of the next_btn part is
197 * "elm.swallow.next_btn"
198 * @param[in] content The main content object. The name of content part is
199 * "elm.swallow.content"
200 * @param[in] item_style The current item style name. @c NULL would be default.
201 *
202 * @return The created item or @c NULL upon failure.
203 *
204 * @ingroup Elm_Naviframe_Group
205 */
206EAPI Elm_Widget_Item *elm_naviframe_item_push(Elm_Naviframe *obj, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
207
208/**
209 * @brief Simple version of item_promote.
210 *
211 * @param[in] obj The object.
212 * @param[in] content Item to promote
213 *
214 * @ingroup Elm_Naviframe_Group
215 */
216EAPI void elm_naviframe_item_simple_promote(Elm_Naviframe *obj, Efl_Canvas_Object *content);
217
218/**
219 * @brief Insert a new item into the naviframe after item @c after.
220 *
221 * The item is inserted into the naviframe straight away without any transition
222 * operations. This item will be deleted when it is popped.
223 *
224 * The following styles are available for this item: "default"
225 *
226 * @param[in] obj The object.
227 * @param[in] after The naviframe item to insert after.
228 * @param[in] title_label The label in the title area. The name of the title
229 * label part is "elm.text.title"
230 * @param[in] prev_btn The button to go to the previous item. If it is NULL,
231 * then naviframe will create a back button automatically. The name of the
232 * prev_btn part is "elm.swallow.prev_btn"
233 * @param[in] next_btn The button to go to the next item. Or It could be just
234 * an extra function button. The name of the next_btn part is
235 * "elm.swallow.next_btn"
236 * @param[in] content The main content object. The name of content part is
237 * "elm.swallow.content"
238 * @param[in] item_style The current item style name. @c NULL would be default.
239 *
240 * @return The created item or @c NULL upon failure.
241 *
242 * @ingroup Elm_Naviframe_Group
243 */
244EAPI Elm_Widget_Item *elm_naviframe_item_insert_after(Elm_Naviframe *obj, Elm_Widget_Item *after, const char *title_label, Efl_Canvas_Object *prev_btn, Efl_Canvas_Object *next_btn, Efl_Canvas_Object *content, const char *item_style);
245
246#endif