summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_genlist_item.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_genlist_item.eo')
-rw-r--r--src/lib/elementary/elm_genlist_item.eo437
1 files changed, 0 insertions, 437 deletions
diff --git a/src/lib/elementary/elm_genlist_item.eo b/src/lib/elementary/elm_genlist_item.eo
deleted file mode 100644
index 5655e7d..0000000
--- a/src/lib/elementary/elm_genlist_item.eo
+++ /dev/null
@@ -1,437 +0,0 @@
1import elm_general;
2
3class Elm.Genlist.Item extends Elm.Widget.Item.Static_Focus implements Efl.Ui.Legacy
4{
5 [[Elementary genlist item class]]
6 legacy_prefix: elm_genlist_item;
7 eo_prefix: elm_obj_genlist_item;
8 data: Elm_Gen_Item;
9 methods {
10 @property prev {
11 get {
12 [[Get the previous item in a genlist widget's internal
13 list of items, given a handle to one of those items.
14
15 This returns the item placed before the $item, on
16 the container genlist.
17
18 If filter is set on genlist, this returns the filtered
19 item placed before $item in the list.
20
21 Note that parent / child relationship is not taken into
22 account, the previous visual item is always returned,
23 could it be a parent, a child or a group item.
24
25 NULL is returned if called on the first item.
26 ]]
27 }
28 values {
29 item: Elm.Widget.Item; [[The item before $item, or $null if there's none (and on errors).]]
30 }
31 }
32 @property next {
33 get {
34 [[Get the next item in a genlist widget's internal lis
35 of items, given a handle to one of those items.
36
37 This returns the item placed after the $item, on
38 the container genlist.
39
40 If filter is set on genlist, this returns the filtered
41 item placed after $item in the list.
42
43 Note that parent / child relationship is not taken into
44 account, the next visual item is always returned, could
45 it be a parent, a child or a group item.
46
47 NULL is returned if called on the last item.
48 ]]
49 }
50 values {
51 item: Elm.Widget.Item; [[The item after $item, or $null if there's none (and on errors).]]
52 }
53 }
54 @property parent_item {
55 get {
56 [[Get the parent item of the given item
57
58 This returns the item that was specified as parent
59 of the item $it on \@ref elm_genlist_item_append
60 and insertion related functions.
61 ]]
62 legacy: elm_genlist_item_parent_get;
63 }
64 values {
65 item: Elm.Widget.Item; [[The parent of the item or $null if it has no parent.]]
66 }
67 }
68 @property subitems {
69 get {
70 [[Get the list of subitems of a given item
71
72 This returns the list of subitems that an item
73 possesses. It cannot be changed.
74
75 @since 1.9
76 ]]
77 }
78 values {
79 subitems: const(list<Elm.Widget.Item>); [[The list of subitems, $null on error.]]
80 }
81 }
82 @property selected {
83 get {
84 [[Get whether a given genlist item is selected or not.]]
85 }
86 set {
87 [[Set whether a given genlist item is selected or not
88
89 This sets the selected state of an item. If multi
90 selection is not enabled on the containing genlist
91 and $selected is $true, any other previously selected
92 items will get unselected in favor of this new one.
93 ]]
94 }
95 values {
96 selected: bool; [[The selected state ($true selected, $false not selected).]]
97 }
98 }
99 @property expanded {
100 get {
101 [[Get the expanded state of an item
102
103 This gets the expanded state of an item.
104 ]]
105 }
106 set {
107 [[Sets the expanded state of an item.
108
109 This function flags the item of type
110 #ELM_GENLIST_ITEM_TREE as expanded or not.
111
112 The theme will respond to this change visually, and
113 a signal "expanded" or "contracted" will be sent
114 from the genlist with a pointer to the item that
115 has been expanded/contracted.
116
117 Calling this function won't show or hide any child
118 of this item (if it is a parent). You must manually
119 delete and create them on the callbacks of
120 the "expanded" or "contracted" signals.
121 ]]
122 }
123 values {
124 expanded: bool; [[The expanded state ($true expanded, $false not expanded).]]
125 }
126 }
127 @property expanded_depth {
128 get {
129 [[Get the depth of expanded item.]]
130 }
131 values {
132 depth: int; [[The depth of expanded item.]]
133 }
134 }
135 @property item_class {
136 get {
137 [[Get the Genlist Item class for the given Genlist Item.
138
139 This returns the Genlist_Item_Class for the given item.
140 It can be used to examine the function pointers and
141 item_style.
142 ]]
143 }
144 values {
145 @cref itc: Elm.Genlist.Item.Class; [[Genlist Item class for the given item.]]
146 }
147 }
148 @property index {
149 get {
150 [[Get the index of the item. It is only valid once displayed.
151
152 The index start from 1.
153 ]]
154 }
155 values {
156 index: int(-1); [[The position inside the list of item.]]
157 }
158 }
159 @property decorate_mode {
160 get {
161 [[Get the item's decorate mode.
162
163 This function just returns the name of the item's
164 decorate mode.
165 ]]
166 }
167 values {
168 decorate_it_type: string; [[Name of the item's decorate mode.]]
169 }
170 }
171 @property flip {
172 get {
173 [[Get the flip state of a given genlist item.
174
175 This function returns the flip state of a given
176 genlist item. If the parameter is invalid, it
177 returns $false.
178 ]]
179 }
180 set {
181 [[Set the flip state of a given genlist item.
182
183 This function sets the flip state of a given genlist
184 item. Flip mode overrides current item object.
185 It can be used for on-the-fly item replace.
186 Flip mode can be used with/without decorate mode.
187 ]]
188 }
189 values {
190 flip: bool; [[The flip mode.]]
191 }
192 }
193 @property select_mode {
194 get {
195 [[Get the genlist item's select mode.
196
197 It's ELM_OBJECT_SELECT_MODE_MAX on failure.
198 ]]
199 }
200 set {
201 [[Set the genlist item's select mode.
202
203 ELM_OBJECT_SELECT_MODE_DEFAULT means that the item
204 will only call their selection func and callback
205 when first becoming selected. Any further clicks will
206 do nothing, unless you set always select mode.
207
208 ELM_OBJECT_SELECT_MODE_ALWAYS means that even if
209 selected, every click will make the selected
210 callbacks be called.
211
212 ELM_OBJECT_SELECT_MODE_NONE will turn off the ability
213 to select the item entirely and they will neither
214 appear selected nor call selected callback functions.
215
216 ELM_OBJECT_SELECT_MODE_DISPLAY_ONLY will apply
217 no-finger-size rule with ELM_OBJECT_SELECT_MODE_NONE.
218 No-finger-size rule makes an item can be smaller
219 than lower limit. Clickable objects should be bigger
220 than human touch point device (your finger) for
221 some touch or small screen devices. So it is
222 enabled, the item can be shrink than predefined
223 finger-size value. And the item will be updated.
224 ]]
225 }
226 values {
227 mode: Elm.Object.Select_Mode(Elm.Object.Select_Mode.max); [[The selected mode.]]
228 }
229 }
230 @property type {
231 get {
232 [[Get the Item's type.
233
234 This function returns the item's type. Normally the
235 item's type. If it failed, return value is
236 ELM_GENLIST_ITEM_MAX.
237 ]]
238 }
239 values {
240 type: Elm.Genlist.Item.Type(Elm.Genlist.Item.Type.max); [[Item type.]]
241 }
242 }
243 @property pin {
244 get {
245 [[Get whether a given genlist item is pinned or not.]]
246 }
247 set {
248 [[Set whether a given genlist item is pinned or not
249
250 This sets a genlist item as pinned so that it will be always available in
251 the viewport available for user interaction. Group items cannot be pinned.
252 Also when a new item is pinned, the current pinned item will get unpinned.
253 Item pinning cannot be done in reorder mode too.
254 ]]
255 }
256 values {
257 pin: bool; [[The item pin state state ($true pin item, $false unpin item).]]
258 }
259 }
260 /* init { FIXME
261 params {
262 Evas_Smart_Cb func;
263 const(void_ptr) data;
264 }
265 }*/
266 subitems_count {
267 [[Get the number of subitems of a given item.
268
269 This returns the number of subitems that an item possesses.
270
271 @since 1.9
272 ]]
273 return: uint; [[The number of subitems, 0 on error.]]
274 }
275 subitems_clear{
276 [[Remove all sub-items (children) of the given item.
277
278 This removes all items that are children (and their
279 descendants) of the given item $it.
280 ]]
281 }
282 promote {
283 [[Promote an item to the top of the list.]]
284 }
285 demote {
286 [[Demote an item to the end of the list.]]
287 }
288 show {
289 [[Show the portion of a genlist's internal list containing
290 a given item, immediately.
291
292 This causes genlist to jump to the given item $it and
293 show it (by jumping to that position), if it is not
294 fully visible.
295 ]]
296 params {
297 @in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
298 \@ref Elm_Genlist_Item_Scrollto_Type.]]
299 }
300 }
301 bring_in {
302 [[Animatedly bring in, to the visible area of a genlist, a
303 given item on it.
304
305 This causes genlist to jump to the given item $it and
306 show it (by animatedly scrolling), if it is not fully
307 visible. This may use animation and take a some time
308 to do so.
309 ]]
310 params {
311 @in type: Elm.Genlist.Item.Scrollto_Type; [[The position to bring in, the given item to.
312 \@ref Elm_Genlist_Item_Scrollto_Type.]]
313 }
314 }
315 all_contents_unset {
316 [[Unset all contents fetched by the item class.
317
318 This instructs genlist to release references to contents
319 in the item, meaning that they will no longer be managed
320 by genlist and are floating "orphans" that can be re-used
321 elsewhere if the user wants to.
322 ]]
323 params {
324 @out l: list<Efl.Canvas.Object> @owned; [[The contents list to return.]]
325 }
326 }
327 update {
328 [[Update all the contents of an item.
329
330 This updates an item by calling all the item class
331 functions again to get the contents, texts and states.
332 Use this when the original item data has changed and the
333 changes are desired to be reflected.
334
335 Use elm_genlist_realized_items_update() to update all
336 already realized items.
337
338 Note: This also updates internal genlist item object
339 (edje_object as of now). So when this is called between
340 mouse down and mouse up, mouse up event will be ignored
341 because edje_object is deleted and created again by this
342 API. If you want to avoid this, please use
343 \@ref elm_genlist_item_fields_update.
344 ]]
345 }
346 fields_update {
347 [[Update the part of an item.
348
349 This updates an item's part by calling item's fetching
350 functions again to get the contents, texts and states.
351 Use this when the original item data has changed and the
352 changes are desired to be reflected. Second part
353 argument is used for globbing to match '*', '?', and '.'
354 It can be used at updating multi fields.
355
356 Use \@ref elm_genlist_realized_items_update to update an
357 item's all property.
358 ]]
359 params {
360 @in parts: string; [[The name of item's part.]]
361 @in itf: Elm.Genlist.Item.Field_Type; [[The type of item's part type.]]
362 }
363 }
364 item_class_update {
365 [[Update the item class of an item.
366
367 This sets another class of the item, changing the way
368 that it is displayed. After changing the item class
369 @.update is called on the item $it.
370 ]]
371 params {
372 @cref itc: Elm.Genlist.Item.Class; [[The item class for the item.]]
373 }
374 }
375 decorate_mode_set {
376 [[Activate a genlist mode on an item.
377
378 A genlist mode is a different way of selecting an item.
379 Once a mode is activated on an item, any other selected
380 item is immediately unselected. This feature provides an
381 easy way of implementing a new kind of animation for
382 selecting an item, without having to entirely rewrite
383 the item style theme. However, the elm_genlist_selected_*
384 API can't be used to get what item is activate for a mode.
385
386 The current item style will still be used, but applying
387 a genlist mode to an item will select it using a
388 different kind of animation.
389
390 The current active item for a mode can be found by
391 \@ref elm_genlist_decorated_item_get.
392
393 Only one mode can be active at any time, and for only one
394 item. Genlist handles deactivating other items when one
395 item is activated. A mode is defined in the genlist theme
396 (edc), and more modes can easily be added. A mode style
397 and the genlist item style are different things. They
398 can be combined to provide a default style to the item,
399 with some kind of animation for that item when the mode
400 is activated.
401
402 When a mode is activated on an item, a new view for that
403 item is created. The theme of this mode defines the
404 animation that will be used to transit the item from
405 the old view to the new view. This second (new) view will
406 be active for that item while the mode is active on the
407 item, and will be destroyed after the mode is totally
408 deactivated from that item.
409 ]]
410 params {
411 @in decorate_it_type: string; [[Mode name.]]
412 @in decorate_it_set: bool; [[Boolean to define set or unset mode.]]
413 }
414 }
415 }
416 implements {
417 Efl.Object.constructor;
418 Elm.Widget.Item.del_pre;
419 Elm.Widget.Item.disable;
420 Elm.Widget.Item.signal_emit;
421 Elm.Widget.Item.style { get; set; }
422 Elm.Widget.Item.item_focus { get; set; }
423 Elm.Widget.Item.part_text { get; }
424 Elm.Widget.Item.part_content { get; }
425 Elm.Widget.Item.tooltip_text_set;
426 Elm.Widget.Item.tooltip_style { get; set; }
427 Elm.Widget.Item.tooltip_window_mode { get; set; }
428 Elm.Widget.Item.tooltip_content_cb_set;
429 Elm.Widget.Item.tooltip_unset;
430 Elm.Widget.Item.cursor { set; }
431 Elm.Widget.Item.cursor_unset;
432 Efl.Access.Object.i18n_name { get; }
433 Efl.Access.Object.state_set { get; }
434 Efl.Ui.Focus.Object.setup_order_non_recursive;
435 Efl.Ui.Focus.Object.focus_parent { get; }
436 }
437}