summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Hacohen <tom@stosb.com>2015-08-06 14:59:32 +0100
committerTom Hacohen <tom@stosb.com>2015-08-06 15:09:45 +0100
commit3ae413c1e69d60ce73dd0427cf32e4f037105d0a (patch)
tree8c2c17453f90590a16f4cb5c3bfdb6c3a4d1db85
parentd353b88625b96b52b55abe8a1ab90e423b8551b3 (diff)
Elm index item: migrate docs.
-rw-r--r--src/lib/elm_index_item.eo49
1 files changed, 16 insertions, 33 deletions
diff --git a/src/lib/elm_index_item.eo b/src/lib/elm_index_item.eo
index 3cfe709de..36d490ade 100644
--- a/src/lib/elm_index_item.eo
+++ b/src/lib/elm_index_item.eo
@@ -4,55 +4,38 @@ class Elm.Index_Item(Elm.Widget_Item)
4 methods { 4 methods {
5 @property selected { 5 @property selected {
6 set { 6 set {
7 /*@ 7 [[Set the selected state of an item.
8 Set the selected state of an item.
9 8
10 This sets the selected state of the given item @p it. 9 This sets the selected state of the given item $it.
11 @c EINA_TRUE for selected, @c EINA_FALSE for not selected. 10 $true for selected, $false for not selected.
12 11
13 If a new item is selected the previously selected will be unselected. 12 If a new item is selected the previously selected will be unselected.
14 Previously selected item can be get with function 13 Previously selected item can be get with function
15 elm_index_selected_item_get(). 14 elm_index_selected_item_get().
16 15
17 Selected items will be highlighted. 16 Selected items will be highlighted.]]
18
19 @see elm_index_selected_item_get()
20
21 @ingroup Index
22 */
23 } 17 }
24 values { 18 values {
25 selected: bool; /*@ EINA_TRUE if selected EINA_FALSE otherwise */ 19 selected: bool; [[$true if selected, $false otherwise]]
26 } 20 }
27 } 21 }
28 @property priority { 22 @property priority {
29 set { 23 set {
30 /*@ 24 [[Sets the priority of an item.
31 Sets the priority of an item.
32
33 The priority is @c -1 by default, which means that the item doesn't belong to a group.
34 The value of the priority starts from @c 0.
35 25
36 In elm_index_level_go, the items are sorted in ascending order according to priority. 26 The priority is -1 by default, which means that the item doesn't belong to a group.
37 Items of the same priority make a group and the primary group is shown by default. 27 The value of the priority starts from 0.
38 28
39 @see elm_index_item_priority_get() 29 In elm_index_level_go, the items are sorted in ascending order according to priority.
40 30 Items of the same priority make a group and the primary group is shown by default.]]
41 @ingroup Index
42 */
43 } 31 }
44 values { 32 values {
45 priority: int; /*@ The priority */ 33 priority: int; [[The priority]]
46 } 34 }
47 } 35 }
48 letter_get @const { 36 letter_get @const {
49 /*@ 37 [[Get the letter (string) set on a given index widget item.]]
50 Get the letter (string) set on a given index widget item. 38 return: const (char)*; [[The letter string set on $item]]
51 @return The letter string set on @p item
52
53 @ingroup Index
54 */
55 return: const (char)*;
56 } 39 }
57 } 40 }
58 implements { 41 implements {