summaryrefslogtreecommitdiff
path: root/src/lib/elementary/elm_slideshow.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/elementary/elm_slideshow.eo')
-rw-r--r--src/lib/elementary/elm_slideshow.eo316
1 files changed, 0 insertions, 316 deletions
diff --git a/src/lib/elementary/elm_slideshow.eo b/src/lib/elementary/elm_slideshow.eo
deleted file mode 100644
index 97cf3cf..0000000
--- a/src/lib/elementary/elm_slideshow.eo
+++ /dev/null
@@ -1,316 +0,0 @@
1type Elm_Slideshow_Item_Class: __undefined_type; [[Elementary slideshow item class type]]
2
3class Elm.Slideshow extends Efl.Ui.Layout implements Efl.Access.Widget.Action, Efl.Ui.Legacy
4{
5 [[Elementary slideshow class]]
6 eo_prefix: elm_obj_slideshow;
7 legacy_prefix: elm_slideshow;
8 event_prefix: elm_slideshow;
9 methods {
10 @property cache_after {
11 set {
12 [[Set the number of items to cache, on a given slideshow widget,
13 after the current item.
14
15 The default value for this property is 2. See
16 \@ref Slideshow_Caching "slideshow caching" for more details.
17 ]]
18 }
19 get {
20 [[Get the number of items to cache, on a given slideshow widget,
21 after the current item.
22 ]]
23 }
24 values {
25 count: int; [[Number of items to cache after the current one.]]
26 }
27 }
28 @property cache_before {
29 set {
30 [[Set the number of items to cache, on a given slideshow widget,
31 before the current item.
32
33 The default value for this property is 2. See
34 \@ref Slideshow_Caching "slideshow caching" for more details.
35 ]]
36 }
37 get {
38 [[Get the number of items to cache, on a given slideshow widget,
39 before the current item.
40 ]]
41 }
42 values {
43 count: int; [[Number of items to cache before the current one.]]
44 }
45 }
46 @property layout {
47 set {
48 [[Set the current slide layout in use for a given slideshow widget
49
50 If $layout is implemented in $obj's theme (i.e., is contained
51 in the list returned by elm_slideshow_layouts_get()), this new
52 images layout will be used on the widget.
53
54 See @.layouts.get for more details.
55 ]]
56 }
57 get {
58 [[Get the current slide layout in use for a given slideshow widget.]]
59 }
60 values {
61 layout: string; [[The new layout's name string.]]
62 }
63 }
64 @property transition {
65 set {
66 [[Set the current slide transition/effect in use for a given
67 slideshow widget.
68
69 If $transition is implemented in $obj's theme (i.e., is
70 contained in the list returned by @.transitions.get), this
71 new sliding effect will be used on the widget.
72 ]]
73 }
74 get {
75 [[Get the current slide transition/effect in use for a given
76 slideshow widget.
77 ]]
78 }
79 values {
80 transition: string @nullable; [[The new transition's name string.]]
81 }
82 }
83 @property items_loop {
84 set {
85 [[Set if the slideshow items should be displayed cyclically or not,
86 so when the end is reached it will restart from the first item.
87
88 Note: This will affect the "automatic" slidshow behaviour and the
89 @.next and @.previous functions as well.
90 ]]
91 legacy: elm_slideshow_loop_set;
92 }
93 get {
94 [[Get if, after a slideshow is started, for a given slideshow
95 widget, its items are to be displayed cyclically or not.
96 ]]
97 legacy: elm_slideshow_loop_get;
98 }
99 values {
100 loop: bool; [[Use $true to make it cycle through items or
101 $false for it to stop at the end of $obj's
102 internal list of items.]]
103 }
104 }
105 @property timeout {
106 set {
107 [[Set the interval between each image transition on a given
108 slideshow widget and start the slideshow itself.
109
110 After this call, the slideshow widget will start cycling its
111 view, sequentially and automatically, with the images of the
112 items it has. The time between each new image displayed is
113 going to be $timeout, in seconds. If a different timeout was
114 set previously and an slideshow was in progress, it will
115 continue with the new time between transitions, after this call.
116
117 Note: A value less than or equal to 0 on $timeout will disable
118 the widget's internal timer, thus halting any slideshow which
119 could be happening on $obj.
120 ]]
121 }
122 get {
123 [[Get the interval set for image transitions on a given
124 slideshow widget.
125 ]]
126 }
127 values {
128 timeout: double; [[The new displaying timeout for images.]]
129 }
130 }
131 @property items {
132 get {
133 [[Get the internal list of items in a given slideshow widget.
134
135 This list is not to be modified in any way and must not be
136 freed.
137
138 Warning: This list is only valid until $obj object's internal
139 items list is changed. It should be fetched again with another
140 call to this function when changes happen.
141 ]]
142 return: const(list<Elm.Widget.Item>); [[
143 The list of items (#Elm.Widget.Item as data) or $null on
144 errors.
145 ]]
146 }
147 }
148 @property transitions {
149 get {
150 [[Returns the list of sliding transition/effect names available,
151 for a given slideshow widget.
152
153 The transitions, which come from $obj's theme, must be an EDC
154 data item named $"transitions" on the theme file, with (prefix)
155 names of EDC programs actually implementing them.
156
157 The available transitions for slideshows on the default theme
158 are "fade" (the current item fades out, while the new one
159 fades in to the slideshow's viewport), "black_fade" (the
160 current item fades to black, and just then, the new item
161 will fade in), "horizontal" (the current item slides
162 horizontally, until it gets out of the slideshow's viewport,
163 while the new item comes from the left to take its place),
164 "vertical" (the current item slides vertically, until it
165 gets out of the slideshow's viewport, while the new item
166 comes from the bottom to take its place), "square" (the
167 new item starts to appear from the middle of the current
168 one, but with a tiny size, growing until its target (full)
169 size and covering the old one.
170
171 Warning: The stringshared strings get no new references
172 exclusive to the user grabbing the list, here, so if you'd
173 like to use them out of this call's context, you'd better
174 \@ref eina_stringshare_ref them. Also the list is an internal
175 list and so is only valid for as long as the slideshow object
176 is valid and has not internally changed its list for some
177 reason, so make a copy if you need it around.
178 ]]
179 return: const(list<string>); [[
180 The list of transitions (list of stringshared strings
181 as data).
182 ]]
183 }
184 }
185 @property count {
186 get {
187 [[Get the number of items stored in a given slideshow widget.]]
188 return: uint; [[The number of items on $obj, at the moment of this call.]]
189 }
190 }
191 @property item_current {
192 get {
193 [[Returns the currently displayed item, in a given slideshow widget.]]
194 return: Elm.Widget.Item; [[A handle to the item being displayed
195 in $obj or $null, if none is (and
196 on errors)]]
197 }
198 }
199 @property layouts {
200 get {
201 [[Returns the list of layout names available, for a given
202 slideshow widget.
203
204 Slideshow layouts will change how the widget is to dispose
205 each image item in its viewport, with regard to cropping,
206 scaling, etc.
207
208 The layouts, which come from $obj's theme, must be an EDC
209 data item name $"layouts" on the theme file, with (prefix)
210 names of EDC programs actually implementing them.
211
212 The available layouts for slideshows on the default theme are
213 "fullscreen" (item images with original aspect, scaled to
214 touch top and down slideshow borders or, if the image's height
215 is not enough, left and right slideshow borders) and
216 "not_fullscreen" (the same behavior as the "fullscreen"
217 one, but always leaving 10% of the slideshow's dimensions of
218 distance between the item image's borders and the slideshow
219 borders, for each axis)-
220
221 Warning: The stringshared strings get no new references
222 exclusive to the user grabbing the list, here, so if you'd
223 like to use them out of this call's context, you'd better
224 \@ref eina_stringshare_ref them.
225 ]]
226 return: const(list<string>); [[
227 The list of layouts (list of stringshared strings as data)
228 ]]
229 }
230 }
231 previous {
232 [[Slide to the previous item, in a given slideshow widget
233
234 The sliding animation $obj is set to use will be the
235 transition effect used, after this call is issued.
236
237 Note: If the beginning of the slideshow's internal list of items
238 is reached, it'll wrap around to the list's end, again.
239 ]]
240 }
241 item_nth_get @const {
242 [[Get the the item, in a given slideshow widget, placed at
243 position $nth, in its internal items list.
244 ]]
245 return: Elm.Widget.Item; [[The item stored in $obj at position
246 $nth or $null if there's no item with
247 that index (and on errors).]]
248 params {
249 @in nth: uint; [[The number of the item to grab a handle to
250 (0 being the first).]]
251 }
252 }
253 next {
254 [[Slide to the next item, in a given slideshow widget.
255
256 The sliding animation $obj is set to use will be the
257 transition effect used, after this call is issued.
258
259 Note: If the end of the slideshow's internal list of items is
260 reached, it'll wrap around to the list's beginning, again.
261 ]]
262 }
263 clear {
264 [[Remove all items from a given slideshow widget.
265
266 This removes (and deletes) all items in $obj, leaving it empty.
267 ]]
268 }
269 item_add {
270 [[Add (append) a new item in a given slideshow widget.
271
272 Add a new item to $obj's internal list of items, appending it.
273 The item's class must contain the function really fetching the
274 image object to show for this item, which could be an Evas image
275 object or an Elementary photo, for example. The $data
276 parameter is going to be passed to both class functions of the
277 item.
278 ]]
279 return: Elm.Widget.Item; [[A handle to the item added or $null on errors.]]
280 params {
281 @cref itc: Elm_Slideshow_Item_Class; [[The item class for the item.]]
282 @in data: const(void_ptr); [[The item's data.]]
283 }
284 }
285 item_sorted_insert {
286 [[Insert a new item into the given slideshow widget, using the
287 $func function to sort items (by item handles).
288
289 Add a new item to $obj's internal list of items, in a position
290 determined by the $func comparing function. The item's class
291 must contain the function really fetching the image object to
292 show for this item, which could be an Evas image object or an
293 Elementary photo, for example. The $data parameter is going to
294 be passed to both class functions of the item.
295 ]]
296 return: Elm.Widget.Item; [[Returns The slideshow item handle,
297 on success, or $null on errors.]]
298 params {
299 @cref itc: Elm_Slideshow_Item_Class; [[The item class for the item.]]
300 @in data: const(void_ptr); [[The item's data.]]
301 @in func: Eina_Compare_Cb; [[The comparing function to be used to sort the slideshow
302 items by #Elm_Slideshow_Item_Class item handles.]]
303 }
304 }
305 }
306 implements {
307 class.constructor;
308 Efl.Object.constructor;
309 Efl.Ui.Widget.widget_event;
310 Efl.Access.Widget.Action.elm_actions { get; }
311 }
312 events {
313 changed: Efl.Object; [[Called when slideshow widget changed]]
314 transition,end: Efl.Object; [[Called on transition end]]
315 }
316}