summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-07 15:19:21 +0100
committerTom Hacohen <tom@stosb.com>2015-08-07 15:19:21 +0100
commitccc8d753123b8ce28e4a9b5aa50114069175ca41 (patch)
tree47c8f317979560dccfb8e58c1bf2dfd4e85a7d57
parentb0c09a6e354adde20c0190c5a2597f09615dd29e (diff)
Index: migrate docs.
-rw-r--r--src/lib/elm_index.eo365
1 files changed, 113 insertions, 252 deletions
diff --git a/src/lib/elm_index.eo b/src/lib/elm_index.eo
index 459880dde..1c08930dd 100644
--- a/src/lib/elm_index.eo
+++ b/src/lib/elm_index.eo
@@ -3,371 +3,232 @@ class Elm.Index (Elm.Layout, Evas.Clickable_Interface, Evas.Selectable_Interface
3 eo_prefix: elm_obj_index; 3 eo_prefix: elm_obj_index;
4 methods { 4 methods {
5 @property autohide_disabled { 5 @property autohide_disabled {
6 [[Enable or disable auto hiding feature for a given index widget.]]
6 set { 7 set {
7 /*@
8 Enable or disable auto hiding feature for a given index widget.
9
10 @see elm_index_autohide_disabled_get()
11
12 @ingroup Index */
13 } 8 }
14 get { 9 get {
15 /*@
16 Get whether auto hiding feature is enabled or not for a given index widget.
17
18 @return $true, if auto hiding is disabled, $false otherwise
19
20 @see elm_index_autohide_disabled_set() for more details
21
22 @ingroup Index */
23 } 10 }
24 values { 11 values {
25 disabled: bool; /*@ $true to disable auto hiding, $false to enable */ 12 disabled: bool; [[$true to disable auto hiding, $false to enable]]
26 } 13 }
27 } 14 }
28 @property omit_enabled { 15 @property omit_enabled {
29 set { 16 [[Enable or disable omit feature for a given index widget.
30 /*@
31 Enable or disable omit feature for a given index widget.
32
33 @see elm_index_omit_enabled_get()
34
35 @since 1.8
36 17
37 @ingroup Index */ 18 @since 1.8]]
19 set {
38 } 20 }
39 get { 21 get {
40 /*@
41 Get whether omit feature is enabled or not for a given index widget.
42
43 @return $true, if omit feature is enabled, $false otherwise
44
45 @see elm_index_omit_enabled_set()
46
47 @since 1.8
48
49 @ingroup Index */
50 } 22 }
51 values { 23 values {
52 enabled: bool; /*@ $true to enable omit feature, $false to disable */ 24 enabled: bool; [[$true to enable omit feature, $false to disable]]
53 } 25 }
54 } 26 }
55 @property priority { 27 @property priority {
56 set { 28 [[Control priority group of index. Priority group will be shown as many items as it can, and other group will be shown one character only.
57 /*@
58 Set priority group of index. Priority group will be shown as many items as it can,
59 and other group will be shown one character only.
60
61 @see elm_index_priority_get()
62
63 @since 1.16
64 29
65 @ingroup Index */ 30 @since 1.16]]
31 set {
66 } 32 }
67 get { 33 get {
68 /*@
69 Get current priority group of index.
70
71 @return priority value in index
72
73 @see elm_index_priority_set()
74
75 @since 1.16
76
77 @ingroup Index */
78 } 34 }
79 values { 35 values {
80 priority: int; /*@ $priority target priority value in index */ 36 priority: int; [[$priority target priority value in index]]
81 } 37 }
82 } 38 }
83 39
84 @property horizontal { 40 @property horizontal {
85 set { 41 [[Enable or disable horizontal mode on the index object
86 /*@
87 Enable or disable horizontal mode on the index object
88 42
89 @note Vertical mode is set by default. 43 Note: Vertical mode is set by default.
90 44
91 On horizontal mode items are displayed on index from left to right, 45 On horizontal mode items are displayed on index from left to right,
92 instead of from top to bottom. Also, the index will scroll horizontally. 46 instead of from top to bottom. Also, the index will scroll horizontally.]]
93 47 set {
94 @see elm_index_horizontal_get()
95
96 @ingroup Index */
97 } 48 }
98 get { 49 get {
99 /*@
100 Get a value whether horizontal mode is enabled or not.
101
102 @return $true means horizontal mode selection is enabled.
103 $false indicates it's disabled. If $obj is $NULL,
104 $false is returned.
105
106 @see elm_index_horizontal_set() for details.
107
108 @ingroup Index */
109 } 50 }
110 values { 51 values {
111 horizontal: bool; /*@ $true to enable horizontal or $false to 52 horizontal: bool; [[$true to enable horizontal or $false to
112 disable it, i.e., to enable vertical mode. it's an area one @ref Fingers 53 disable it, i.e., to enable vertical mode. it's an area one Fingers
113 "finger" wide on the bottom side of the index widget's container. */ 54 "finger" wide on the bottom side of the index widget's container.]]
114 } 55 }
115 } 56 }
116 @property delay_change_time { 57 @property delay_change_time {
117 set { 58 [[Set a delay change time for index object.
118 /*@
119 Set a delay change time for index object.
120
121 @note delay time is 0.2 sec by default.
122 59
123 @see elm_index_delay_change_time_get 60 Note: delay time is 0.2 sec by default.]]
124 61 set {
125 @ingroup Index */
126 } 62 }
127 get { 63 get {
128 /*@
129 Get a delay change time for index object.
130
131 @return delay change time in seconds
132
133 @see elm_index_delay_change_time_set
134
135 @ingroup Index */
136 } 64 }
137 values { 65 values {
138 dtime: double; /*@ The delay change time to set. */ 66 dtime: double; [[The delay change time to set.]]
139 } 67 }
140 } 68 }
141 @property indicator_disabled { 69 @property indicator_disabled {
142 set { 70 [[Control the indicator as to be disabled.
143 /*@
144 Set the indicator as to be disabled.
145 71
146 In Index widget, Indicator notes popup text, which shows a letter has been selecting. 72 In Index widget, Indicator notes popup text, which shows a letter has been selecting.]]
147 73 set {
148 @see elm_index_indicator_disabled_get()
149
150 @ingroup Index */
151 } 74 }
152 get { 75 get {
153 /*@
154 Get the value of indicator's disabled status.
155
156 @return true if the indicator is disabled.
157
158 @see elm_index_indicator_disabled_set()
159
160 @ingroup Index */
161 } 76 }
162 values { 77 values {
163 disabled: bool; /*@ $true to disable it, $false to enable it */ 78 disabled: bool; [[$true to disable it, $false to enable it]]
164 } 79 }
165 } 80 }
166 @property item_level { 81 @property item_level {
167 set { 82 [[Set the items level for a given index widget.
168 /*@
169 Set the items level for a given index widget.
170
171 @see elm_index_item_level_get()
172 83
173 @ingroup Index */ 84 See: elm_index_item_level_get()]]
85 set {
174 } 86 }
175 get { 87 get {
176 /*@
177 Get the items level set for a given index widget.
178
179 @return $0 or $1, which are the levels $obj might be at.
180
181 @see elm_index_item_level_set() for more information
182
183 @ingroup Index */
184 } 88 }
185 values { 89 values {
186 level: int; /*@ $0 or $1, the currently implemented levels. */ 90 level: int; [[$0 or $1, the currently implemented levels.]]
187 } 91 }
188 } 92 }
189 level_go { 93 level_go {
190 /*@ 94 [[Flush the changes made to the index items so they work correctly
191 Flush the changes made to the index items so they work correctly
192 95
193 This flushes any changes made to items indicating the object is ready to 96 This flushes any changes made to items indicating the object is ready to
194 go. You should call this before any changes you expect to work. This 97 go. You should call this before any changes you expect to work. This
195 is similar to elm_list_go(). 98 is similar to elm_list_go().
196
197 @warning If not called, it won't display the index properly.
198
199 @ingroup Index */
200 99
100 Warning: If not called, it won't display the index properly.]]
201 params { 101 params {
202 @in level: int; /*@ The index level (one of $0 or $1) where changes were made */ 102 @in level: int; [[The index level (one of $0 or $1) where changes were made]]
203 } 103 }
204 } 104 }
205 item_prepend { 105 item_prepend {
206 /*@ 106 [[Prepend a new item on a given index widget.
207 Prepend a new item on a given index widget.
208 107
209 @return A handle to the item added or $NULL, on errors
210 108
211 Despite the most common usage of the $letter argument is for 109 Despite the most common usage of the $letter argument is for
212 single char strings, one could use arbitrary strings as index 110 single char strings, one could use arbitrary strings as index
213 entries. 111 entries.
214 112
215 $item will be the pointer returned back on $"changed", @c 113 $item will be the pointer returned back on $"changed",
216 "delay,changed" and $"selected" smart events. 114 "delay,changed" and $"selected" smart events.]]
217 115
218 @ingroup Index */ 116 return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
219
220 return: Elm.Widget_Item *;
221 params { 117 params {
222 @in letter: const(char)*; /*@ Letter under which the item should be indexed */ 118 @in letter: const(char)*; [[Letter under which the item should be indexed]]
223 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is selected. */ 119 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is selected.]]
224 @in data: const(void)* @optional; /*@ The item data to set for the index's item */ 120 @in data: const(void)* @optional; [[The item data to set for the index's item]]
225 } 121 }
226 } 122 }
227 item_clear { 123 item_clear {
228 /*@ 124 [[Removes all items from a given index widget.
229 Removes @b all items from a given index widget.
230
231 If deletion callbacks are set, via elm_object_item_del_cb_set(),
232 that callback function will be called for each item in $obj.
233
234 @ingroup Index */
235 125
126 If deletion callbacks are set, via elm_object_item_del_cb_set(),
127 that callback function will be called for each item in $obj.]]
236 } 128 }
237 item_insert_after { 129 item_insert_after {
238 /*@ 130 [[Insert a new item into the index object after item $after.
239 Insert a new item into the index object after item $after.
240
241 @return A handle to the item added or $NULL, on errors
242 131
243 Despite the most common usage of the $letter argument is for 132 Despite the most common usage of the $letter argument is for
244 single char strings, one could use arbitrary strings as index 133 single char strings, one could use arbitrary strings as index
245 entries. 134 entries.
246 135
247 $item will be the pointer returned back on $"changed", @c 136 $item will be the pointer returned back on $"changed",
248 "delay,changed" and $"selected" smart events. 137 "delay,changed" and $"selected" smart events.
249 138
250 @note If $relative is $NULL this function will behave as 139 Note: If $relative is $NULL this function will behave as
251 elm_index_item_append(). 140 elm_index_item_append().]]
252 141
253 @ingroup Index */ 142 return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
254
255 return: Elm.Widget_Item *;
256 params { 143 params {
257 @in after: Elm.Widget_Item *; /*@ The index item to insert after. */ 144 @in after: Elm.Widget_Item *; [[The index item to insert after.]]
258 @in letter: const(char)*; /*@ Letter under which the item should be indexed */ 145 @in letter: const(char)*; [[Letter under which the item should be indexed]]
259 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */ 146 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
260 @in data: const(void)* @optional; /*@ The item data to set for the index's item */ 147 @in data: const(void)* @optional; [[The item data to set for the index's item]]
261 } 148 }
262 } 149 }
263 item_find { 150 item_find {
264 /*@ 151 [[Find a given index widget's item, using item data.]]
265 Find a given index widget's item, <b>using item data</b>.
266
267 @return The index item handle, if found, or $NULL otherwise
268 152
269 @ingroup Index */ 153 return: Elm.Widget_Item *; [[The index item handle, if found, or $NULL otherwise]]
270
271 return: Elm.Widget_Item *;
272 params { 154 params {
273 @in data: const(void)*; /*@ The item data pointed to by the desired index item */ 155 @in data: const(void)*; [[The item data pointed to by the desired index item]]
274 } 156 }
275 } 157 }
276 item_insert_before { 158 item_insert_before {
277 /*@ 159 [[Insert a new item into the index object before item $before.
278 Insert a new item into the index object before item $before.
279
280 @return A handle to the item added or $NULL, on errors
281 160
282 Despite the most common usage of the $letter argument is for 161 Despite the most common usage of the $letter argument is for
283 single char strings, one could use arbitrary strings as index 162 single char strings, one could use arbitrary strings as index
284 entries. 163 entries.
285 164
286 $item will be the pointer returned back on $"changed", @c 165 $item will be the pointer returned back on $"changed",
287 "delay,changed" and $"selected" smart events. 166 "delay,changed" and $"selected" smart events.
288 167
289 @note If $relative is $NULL this function will behave as 168 Note: If $relative is $NULL this function will behave as
290 elm_index_item_prepend(). 169 elm_index_item_prepend().]]
291 170
292 @ingroup Index */ 171 return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
293
294 return: Elm.Widget_Item *;
295 params { 172 params {
296 @in before: Elm.Widget_Item *; /*@ The index item to insert after. */ 173 @in before: Elm.Widget_Item *; [[The index item to insert after.]]
297 @in letter: const(char)*; /*@ Letter under which the item should be indexed */ 174 @in letter: const(char)*; [[Letter under which the item should be indexed]]
298 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */ 175 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
299 @in data: const(void)* @optional; /*@ The item data to set for the index's item */ 176 @in data: const(void)* @optional; [[The item data to set for the index's item]]
300 } 177 }
301 } 178 }
302 item_append { 179 item_append {
303 /*@ 180 [[Append a new item on a given index widget.
304 Append a new item on a given index widget.
305
306 @return A handle to the item added or $NULL, on errors
307 181
308 Despite the most common usage of the $letter argument is for 182 Despite the most common usage of the $letter argument is for
309 single char strings, one could use arbitrary strings as index 183 single char strings, one could use arbitrary strings as index
310 entries. 184 entries.
311 185
312 $item will be the pointer returned back on $"changed", @c 186 $item will be the pointer returned back on $"changed",
313 "delay,changed" and $"selected" smart events. 187 "delay,changed" and $"selected" smart events.]]
314 188
315 @ingroup Index */ 189 return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
316
317 return: Elm.Widget_Item *;
318 params { 190 params {
319 @in letter: const(char)*; /*@ Letter under which the item should be indexed */ 191 @in letter: const(char)*; [[Letter under which the item should be indexed]]
320 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is selected. */ 192 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is selected.]]
321 @in data: const(void)* @optional; /*@ The item data to set for the index's item */ 193 @in data: const(void)* @optional; [[The item data to set for the index's item]]
322 } 194 }
323 } 195 }
324 selected_item_get @const { 196 selected_item_get @const {
325 /*@ 197 [[Returns the last selected item, for a given index widget.]]
326 Returns the last selected item, for a given index widget.
327
328 @return The last item @b selected on $obj (or $NULL, on errors).
329 198
330 @ingroup Index */ 199 return: Elm.Widget_Item *; [[The last item selected on $obj (or $NULL, on errors).]]
331 return: Elm.Widget_Item *;
332 params { 200 params {
333 @in level: int; /*@ $0 or $1, the currently implemented levels. */ 201 @in level: int; [[$0 or $1, the currently implemented levels.]]
334 } 202 }
335 } 203 }
336 item_sorted_insert { 204 item_sorted_insert {
337 /*@ 205 [[Insert a new item into the given index widget, using $cmp_func function to sort items (by item handles).
338 Insert a new item into the given index widget, using $cmp_func
339 function to sort items (by item handles).
340
341 @return A handle to the item added or $NULL, on errors
342
343 Despite the most common usage of the $letter argument is for
344 single char strings, one could use arbitrary strings as index
345 entries.
346 206
347 $item will be the pointer returned back on $"changed", @c 207 Despite the most common usage of the $letter argument is for
348 "delay,changed" and $"selected" smart events. 208 single char strings, one could use arbitrary strings as index
209 entries.
349 210
350 @ingroup Index */ 211 $item will be the pointer returned back on $"changed",
212 "delay,changed" and $"selected" smart events.]]
351 213
352 return: Elm.Widget_Item *; 214 return: Elm.Widget_Item *; [[A handle to the item added or $NULL, on errors]]
353 params { 215 params {
354 @in letter: const(char)*; /*@ Letter under which the item should be indexed */ 216 @in letter: const(char)*; [[Letter under which the item should be indexed]]
355 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is clicked. */ 217 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is clicked.]]
356 @in data: const(void)* @optional; /*@ The item data to set for the index's item */ 218 @in data: const(void)* @optional; [[The item data to set for the index's item]]
357 @in cmp_func: Eina_Compare_Cb; /*@ The comparing function to be used to sort index 219 @in cmp_func: Eina_Compare_Cb; [[The comparing function to be used to sort index items by index item handles]]
358 items <b>by index item handles</b> */ 220 @in cmp_data_func: Eina_Compare_Cb @optional; [[A fallback function to be called for the
359 @in cmp_data_func: Eina_Compare_Cb @optional; /*@ A @b fallback function to be called for the 221 sorting of index items by item data). It will be used
360 sorting of index items <b>by item data</b>). It will be used 222 when $cmp_func returns $0 (equality), which means an index
361 when $cmp_func returns $0 (equality), which means an index 223 item with provided item data already exists. To decide which
362 item with provided item data already exists. To decide which 224 data item should be pointed to by the index item in question,
363 data item should be pointed to by the index item in question, @p 225 $cmp_data_func will be used. If $cmp_data_func returns a
364 cmp_data_func will be used. If $cmp_data_func returns a 226 non-negative value, the previous index item data will be
365 non-negative value, the previous index item data will be 227 replaced by the given $item pointer. If the previous data need
366 replaced by the given $item pointer. If the previous data need 228 to be freed, it should be done by the $cmp_data_func function,
367 to be freed, it should be done by the $cmp_data_func function, 229 because all references to it will be lost. If this function is
368 because all references to it will be lost. If this function is 230 not provided ($NULL is given), index items will be
369 not provided ($NULL is given), index items will be @b 231 duplicated, if $cmp_func returns $0.]]
370 duplicated, if $cmp_func returns $0. */
371 } 232 }
372 } 233 }
373 } 234 }