summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVivek Ellur <vivek.ellur@samsung.com>2015-07-27 10:18:43 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-07-27 10:18:43 +0100
commit217971caccb381dc7de01fe4f3cca83f1885ff87 (patch)
tree4d9aeda03a27bb6b841f82f6482e688916b3b530
parent110fb9499fb0097a181d55960f8bac642850fe19 (diff)
elm_diskselector: convert eo docs of diskselector to new format
Summary: Converted docs of elm_diskselector.eo and elm_diskselector_item.eo to the new format Signed-off-by: Vivek Ellur <vivek.ellur@samsung.com> Reviewers: cedric, q66 Reviewed By: q66 Differential Revision: https://phab.enlightenment.org/D2864
-rw-r--r--src/lib/elm_diskselector.eo281
-rw-r--r--src/lib/elm_diskselector_item.eo74
2 files changed, 151 insertions, 204 deletions
diff --git a/src/lib/elm_diskselector.eo b/src/lib/elm_diskselector.eo
index 9c1a55fbf..d0d4d51c1 100644
--- a/src/lib/elm_diskselector.eo
+++ b/src/lib/elm_diskselector.eo
@@ -7,230 +7,189 @@ class Elm.Diskselector (Elm.Widget, Elm_Interface_Scrollable,
7 methods { 7 methods {
8 @property side_text_max_length { 8 @property side_text_max_length {
9 set { 9 set {
10 /*@ 10 [[Set the side labels max length.
11 Set the side labels max length.
12 11
13 Length is the number of characters of items' label that will be 12 Length is the number of characters of items' label that will be
14 visible when it's set on side positions. It will just crop 13 visible when it's set on side positions. It will just crop
15 the string after defined size. E.g.: 14 the string after defined size. E.g.:
16 15
17 An item with label "January" would be displayed on side position as 16 An item with label "January" would be displayed on side position as
18 "Jan" if max length is set to 3, or "Janu", if this property 17 "Jan" if max length is set to 3, or "Janu", if this property
19 is set to 4. 18 is set to 4.
20 19
21 When it's selected, the entire label will be displayed, except for 20 When it's selected, the entire label will be displayed, except for
22 width restrictions. In this case label will be cropped and "..." 21 width restrictions. In this case label will be cropped and "..."
23 will be concatenated. 22 will be concatenated.
24 23
25 Default side label max length is 3. 24 Default side label max length is 3.
26 25
27 This property will be applied over all items, included before or 26 This property will be applied over all items, included before or
28 later this function call. 27 later this function call.
29 28 ]]
30 @ingroup Diskselector */
31 } 29 }
32 get { 30 get {
33 /*@ 31 [[Get the side labels max length.
34 Get the side labels max length.
35
36 @see elm_diskselector_side_text_max_length_set() for details.
37 32
38 @return The max length defined for side labels, or 0 if not a valid 33 See also @.side_text_max_length.set for details.
39 diskselector. 34 ]]
40
41 @ingroup Diskselector */
42 } 35 }
43 values { 36 values {
44 len: int; /*@ The max length defined for side labels. */ 37 len: int; [[The max length defined for side labels.]]
45 } 38 }
46 } 39 }
47 @property round_enabled { 40 @property round_enabled {
48 set { 41 set {
49 /*@ 42 [[Enable or disable round mode.
50 Enable or disable round mode.
51
52 Disabled by default. If round mode is enabled the items list will
53 work like a circular list, so when the user reaches the last item,
54 the first one will popup.
55 43
56 @see elm_diskselector_round_enabled_get() 44 Disabled by default. If round mode is enabled the items list will
45 work like a circular list, so when the user reaches the last item,
46 the first one will popup.
57 47
58 @ingroup Diskselector */ 48 See also @.round_enabled.get.
49 ]]
59 } 50 }
60 get { 51 get {
61 /*@ 52 [[Get a value whether round mode is enabled or not.
62 Get a value whether round mode is enabled or not.
63 53
64 @see elm_diskselector_round_enabled_set() for details. 54 See also @.round_enabled.set for details.
65 55 ]]
66 @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
67 it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
68
69 @ingroup Diskselector */
70 } 56 }
71 values { 57 values {
72 enabled: bool; /*@ @c EINA_TRUE to enable round mode or @c EINA_FALSE to 58 enabled: bool; [[$true to enable round mode or $false to
73 disable it. */ 59 disable it.]]
74 } 60 }
75 } 61 }
76 @property display_item_num { 62 @property display_item_num {
77 set { 63 set {
78 /*@ 64 [[Set the number of items to be displayed.
79 Set the number of items to be displayed. 65
80 66 Default value is 3, and also it's the minimum. If $num is less
81 Default value is 3, and also it's the minimum. If @p num is less 67 than 3, it will be set to 3.
82 than 3, it will be set to 3. 68
83 69 Also, it can be set on theme, using data item $display_item_num
84 Also, it can be set on theme, using data item @c display_item_num 70 on group "elm/diskselector/item/X", where X is style set.
85 on group "elm/diskselector/item/X", where X is style set. 71 ]]
86 E.g.: 72 /* FIXME-doc
87 73 * E.g.:
88 group { name: "elm/diskselector/item/X"; 74 * group { name: "elm/diskselector/item/X";
89 data { 75 * data {
90 item: "display_item_num" "5"; 76 * item: "display_item_num" "5";
91 } 77 * }
92 78 */
93 @ingroup Diskselector */
94 } 79 }
95 get { 80 get {
96 /*@ 81 [[Get the number of items in the diskselector object.]]
97 Get the number of items in the diskselector object.
98
99 @ingroup Diskselector */
100 } 82 }
101 values { 83 values {
102 num: int; /*@ The number of items the diskselector will display. */ 84 num: int; [[The number of items the diskselector will display.]]
103 } 85 }
104 } 86 }
105 @property first_item { 87 @property first_item {
106 get { 88 get {
107 /*@ 89 [[Get the first item of the diskselector.
108 Get the first item of the diskselector.
109
110 @return The first item, or @c NULL if none.
111 90
112 The list of items follows append order. So it will return the first 91 The list of items follows append order. So it will return the first
113 item appended to the widget that wasn't deleted. 92 item appended to the widget that wasn't deleted.
114 93
115 @see elm_diskselector_item_append() 94 See also @.item_append,
116 @see elm_diskselector_items_get() 95 @.items.get.
117 96 ]]
118 @ingroup Diskselector */ 97 return: Elm_Object_Item *; [[The first item, or $null if none.]]
119 return: Elm_Object_Item *;
120 } 98 }
121 } 99 }
122 @property items { 100 @property items {
123 get { 101 get {
124 /*@ 102 [[Get a list of all the diskselector items.
125 Get a list of all the diskselector items.
126
127 @return A @c list of diskselector items, #Elm_Object_Item,
128 or @c NULL on failure.
129
130 @see elm_diskselector_item_append()
131 @see elm_object_item_del()
132 @see elm_diskselector_clear()
133 103
134 @ingroup Diskselector */ 104 See also @.item_append,
135 return: const(list<Elm.Object.Item*>)*; 105 \@ref elm_object_item_del,
106 @.clear.
107 ]]
108 return: const(list<Elm.Object.Item*>)*; [[A $list of diskselector items, or $ull on failure.]]
136 } 109 }
137 } 110 }
138 @property last_item { 111 @property last_item {
139 get { 112 get {
140 /*@ 113 [[Get the last item of the diskselector.
141 Get the last item of the diskselector.
142 114
143 @return The last item, or @c NULL if none. 115 The list of items follows append order. So it will return last first
116 item appended to the widget that wasn't deleted.
144 117
145 The list of items follows append order. So it will return last first 118 See also @.item_append,
146 item appended to the widget that wasn't deleted. 119 @.items.get.
147 120 ]]
148 @see elm_diskselector_item_append() 121 return: Elm_Object_Item *; [[The last item, or $null if none.]]
149 @see elm_diskselector_items_get()
150
151 @ingroup Diskselector */
152 return: Elm_Object_Item *;
153 } 122 }
154 } 123 }
155 @property selected_item { 124 @property selected_item {
156 get { 125 get {
157 /*@ 126 [[Get the selected item.
158 Get the selected item.
159 127
160 @return The selected diskselector item.
161 128
162 The selected item can be unselected with function 129 The selected item can be unselected with function
163 elm_diskselector_item_selected_set(), and the first item of 130 @.selected_item.set, and the first item of
164 diskselector will be selected. 131 diskselector will be selected.
165 132
166 The selected item always will be centered on diskselector, with 133 The selected item always will be centered on diskselector, with
167 full label displayed, i.e., max length set to side labels won't 134 full label displayed, i.e., max length set to side labels won't
168 apply on the selected item. More details on 135 apply on the selected item. More details on
169 elm_diskselector_side_text_max_length_set(). 136 @.side_text_max_length.set.
170 137 ]]
171 @ingroup Diskselector */ 138 return: Elm_Object_Item *; [[The selected diskselector item.]]
172 return: Elm_Object_Item *;
173 } 139 }
174 } 140 }
175 item_append { 141 item_append {
176 /*@ 142 [[Appends a new item to the diskselector object.
177 Appends a new item to the diskselector object. 143
178 144 A new item will be created and appended to the diskselector, i.e., will
179 @return The created item or @c NULL upon failure. 145 be set as last item. Also, if there is no selected item, it will
180 146 be selected. This will always happens for the first appended item.
181 A new item will be created and appended to the diskselector, i.e., will 147
182 be set as last item. Also, if there is no selected item, it will 148 If no icon is set, label will be centered on item position, otherwise
183 be selected. This will always happens for the first appended item. 149 the icon will be placed at left of the label, that will be shifted
184 150 to the right.
185 If no icon is set, label will be centered on item position, otherwise 151
186 the icon will be placed at left of the label, that will be shifted 152 Items created with this method can be deleted with
187 to the right. 153 \@ref elm_object_item_del.
188 154
189 Items created with this method can be deleted with 155 Associated $data can be properly freed when item is deleted if a
190 elm_object_item_del(). 156 callback function is set with \@ref elm_object_item_del_cb_set.
191 157
192 Associated @p data can be properly freed when item is deleted if a 158 If a function is passed as argument, it will be called every time this item
193 callback function is set with elm_object_item_del_cb_set(). 159 is selected, i.e., the user stops the diskselector with this
194 160 item on center position. If such function isn't needed, just passing
195 If a function is passed as argument, it will be called every time this item 161 $null as $func is enough. The same should be done for $data.
196 is selected, i.e., the user stops the diskselector with this 162
197 item on center position. If such function isn't needed, just passing 163 See also \@ref elm_object_item_del,
198 @c NULL as @p func is enough. The same should be done for @p data. 164 @.clear,
199 165 \@ref elm_icon_add.
200 Simple example (with no function callback or data associated): 166 ]]
201 @code 167 /* FIXME-doc
202 disk = elm_diskselector_add(win); 168 * Simple example (with no function callback or data associated):
203 ic = elm_icon_add(win); 169 * @code
204 elm_image_file_set(ic, "path/to/image", NULL); 170 * disk = elm_diskselector_add(win);
205 elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE); 171 * ic = elm_icon_add(win);
206 elm_diskselector_item_append(disk, "label", ic, NULL, NULL); 172 * elm_image_file_set(ic, "path/to/image", NULL);
207 @endcode 173 * elm_icon_resizable_set(ic, EINA_TRUE, EINA_TRUE);
208 174 * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
209 @see elm_object_item_del() 175 * @endcode
210 @see elm_diskselector_clear() 176 */
211 @see elm_icon_add()
212
213 @ingroup Diskselector */
214
215 return: Elm_Object_Item *; 177 return: Elm_Object_Item *;
216 params { 178 params {
217 @in label: const(char)*; /*@ The label of the diskselector item. */ 179 @in label: const(char)*; [[The label of the diskselector item.]]
218 @in icon: Evas.Object * @optional; /*@ The icon object to use at left side of the item. An 180 @in icon: Evas.Object * @optional; [[The icon object to use at left side of the item. An
219 icon can be any Evas object, but usually it is an icon created 181 icon can be any Evas object, but usually it is an icon created
220 with elm_icon_add(). */ 182 with elm_icon_add(). ]]
221 @in func: Evas_Smart_Cb @optional; /*@ The function to call when the item is selected. */ 183 @in func: Evas_Smart_Cb @optional; [[The function to call when the item is selected.]]
222 @in data: const(void)* @optional; /*@ The data to associate with the item for related callbacks. */ 184 @in data: const(void)* @optional; [[The data to associate with the item for related callbacks.]]
223 } 185 }
224 } 186 }
225 clear { 187 clear {
226 /*@ 188 [[Remove all diskselector's items.
227 Remove all diskselector's items.
228
229 @see elm_object_item_del()
230 @see elm_diskselector_item_append()
231
232 @ingroup Diskselector */
233 189
190 See also \@ref elm_object_item_del,
191 @.item_append.
192 ]]
234 } 193 }
235 } 194 }
236 implements { 195 implements {
diff --git a/src/lib/elm_diskselector_item.eo b/src/lib/elm_diskselector_item.eo
index 1e76d3daf..eedcfb061 100644
--- a/src/lib/elm_diskselector_item.eo
+++ b/src/lib/elm_diskselector_item.eo
@@ -4,69 +4,59 @@ class Elm.Diskselector_Item(Elm.Widget_Item)
4 methods { 4 methods {
5 @property prev { 5 @property prev {
6 get { 6 get {
7 /*@ 7 [[Get the item before $item in diskselector.
8 Get the item before @p item in diskselector.
9 8
10 The list of items follows append order. So it will return item appended 9 The list of items follows append order. So it will return item appended
11 just before @p item and that wasn't deleted. 10 just before $item and that wasn't deleted.
12 11
13 If it is the first item, @c NULL will be returned. 12 If it is the first item, $null will be returned.
14 First item can be get by elm_diskselector_first_item_get(). 13 First item can be get by \@ref elm_diskselector_first_item_get.
15 14
16 @see elm_diskselector_item_append() 15 See also \@ref elm_diskselector_item_append,
17 @see elm_diskselector_items_get() 16 \@ref elm_diskselector_items_get.
18 17 ]]
19 @ingroup Diskselector
20 */
21 } 18 }
22 values { 19 values {
23 item: Elm_Object_Item *; /*@ The item before @p item, or @c NULL if none or on failure. */ 20 item: Elm_Object_Item *; [[The item before $item, or $null if none or on failure.]]
24 } 21 }
25 } 22 }
26 @property next { 23 @property next {
27 get { 24 get {
28 /*@ 25 [[Get the item after $item in diskselector.
29 Get the item after @p item in diskselector.
30
31 The list of items follows append order. So it will return item appended
32 just after @p item and that wasn't deleted.
33 26
34 If it is the last item, @c NULL will be returned. 27 The list of items follows append order. So it will return item appended
35 Last item can be get by elm_diskselector_last_item_get(). 28 just after $item and that wasn't deleted.
36 29
37 @see elm_diskselector_item_append() 30 If it is the last item, $null will be returned.
38 @see elm_diskselector_items_get() 31 Last item can be get by \@ref elm_diskselector_last_item_get.
39 32
40 @ingroup Diskselector 33 See also \@ref elm_diskselector_item_append,
41 */ 34 \@ref elm_diskselector_items_get.
35 ]]
42 } 36 }
43 values { 37 values {
44 item: Elm_Object_Item *; /*@ The item after @p item, or @c NULL if none or on failure. */ 38 item: Elm_Object_Item *; [[The item after $item, or $null if none or on failure.]]
45 } 39 }
46 } 40 }
47 @property selected { 41 @property selected {
48 get { 42 get {
49 /*@ 43 [[Get whether the $item is selected or not.
50 Get whether the @p item is selected or not.
51 44
52 @see elm_diskselector_selected_item_set() for details. 45 See also \@ref elm_diskselector_selected_item_set for details,
53 @see elm_diskselector_item_selected_get() 46 \@ref elm_diskselector_item_selected_get.
54 47 ]]
55 @ingroup Diskselector
56 */
57 } 48 }
58 set { 49 set {
59 /*@ 50 [[Set the selected state of an item.
60 Set the selected state of an item.
61 51
62 This sets the selected state of the given item @p it. 52 This sets the selected state of the given $item as $true,
63 @c EINA_TRUE for selected, @c EINA_FALSE for not selected. 53 for selected and $false for not selected.
64 54
65 If a new item is selected the previously selected will be unselected. 55 If a new item is selected the previously selected will be unselected.
66 Previously selected item can be get with function 56 Previously selected item can be get with function
67 elm_diskselector_selected_item_get(). 57 \@ref elm_diskselector_selected_item_get.
68 58
69 If the item @p it is unselected, the first item of diskselector will 59 If the $item is unselected, the first item of diskselector will
70 be selected. 60 be selected.
71 61
72 Selected items will be visible on center position of diskselector. 62 Selected items will be visible on center position of diskselector.
@@ -74,14 +64,12 @@ class Elm.Diskselector_Item(Elm.Widget_Item)
74 diskselector will animate items until the selected item reaches center 64 diskselector will animate items until the selected item reaches center
75 position. 65 position.
76 66
77 @see elm_diskselector_item_selected_get() 67 See also \@ref elm_diskselector_item_selected_get,
78 @see elm_diskselector_selected_item_get() 68 \@ref elm_diskselector_selected_item_get.
79 69 ]]
80 @ingroup Diskselector
81 */
82 } 70 }
83 values { 71 values {
84 selected: bool; /*@ The selected state */ 72 selected: bool; [[The selected state]]
85 } 73 }
86 } 74 }
87 /* init { FIXME 75 /* init { FIXME