summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 13:30:05 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 13:30:05 +0100
commitc32c71ad0035afa9c41e2d527c3573def75d8b6f (patch)
tree3dde1fad7d9320d1b65c18fadd6a30e6e18ca973
parent6c87a2da3568a95b022003da9581d76f27c59aa0 (diff)
Naviframe: migrate docs.
-rw-r--r--src/lib/elm_naviframe.eo234
1 files changed, 57 insertions, 177 deletions
diff --git a/src/lib/elm_naviframe.eo b/src/lib/elm_naviframe.eo
index 2bc3767b4..b4ad96556 100644
--- a/src/lib/elm_naviframe.eo
+++ b/src/lib/elm_naviframe.eo
@@ -3,251 +3,131 @@ class Elm.Naviframe (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
3 eo_prefix: elm_obj_naviframe; 3 eo_prefix: elm_obj_naviframe;
4 methods { 4 methods {
5 @property event_enabled { 5 @property event_enabled {
6 set { 6 [[Control the event enabled when pushing/popping items
7 /*@
8 @brief Set the event enabled when pushing/popping items
9
10 If $enabled is $true, the contents of the naviframe item will
11 receives events from mouse and keyboard during view changing such as
12 item push/pop.
13
14 @warning Events will be blocked by calling evas_object_freeze_events_set()
15 internally. So don't call the API whiling pushing/popping items.
16 7
17 @see elm_naviframe_event_enabled_get() 8 If $enabled is $true, the contents of the naviframe item will
18 @see evas_object_freeze_events_set() 9 receives events from mouse and keyboard during view changing such as
10 item push/pop.
19 11
20 @ingroup Naviframe */ 12 Warning: Events will be blocked by calling evas_object_freeze_events_set()
13 internally. So don't call the API whiling pushing/popping items.]]
14 set {
21 } 15 }
22 get { 16 get {
23 /*@
24 @brief Get the value of event enabled status.
25
26 @return $true, when event is enabled
27
28 @see elm_naviframe_event_enabled_set()
29
30 @ingroup Naviframe */
31 } 17 }
32 values { 18 values {
33 enabled: bool; /*@ Events are received when enabled is $true, and 19 enabled: bool; [[Events are received when enabled is $true, and ignored otherwise.]]
34 ignored otherwise. */
35 } 20 }
36 } 21 }
37 @property content_preserve_on_pop { 22 @property content_preserve_on_pop {
23 [[Preserve the content objects when items are popped.]]
38 set { 24 set {
39 /*@
40 @brief preserve the content objects when items are popped.
41
42 @see also elm_naviframe_content_preserve_on_pop_get()
43
44 @ingroup Naviframe */
45 } 25 }
46 get { 26 get {
47 /*@
48 @brief Get a value whether preserve mode is enabled or not.
49
50 @return If $true, preserve mode is enabled
51
52 @see also elm_naviframe_content_preserve_on_pop_set()
53
54 @ingroup Naviframe */
55 } 27 }
56 values { 28 values {
57 preserve: bool; /*@ Enable the preserve mode if $true, disable otherwise */ 29 preserve: bool; [[Enable the preserve mode if $true, disable otherwise]]
58 } 30 }
59 } 31 }
60 @property prev_btn_auto_pushed { 32 @property prev_btn_auto_pushed {
33 [[Control if creating prev button automatically or not]]
61 set { 34 set {
62 /*@
63 @brief Set creating prev button automatically or not
64
65 @see also elm_naviframe_item_push()
66
67 @ingroup Naviframe */
68 } 35 }
69 get { 36 get {
70 /*@
71 @brief Get a value whether prev button(back button) will be auto pushed or
72 not.
73
74 @return If $true, prev button will be auto pushed.
75
76 @see also elm_naviframe_item_push()
77 elm_naviframe_prev_btn_auto_pushed_set()
78
79 @ingroup Naviframe */
80 } 37 }
81 values { 38 values {
82 auto_pushed: bool; /*@ If $true, the previous button(back button) will 39 auto_pushed: bool; [[If $true, the previous button(back button) will be created internally when you pass the $NULL to the prev_btn parameter in elm_naviframe_item_push]]
83 be created internally when you pass the $NULL to the prev_btn
84 parameter in elm_naviframe_item_push */
85 } 40 }
86 } 41 }
87 @property items { 42 @property items {
88 get { 43 get {
89 /*@ 44 [[Get a list of all the naviframe items.]]
90 @brief Get a list of all the naviframe items.
91 45
92 @return A list of naviframe items, #Elm.Widget_Item, 46 return: free(own(list<Elm.Widget_Item *> *), eina_list_free) @warn_unused; [[A list of naviframe items, @Elm.Widget_Item, or $NULL on failure. Note: The returned list MUST be freed.]]
93 or $NULL on failure.
94 @note The returned list MUST be freed.
95
96 @ingroup Naviframe */
97 return: free(own(list<Elm.Widget_Item *> *), eina_list_free) @warn_unused;
98 } 47 }
99 } 48 }
100 @property top_item { 49 @property top_item {
101 get { 50 get {
102 /*@ 51 [[Get a top item on the naviframe stack]]
103 @brief Get a top item on the naviframe stack
104
105 @return The top item on the naviframe stack or $NULL, if the stack is
106 empty
107 52
108 @ingroup Naviframe */ 53 return: Elm.Widget_Item *; [[The top item on the naviframe stack or $NULL, if the stack is empty]]
109 return: Elm.Widget_Item *;
110 } 54 }
111 } 55 }
112 @property bottom_item { 56 @property bottom_item {
113 get { 57 get {
114 /*@ 58 [[Get a bottom item on the naviframe stack]]
115 @brief Get a bottom item on the naviframe stack
116 59
117 @return The bottom item on the naviframe stack or $NULL, if the stack is 60 return: Elm.Widget_Item *; [[The bottom item on the naviframe stack or $NULL, if the stack is empty]]
118 empty
119
120 @ingroup Naviframe */
121 return: Elm.Widget_Item *;
122 } 61 }
123 } 62 }
124 item_pop { 63 item_pop {
125 /*@ 64 [[Pop an item that is on top of the stack
126 @brief Pop an item that is on top of the stack
127
128 @return $NULL or the content object(if the
129 elm_naviframe_content_preserve_on_pop_get is true).
130 65
131 This pops an item that is on the top(visible) of the naviframe, makes it 66 This pops an item that is on the top(visible) of the naviframe, makes it
132 disappear, then deletes the item. The item that was underneath it on the 67 disappear, then deletes the item. The item that was underneath it on the
133 stack will become visible. 68 stack will become visible.]]
134 69
135 @see also elm_naviframe_content_preserve_on_pop_get() 70 return: Evas.Object *; [[$NULL or the content object(if the elm_naviframe_content_preserve_on_pop_get is true).]]
136 @see also elm_naviframe_item_pop_cb_set()
137
138 @ingroup Naviframe */
139
140 return: Evas.Object *;
141 } 71 }
142 item_insert_before { 72 item_insert_before {
143 /*@ 73 [[Insert a new item into the naviframe before item $before.
144 @brief Insert a new item into the naviframe before item $before.
145
146 @return The created item or $NULL upon failure.
147
148 The item is inserted into the naviframe straight away without any
149 transition operations. This item will be deleted when it is popped.
150 74
151 @see also elm_naviframe_item_style_set() 75 The item is inserted into the naviframe straight away without any
152 @see also elm_naviframe_item_push() 76 transition operations. This item will be deleted when it is popped.]]
153 @see also elm_naviframe_item_insert_after()
154 77
155 The following styles are available for this item: 78 return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
156 @li $"default"
157
158 @ingroup Naviframe */
159
160 return: Elm.Widget_Item *;
161 params { 79 params {
162 @in before: Elm.Widget_Item *; /*@ The naviframe item to insert before. */ 80 @in before: Elm.Widget_Item *; [[The naviframe item to insert before.]]
163 @in title_label: const(char)* @optional; /*@ The label in the title area. The name of the title 81 @in title_label: const(char)* @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
164 label part is "elm.text.title" */ 82 @in prev_btn: Evas.Object * @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
165 @in prev_btn: Evas.Object * @nullable; /*@ The button to go to the previous item. If it is NULL, 83 @in next_btn: Evas.Object * @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
166 then naviframe will create a back button automatically. The name of 84 @in content: Evas.Object *; [[The main content object. The name of content part is "elm.swallow.content"]]
167 the prev_btn part is "elm.swallow.prev_btn" */ 85 @in item_style: const(char)* @nullable; [[The current item style name. $NULL would be default.]]
168 @in next_btn: Evas.Object * @nullable; /*@ The button to go to the next item. Or It could be just an
169 extra function button. The name of the next_btn part is
170 "elm.swallow.next_btn" */
171 @in content: Evas.Object *; /*@ The main content object. The name of content part is
172 "elm.swallow.content" */
173 @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
174 } 86 }
175 } 87 }
176 item_push { 88 item_push {
177 /*@ 89 [[Push a new item to the top of the naviframe stack (and show it).
178 @brief Push a new item to the top of the naviframe stack (and show it).
179
180 @return The created item or $NULL upon failure.
181
182 The item pushed becomes one page of the naviframe, this item will be
183 deleted when it is popped.
184 90
185 @see also elm_naviframe_item_style_set()
186 @see also elm_naviframe_item_insert_before()
187 @see also elm_naviframe_item_insert_after()
188 91
189 The following styles are available for this item: 92 The item pushed becomes one page of the naviframe, this item will be
190 @li $"default" 93 deleted when it is popped.
191 94
192 @ingroup Naviframe */ 95 The following styles are available for this item:
96 "default"]]
193 97
194 return: Elm.Widget_Item *; 98 return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
195 params { 99 params {
196 @in title_label: const(char)* @optional; /*@ The label in the title area. The name of the title 100 @in title_label: const(char)* @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
197 label part is "elm.text.title" */ 101 @in prev_btn: Evas.Object * @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
198 @in prev_btn: Evas.Object * @nullable; /*@ The button to go to the previous item. If it is NULL, 102 @in next_btn: Evas.Object * @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
199 then naviframe will create a back button automatically. The name of 103 @in content: Evas.Object *; [[The main content object. The name of content part is "elm.swallow.content"]]
200 the prev_btn part is "elm.swallow.prev_btn" */ 104 @in item_style: const(char)* @nullable; [[The current item style name. $NULL would be default.]]
201 @in next_btn: Evas.Object * @nullable; /*@ The button to go to the next item. Or It could be just an
202 extra function button. The name of the next_btn part is
203 "elm.swallow.next_btn" */
204 @in content: Evas.Object *; /*@ The main content object. The name of content part is
205 "elm.swallow.content" */
206 @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
207 } 105 }
208 } 106 }
209 item_simple_promote { 107 item_simple_promote {
210 /*@ 108 [[Simple version of item_promote.]]
211 @brief Simple version of item_promote.
212
213 @see elm_naviframe_item_promote */
214 109
215 params { 110 params {
216 @in content: Evas.Object *; 111 @in content: Evas.Object *;
217 } 112 }
218 } 113 }
219 item_insert_after { 114 item_insert_after {
220 /*@ 115 [[Insert a new item into the naviframe after item $after.
221 @brief Insert a new item into the naviframe after item $after.
222
223 @return The created item or $NULL upon failure.
224
225 The item is inserted into the naviframe straight away without any
226 transition operations. This item will be deleted when it is popped.
227
228 @see also elm_naviframe_item_style_set()
229 @see also elm_naviframe_item_push()
230 @see also elm_naviframe_item_insert_before()
231 116
232 The following styles are available for this item: 117 The item is inserted into the naviframe straight away without any
233 @li $"default" 118 transition operations. This item will be deleted when it is popped.
234 119
235 @ingroup Naviframe */ 120 The following styles are available for this item:
121 "default"]]
236 122
237 return: Elm.Widget_Item *; 123 return: Elm.Widget_Item *; [[The created item or $NULL upon failure.]]
238 params { 124 params {
239 @in after: Elm.Widget_Item *; /*@ The naviframe item to insert after. */ 125 @in after: Elm.Widget_Item *; [[The naviframe item to insert after.]]
240 @in title_label: const(char)* @optional; /*@ The label in the title area. The name of the title 126 @in title_label: const(char)* @optional; [[The label in the title area. The name of the title label part is "elm.text.title"]]
241 label part is "elm.text.title" */ 127 @in prev_btn: Evas.Object * @nullable; [[The button to go to the previous item. If it is NULL, then naviframe will create a back button automatically. The name of the prev_btn part is "elm.swallow.prev_btn"]]
242 @in prev_btn: Evas.Object * @nullable; /*@ The button to go to the previous item. If it is NULL, 128 @in next_btn: Evas.Object * @nullable; [[The button to go to the next item. Or It could be just an extra function button. The name of the next_btn part is "elm.swallow.next_btn"]]
243 then naviframe will create a back button automatically. The name of 129 @in content: Evas.Object *; [[The main content object. The name of content part is "elm.swallow.content"]]
244 the prev_btn part is "elm.swallow.prev_btn" */ 130 @in item_style: const(char)* @nullable; [[The current item style name. $NULL would be default.]]
245 @in next_btn: Evas.Object * @nullable; /*@ The button to go to the next item. Or It could be just an
246 extra function button. The name of the next_btn part is
247 "elm.swallow.next_btn" */
248 @in content: Evas.Object *; /*@ The main content object. The name of content part is
249 "elm.swallow.content" */
250 @in item_style: const(char)* @nullable; /*@ The current item style name. $NULL would be default. */
251 } 131 }
252 } 132 }
253 } 133 }