summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 13:50:21 +0100
committerDaniel Kolesa <d.kolesa@osg.samsung.com>2015-08-07 13:50:21 +0100
commit5ef1c3bfc93b613e7a3a4f3ad0a2031755a6d073 (patch)
tree66e0e7d5a6c9a599282754b3e59d7cf8e4290031
parent3548e0b4d5fed67eb1aeba77fede444e3fc77ae8 (diff)
slideshow: convert docs
-rw-r--r--src/lib/elm_slideshow.eo510
1 files changed, 197 insertions, 313 deletions
diff --git a/src/lib/elm_slideshow.eo b/src/lib/elm_slideshow.eo
index d113b1c0b..8e0f91448 100644
--- a/src/lib/elm_slideshow.eo
+++ b/src/lib/elm_slideshow.eo
@@ -4,412 +4,296 @@ class Elm.Slideshow (Elm.Layout, Elm_Interface_Atspi_Widget_Action)
4 methods { 4 methods {
5 @property cache_after { 5 @property cache_after {
6 set { 6 set {
7 /*@ 7 [[Set the number of items to cache, on a given slideshow widget,
8 Set the number of items to cache, on a given slideshow widget, 8 after the current item.
9 <b>after the current item</b>
10 9
11 The default value for this property is $2. See 10 The default value for this property is 2. See
12 @ref Slideshow_Caching "slideshow caching" for more details. 11 \@ref Slideshow_Caching "slideshow caching" for more details.
13 12 ]]
14 @see elm_slideshow_cache_after_get()
15
16 @ingroup Slideshow */
17 } 13 }
18 get { 14 get {
19 /*@ 15 [[Get the number of items to cache, on a given slideshow widget,
20 Get the number of items to cache, on a given slideshow widget, 16 after the current item.
21 <b>after the current item</b> 17 ]]
22
23 @return The number of items set to be cached after the current one
24
25 @see elm_slideshow_cache_after_set() for more details
26
27 @ingroup Slideshow */
28 } 18 }
29 values { 19 values {
30 count: int; /*@ Number of items to cache after the current one */ 20 count: int; [[Number of items to cache after the current one.]]
31 } 21 }
32 } 22 }
33 @property cache_before { 23 @property cache_before {
34 set { 24 set {
35 /*@ 25 [[Set the number of items to cache, on a given slideshow widget,
36 Set the number of items to cache, on a given slideshow widget, 26 before the current item.
37 <b>before the current item</b>
38 27
39 The default value for this property is $2. See 28 The default value for this property is 2. See
40 @ref Slideshow_Caching "slideshow caching" for more details. 29 \@ref Slideshow_Caching "slideshow caching" for more details.
41 30 ]]
42 @see elm_slideshow_cache_before_get()
43
44 @ingroup Slideshow */
45 } 31 }
46 get { 32 get {
47 /*@ 33 [[Get the number of items to cache, on a given slideshow widget,
48 Get the number of items to cache, on a given slideshow widget, 34 before the current item.
49 <b>before the current item</b> 35 ]]
50
51 @return The number of items set to be cached before the current one
52
53 @see elm_slideshow_cache_before_set() for more details
54
55 @ingroup Slideshow */
56 } 36 }
57 values { 37 values {
58 count: int; /*@ Number of items to cache before the current one */ 38 count: int; [[Number of items to cache before the current one.]]
59 } 39 }
60 } 40 }
61 @property layout { 41 @property layout {
62 set { 42 set {
63 /*@ 43 [[Set the current slide layout in use for a given slideshow widget
64 Set the current slide layout in use for a given slideshow widget
65
66 If $layout is implemented in $obj's theme (i.e., is contained
67 in the list returned by elm_slideshow_layouts_get()), this new
68 images layout will be used on the widget.
69 44
70 @see elm_slideshow_layouts_get() for more details 45 If $layout is implemented in $obj's theme (i.e., is contained
46 in the list returned by elm_slideshow_layouts_get()), this new
47 images layout will be used on the widget.
71 48
72 @ingroup Slideshow */ 49 See @.layouts.get for more details.
50 ]]
73 } 51 }
74 get { 52 get {
75 /*@ 53 [[Get the current slide layout in use for a given slideshow widget.]]
76 Get the current slide layout in use for a given slideshow widget
77
78 @return The current layout's name
79
80 @see elm_slideshow_layout_set() for more details
81
82 @ingroup Slideshow */
83 } 54 }
84 values { 55 values {
85 layout: const(char)*; /*@ The new layout's name string */ 56 layout: const(char)*; [[The new layout's name string.]]
86 } 57 }
87 } 58 }
88 @property transition { 59 @property transition {
89 set { 60 set {
90 /*@ 61 [[Set the current slide transition/effect in use for a given
91 Set the current slide transition/effect in use for a given 62 slideshow widget.
92 slideshow widget
93 63
94 If $transition is implemented in $obj's theme (i.e., is 64 If $transition is implemented in $obj's theme (i.e., is
95 contained in the list returned by 65 contained in the list returned by @.transitions.get), this
96 elm_slideshow_transitions_get()), this new sliding effect will 66 new sliding effect will be used on the widget.
97 be used on the widget. 67 ]]
98
99 @see elm_slideshow_transitions_get() for more details
100
101 @ingroup Slideshow */
102 } 68 }
103 get { 69 get {
104 /*@ 70 [[Get the current slide transition/effect in use for a given
105 Get the current slide transition/effect in use for a given 71 slideshow widget.
106 slideshow widget 72 ]]
107
108 @return The current transition's name
109
110 @see elm_slideshow_transition_set() for more details
111
112 @ingroup Slideshow */
113 } 73 }
114 values { 74 values {
115 transition: const(char)* @nullable; /*@ The new transition's name string */ 75 transition: const(char)* @nullable; [[The new transition's name string.]]
116 } 76 }
117 } 77 }
118 @property loop { 78 @property loop {
119 set { 79 set {
120 /*@ 80 [[Set if, after a slideshow is started, for a given slideshow
121 Set if, after a slideshow is started, for a given slideshow 81 widget, its items should be displayed cyclically or not.
122 widget, its items should be displayed cyclically or not.
123
124 @note elm_slideshow_next() and elm_slideshow_previous() will @b
125 ignore what is set by this functions, i.e., they'll @b always
126 cycle through items. This affects only the "automatic"
127 slideshow, as set by elm_slideshow_timeout_set().
128
129 @see elm_slideshow_loop_get()
130 82
131 @ingroup Slideshow */ 83 Note: @.next and @.previous will ignore what is set by this
84 functions, i.e., they'll always cycle through items. This
85 affects only the "automatic" slideshow, as set by @.timeout.set.
86 ]]
132 } 87 }
133 get { 88 get {
134 /*@ 89 [[Get if, after a slideshow is started, for a given slideshow
135 Get if, after a slideshow is started, for a given slideshow 90 widget, its items are to be displayed cyclically or not.
136 widget, its items are to be displayed cyclically or not. 91 ]]
137
138 @return $true, if the items in $obj will be cycled
139 through or $false, otherwise
140
141 @see elm_slideshow_loop_set() for more details
142
143 @ingroup Slideshow */
144 } 92 }
145 values { 93 values {
146 loop: bool; /*@ Use $true to make it cycle through items or 94 loop: bool; [[Use $true to make it cycle through items or
147 $false for it to stop at the end of $obj's internal 95 $false for it to stop at the end of $obj's
148 list of items */ 96 internal list of items.]]
149 } 97 }
150 } 98 }
151 @property timeout { 99 @property timeout {
152 set { 100 set {
153 /*@ 101 [[Set the interval between each image transition on a given
154 Set the interval between each image transition on a given 102 slideshow widget and start the slideshow itself.
155 slideshow widget, <b>and start the slideshow, itself</b> 103
156 104 After this call, the slideshow widget will start cycling its
157 After this call, the slideshow widget will start cycling its 105 view, sequentially and automatically, with the images of the
158 view, sequentially and automatically, with the images of the 106 items it has. The time between each new image displayed is
159 items it has. The time between each new image displayed is going 107 going to be $timeout, in seconds. If a different timeout was
160 to be $timeout, in @b seconds. If a different timeout was set 108 set previously and an slideshow was in progress, it will
161 previously and an slideshow was in progress, it will continue 109 continue with the new time between transitions, after this call.
162 with the new time between transitions, after this call. 110
163 111 Note: A value less than or equal to 0 on $timeout will disable
164 @note A value less than or equal to 0 on $timeout will disable 112 the widget's internal timer, thus halting any slideshow which
165 the widget's internal timer, thus halting any slideshow which 113 could be happening on $obj.
166 could be happening on $obj. 114 ]]
167
168 @see elm_slideshow_timeout_get()
169
170 @ingroup Slideshow */
171 } 115 }
172 get { 116 get {
173 /*@ 117 [[Get the interval set for image transitions on a given
174 Get the interval set for image transitions on a given slideshow 118 slideshow widget.
175 widget. 119 ]]
176
177 @return Returns the timeout set on it or -1.0, on errors
178
179 @see elm_slideshow_timeout_set() for more details
180
181 @ingroup Slideshow */
182 } 120 }
183 values { 121 values {
184 timeout: double; /*@ The new displaying timeout for images */ 122 timeout: double; [[The new displaying timeout for images.]]
185 } 123 }
186 } 124 }
187 @property items { 125 @property items {
188 get { 126 get {
189 /*@ 127 [[Get the internal list of items in a given slideshow widget.
190 Get the internal list of items in a given slideshow widget. 128
191 129 This list is not to be modified in any way and must not be
192 @return The list of items (#Elm.Widget_Item as data) or 130 freed.
193 $NULL on errors. 131
194 132 Warning: This list is only valid until $obj object's internal
195 This list is @b not to be modified in any way and must not be 133 items list is changed. It should be fetched again with another
196 freed. Use the list members with functions like 134 call to this function when changes happen.
197 elm_object_item_del(), elm_object_item_data_get(). 135 ]]
198 136 return: const(list<Elm.Widget_Item *>)*; [[
199 @warning This list is only valid until $obj object's internal 137 The list of items (#Elm.Widget_Item as data) or $null on
200 items list is changed. It should be fetched again with another 138 errors.
201 call to this function when changes happen. 139 ]]
202
203 @ingroup Slideshow */
204 return: const(list<Elm.Widget_Item *>)*;
205 } 140 }
206 } 141 }
207 @property transitions { 142 @property transitions {
208 get { 143 get {
209 /*@ 144 [[Returns the list of sliding transition/effect names available,
210 Returns the list of sliding transition/effect names available, for a 145 for a given slideshow widget.
211 given slideshow widget. 146
212 147 The transitions, which come from $obj's theme, must be an EDC
213 @return The list of transitions (list of @b stringshared strings 148 data item named $"transitions" on the theme file, with (prefix)
214 as data) 149 names of EDC programs actually implementing them.
215 150
216 The transitions, which come from $obj's theme, must be an EDC 151 The available transitions for slideshows on the default theme
217 data item named $"transitions" on the theme file, with (prefix) 152 are "fade" (the current item fades out, while the new one
218 names of EDC programs actually implementing them. 153 fades in to the slideshow's viewport), "black_fade" (the
219 154 current item fades to black, and just then, the new item
220 The available transitions for slideshows on the default theme are: 155 will fade in), "horizontal" (the current item slides
221 - $"fade" - the current item fades out, while the new one 156 horizontally, until it gets out of the slideshow's viewport,
222 fades in to the slideshow's viewport. 157 while the new item comes from the left to take its place),
223 - $"black_fade" - the current item fades to black, and just 158 "vertical" (the current item slides vertically, until it
224 then, the new item will fade in. 159 gets out of the slideshow's viewport, while the new item
225 - $"horizontal" - the current item slides horizontally, until 160 comes from the bottom to take its place), "square" (the
226 it gets out of the slideshow's viewport, while the new item 161 new item starts to appear from the middle of the current
227 comes from the left to take its place. 162 one, but with a tiny size, growing until its target (full)
228 - $"vertical" - the current item slides vertically, until it 163 size and covering the old one.
229 gets out of the slideshow's viewport, while the new item comes 164
230 from the bottom to take its place. 165 Warning: The stringshared strings get no new references
231 - $"square" - the new item starts to appear from the middle of 166 exclusive to the user grabbing the list, here, so if you'd
232 the current one, but with a tiny size, growing until its 167 like to use them out of this call's context, you'd better
233 target (full) size and covering the old one. 168 \@ref eina_stringshare_ref them. Also the list is an internal
234 169 list and so is only valid for as long as the slideshow object
235 @warning The stringshared strings get no new references 170 is valid and has not internally changed its list for some
236 exclusive to the user grabbing the list, here, so if you'd like 171 reason, so make a copy if you need it around.
237 to use them out of this call's context, you'd better @c 172 ]]
238 eina_stringshare_ref() them. Also the list is an internal list and 173 return: const(list<const(char)*>)*; [[
239 so is only valid for as long as the slideshow object is valid and 174 The list of transitions (list of stringshared strings
240 has not internally changed its list for some reason, so make a 175 as data).
241 copy if you need it around. 176 ]]
242
243 @see elm_slideshow_transition_set()
244
245 @ingroup Slideshow */
246 return: const(list<const(char)*>)*;
247 } 177 }
248 } 178 }
249 @property count { 179 @property count {
250 get { 180 get {
251 /*@ 181 [[Get the number of items stored in a given slideshow widget.]]
252 Get the number of items stored in a given slideshow widget 182 return: uint; [[The number of items on $obj, at the moment of this call.]]
253
254 @return The number of items on $obj, at the moment of this call
255
256 @ingroup Slideshow */
257 return: uint;
258 } 183 }
259 } 184 }
260 @property item_current { 185 @property item_current {
261 get { 186 get {
262 /*@ 187 [[Returns the currently displayed item, in a given slideshow widget.]]
263 Returns the currently displayed item, in a given slideshow widget 188 return: Elm.Widget_Item *; [[A handle to the item being displayed
264 189 in $obj or $null, if none is (and
265 @return A handle to the item being displayed in $obj or 190 on errors)]]
266 $NULL, if none is (and on errors)
267
268 @ingroup Slideshow */
269 return: Elm.Widget_Item *;
270 } 191 }
271 } 192 }
272 @property layouts { 193 @property layouts {
273 get { 194 get {
274 /*@ 195 [[Returns the list of layout names available, for a given
275 Returns the list of @b layout names available, for a given 196 slideshow widget.
276 slideshow widget. 197
277 198 Slideshow layouts will change how the widget is to dispose
278 @return The list of layouts (list of @b stringshared strings 199 each image item in its viewport, with regard to cropping,
279 as data) 200 scaling, etc.
280 201
281 Slideshow layouts will change how the widget is to dispose each 202 The layouts, which come from $obj's theme, must be an EDC
282 image item in its viewport, with regard to cropping, scaling, 203 data item name $"layouts" on the theme file, with (prefix)
283 etc. 204 names of EDC programs actually implementing them.
284 205
285 The layouts, which come from $obj's theme, must be an EDC 206 The available layouts for slideshows on the default theme are
286 data item name $"layouts" on the theme file, with (prefix) 207 "fullscreen" (item images with original aspect, scaled to
287 names of EDC programs actually implementing them. 208 touch top and down slideshow borders or, if the image's height
288 209 is not enough, left and right slideshow borders) and
289 The available layouts for slideshows on the default theme are: 210 "not_fullscreen" (the same behavior as the "fullscreen"
290 - $"fullscreen" - item images with original aspect, scaled to 211 one, but always leaving 10% of the slideshow's dimensions of
291 touch top and down slideshow borders or, if the image's height 212 distance between the item image's borders and the slideshow
292 is not enough, left and right slideshow borders. 213 borders, for each axis)-
293 - $"not_fullscreen" - the same behavior as the $"fullscreen" 214
294 one, but always leaving 10% of the slideshow's dimensions of 215 Warning: The stringshared strings get no new references
295 distance between the item image's borders and the slideshow 216 exclusive to the user grabbing the list, here, so if you'd
296 borders, for each axis. 217 like to use them out of this call's context, you'd better
297 218 \@ref eina_stringshare_ref them.
298 @warning The stringshared strings get no new references 219 ]]
299 exclusive to the user grabbing the list, here, so if you'd like 220 return: const(list<const(char)*>)*; [[
300 to use them out of this call's context, you'd better @c 221 The list of layouts (list of stringshared strings as data)
301 eina_stringshare_ref() them. 222 ]]
302
303 @see elm_slideshow_layout_set()
304
305 @ingroup Slideshow */
306 return: const(list<const(char)*>)*;
307 } 223 }
308 } 224 }
309 previous { 225 previous {
310 /*@ 226 [[Slide to the previous item, in a given slideshow widget
311 Slide to the @b previous item, in a given slideshow widget
312
313 The sliding animation $obj is set to use will be the
314 transition effect used, after this call is issued.
315
316 @note If the beginning of the slideshow's internal list of items
317 is reached, it'll wrap around to the list's end, again.
318 227
319 @ingroup Slideshow */ 228 The sliding animation $obj is set to use will be the
229 transition effect used, after this call is issued.
320 230
231 Note: If the beginning of the slideshow's internal list of items
232 is reached, it'll wrap around to the list's end, again.
233 ]]
321 } 234 }
322 item_nth_get @const { 235 item_nth_get @const {
323 /*@ 236 [[Get the the item, in a given slideshow widget, placed at
324 Get the the item, in a given slideshow widget, placed at 237 position $nth, in its internal items list.
325 position $nth, in its internal items list 238 ]]
326 239 return: Elm.Widget_Item *; [[The item stored in $obj at position
327 @return The item stored in $obj at position $nth or $NULL, 240 $nth or $null if there's no item with
328 if there's no item with that index (and on errors) 241 that index (and on errors).]]
329
330 @ingroup Slideshow */
331 return: Elm.Widget_Item *;
332 params { 242 params {
333 @in nth: uint; /*@ The number of the item to grab a handle to (0 being 243 @in nth: uint; [[The number of the item to grab a handle to
334 the first) */ 244 (0 being the first).]]
335 } 245 }
336 } 246 }
337 next { 247 next {
338 /*@ 248 [[Slide to the next item, in a given slideshow widget.
339 Slide to the @b next item, in a given slideshow widget
340
341 The sliding animation $obj is set to use will be the
342 transition effect used, after this call is issued.
343 249
344 @note If the end of the slideshow's internal list of items is 250 The sliding animation $obj is set to use will be the
345 reached, it'll wrap around to the list's beginning, again. 251 transition effect used, after this call is issued.
346
347 @ingroup Slideshow */
348 252
253 Note: If the end of the slideshow's internal list of items is
254 reached, it'll wrap around to the list's beginning, again.
255 ]]
349 } 256 }
350 clear { 257 clear {
351 /*@ 258 [[Remove all items from a given slideshow widget.
352 Remove all items from a given slideshow widget
353
354 This removes (and deletes) all items in $obj, leaving it
355 empty.
356
357 @see elm_object_item_del(), to remove just one item.
358
359 @ingroup Slideshow */
360 259
260 This removes (and deletes) all items in $obj, leaving it empty.
261 ]]
361 } 262 }
362 item_add { 263 item_add {
363 /*@ 264 [[Add (append) a new item in a given slideshow widget.
364 Add (append) a new item in a given slideshow widget. 265
365 266 Add a new item to $obj's internal list of items, appending it.
366 @return A handle to the item added or $NULL, on errors 267 The item's class must contain the function really fetching the
367 268 image object to show for this item, which could be an Evas image
368 Add a new item to $obj's internal list of items, appending it. 269 object or an Elementary photo, for example. The $data
369 The item's class must contain the function really fetching the 270 parameter is going to be passed to both class functions of the
370 image object to show for this item, which could be an Evas image 271 item.
371 object or an Elementary photo, for example. The $data 272 ]]
372 parameter is going to be passed to both class functions of the 273 return: Elm.Widget_Item *; [[A handle to the item added or $null on errors.]]
373 item.
374
375 @see #Elm_Slideshow_Item_Class
376 @see elm_slideshow_item_sorted_insert()
377 @see elm_object_item_data_set()
378
379 @ingroup Slideshow */
380
381 return: Elm.Widget_Item *;
382 params { 274 params {
383 @in itc: const(Elm_Slideshow_Item_Class)*; /*@ The item class for the item */ 275 @in itc: const(Elm_Slideshow_Item_Class)*; [[The item class for the item.]]
384 @in data: const(void)*; /*@ The item's data */ 276 @in data: const(void)*; [[The item's data.]]
385 } 277 }
386 } 278 }
387 item_sorted_insert { 279 item_sorted_insert {
388 /*@ 280 [[Insert a new item into the given slideshow widget, using the
389 Insert a new item into the given slideshow widget, using the $func 281 $func function to sort items (by item handles).
390 function to sort items (by item handles). 282
391 283 Add a new item to $obj's internal list of items, in a position
392 @return Returns The slideshow item handle, on success, or 284 determined by the $func comparing function. The item's class
393 $NULL, on errors 285 must contain the function really fetching the image object to
394 286 show for this item, which could be an Evas image object or an
395 Add a new item to $obj's internal list of items, in a position 287 Elementary photo, for example. The $data parameter is going to
396 determined by the $func comparing function. The item's class 288 be passed to both class functions of the item.
397 must contain the function really fetching the image object to 289 ]]
398 show for this item, which could be an Evas image object or an 290 return: Elm.Widget_Item *; [[Returns The slideshow item handle,
399 Elementary photo, for example. The $data parameter is going to 291 on success, or $null on errors.]]
400 be passed to both class functions of the item.
401
402 @see #Elm_Slideshow_Item_Class
403 @see elm_slideshow_item_add()
404
405 @ingroup Slideshow */
406
407 return: Elm.Widget_Item *;
408 params { 292 params {
409 @in itc: const(Elm_Slideshow_Item_Class)*; /*@ The item class for the item */ 293 @in itc: const(Elm_Slideshow_Item_Class)*; [[The item class for the item.]]
410 @in data: const(void)*; /*@ The item's data */ 294 @in data: const(void)*; [[The item's data.]]
411 @in func: Eina_Compare_Cb; /*@ The comparing function to be used to sort slideshow 295 @in func: Eina_Compare_Cb; [[The comparing function to be used to sort the slideshow
412 items <b>by #Elm_Slideshow_Item_Class item handles</b> */ 296 items by #Elm_Slideshow_Item_Class item handles.]]
413 } 297 }
414 } 298 }
415 } 299 }