Data Structures | |
struct | _Elm_Slideshow_Item_Class |
member definitions of Elm_Slideshow_Item_Class More... | |
Typedefs | |
typedef Evas_Object *(* | SlideshowItemGetFunc) (void *data, Evas_Object *obj) |
Image fetching class function for slideshow item classes. More... | |
typedef void(* | SlideshowItemDelFunc) (void *data, Evas_Object *obj) |
Deletion class function for slideshow item classes. More... | |
typedef struct _Elm_Slideshow_Item_Class | Elm_Slideshow_Item_Class |
Slideshow item class definition struct. | |
typedef struct _Elm_Slideshow_Item_Class_Func | Elm_Slideshow_Item_Class_Func |
Class functions for slideshow item classes. | |
Functions | |
EOAPI void | elm_obj_slideshow_cache_after_set (int count) |
Set the number of items to cache, on a given slideshow widget, after the current item More... | |
EOAPI int | elm_obj_slideshow_cache_after_get (void) |
Get the number of items to cache, on a given slideshow widget, after the current item More... | |
EOAPI void | elm_obj_slideshow_cache_before_set (int count) |
Set the number of items to cache, on a given slideshow widget, before the current item More... | |
EOAPI int | elm_obj_slideshow_cache_before_get (void) |
Get the number of items to cache, on a given slideshow widget, before the current item More... | |
EOAPI void | elm_obj_slideshow_layout_set (const char *layout) |
Set the current slide layout in use for a given slideshow widget. More... | |
EOAPI const char * | elm_obj_slideshow_layout_get (void) |
Get the current slide layout in use for a given slideshow widget. More... | |
EOAPI void | elm_obj_slideshow_transition_set (const char *transition) |
Set the current slide transition/effect in use for a given slideshow widget. More... | |
EOAPI const char * | elm_obj_slideshow_transition_get (void) |
Get the current slide transition/effect in use for a given slideshow widget. More... | |
EOAPI void | elm_obj_slideshow_loop_set (Eina_Bool loop) |
Set if, after a slideshow is started, for a given slideshow widget, its items should be displayed cyclically or not. More... | |
EOAPI Eina_Bool | elm_obj_slideshow_loop_get (void) |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not. More... | |
EOAPI void | elm_obj_slideshow_timeout_set (double timeout) |
Set the interval between each image transition on a given slideshow widget, and start the slideshow, itself More... | |
EOAPI double | elm_obj_slideshow_timeout_get (void) |
Get the interval set for image transitions on a given slideshow widget. More... | |
EOAPI const Eina_List * | elm_obj_slideshow_items_get (void) |
Get the internal list of items in a given slideshow widget. More... | |
EOAPI const Eina_List * | elm_obj_slideshow_transitions_get (void) |
Returns the list of sliding transition/effect names available, for a given slideshow widget. More... | |
EOAPI unsigned int | elm_obj_slideshow_count_get (void) |
Get the number of items stored in a given slideshow widget. More... | |
EOAPI Elm_Object_Item * | elm_obj_slideshow_item_current_get (void) |
Returns the currently displayed item, in a given slideshow widget. More... | |
EOAPI const Eina_List * | elm_obj_slideshow_layouts_get (void) |
Returns the list of layout names available, for a given slideshow widget. More... | |
EOAPI void | elm_obj_slideshow_previous (void) |
Slide to the previous item, in a given slideshow widget. More... | |
EOAPI Elm_Object_Item * | elm_obj_slideshow_item_nth_get (unsigned int nth) |
Get the the item, in a given slideshow widget, placed at position nth , in its internal items list. More... | |
EOAPI void | elm_obj_slideshow_next (void) |
Slide to the next item, in a given slideshow widget. More... | |
EOAPI void | elm_obj_slideshow_clear (void) |
Remove all items from a given slideshow widget. More... | |
EOAPI Elm_Object_Item * | elm_obj_slideshow_item_add (const Elm_Slideshow_Item_Class *itc, const void *data) |
Add (append) a new item in a given slideshow widget. More... | |
EOAPI Elm_Object_Item * | elm_obj_slideshow_item_sorted_insert (const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) |
Insert a new item into the given slideshow widget, using the func function to sort items (by item handles). More... | |
void | elm_slideshow::previous () const |
Slide to the previous item, in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow::item_nth_get (unsigned int nth_) const |
Get the the item, in a given slideshow widget, placed at position nth , in its internal items list. More... | |
void | elm_slideshow::next () const |
Slide to the next item, in a given slideshow widget. More... | |
void | elm_slideshow::clear () const |
Remove all items from a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow::item_add (const Elm_Slideshow_Item_Class *itc_, const void *data_) const |
Add (append) a new item in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow::item_sorted_insert (const Elm_Slideshow_Item_Class *itc_, const void *data_, Eina_Compare_Cb func_) const |
Insert a new item into the given slideshow widget, using the func function to sort items (by item handles). More... | |
int | elm_slideshow::cache_after_get () const |
Retrieve the number of items to cache, on a given slideshow widget, after the current item More... | |
void | elm_slideshow::cache_after_set (int count_) const |
Retrieve the number of items to cache, on a given slideshow widget, after the current item More... | |
int | elm_slideshow::cache_before_get () const |
Retrieve the number of items to cache, on a given slideshow widget, before the current item More... | |
void | elm_slideshow::cache_before_set (int count_) const |
Retrieve the number of items to cache, on a given slideshow widget, before the current item More... | |
std::string | elm_slideshow::layout_get () const |
Get the current slide layout in use for a given slideshow widget. More... | |
void | elm_slideshow::layout_set (std::string layout_) const |
Get the current slide layout in use for a given slideshow widget. More... | |
std::string | elm_slideshow::transition_get () const |
Get the current slide transition/effect in use for a given slideshow widget. More... | |
void | elm_slideshow::transition_set (std::string transition_) const |
Get the current slide transition/effect in use for a given slideshow widget. More... | |
bool | elm_slideshow::loop_get () const |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not. More... | |
void | elm_slideshow::loop_set (bool loop_) const |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not. More... | |
double | elm_slideshow::timeout_get () const |
Get the interval set for image transitions on a given slideshow widget. More... | |
void | elm_slideshow::timeout_set (double timeout_) const |
Get the interval set for image transitions on a given slideshow widget. More... | |
const Eina_List * | elm_slideshow::items_get () const |
Get the internal list of items in a given slideshow widget. More... | |
const Eina_List * | elm_slideshow::transitions_get () const |
Returns the list of sliding transition/effect names available, for a given slideshow widget. More... | |
unsigned int | elm_slideshow::count_get () const |
Get the number of items stored in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow::item_current_get () const |
Returns the currently displayed item, in a given slideshow widget. More... | |
const Eina_List * | elm_slideshow::layouts_get () const |
Returns the list of layout names available, for a given slideshow widget. More... | |
void | elm_slideshow_cache_after_set (Elm_Slideshow *obj, int count) |
Set the number of items to cache, on a given slideshow widget, after the current item More... | |
int | elm_slideshow_cache_after_get (const Elm_Slideshow *obj) |
Get the number of items to cache, on a given slideshow widget, after the current item More... | |
void | elm_slideshow_cache_before_set (Elm_Slideshow *obj, int count) |
Set the number of items to cache, on a given slideshow widget, before the current item More... | |
int | elm_slideshow_cache_before_get (const Elm_Slideshow *obj) |
Get the number of items to cache, on a given slideshow widget, before the current item More... | |
void | elm_slideshow_layout_set (Elm_Slideshow *obj, const char *layout) |
Set the current slide layout in use for a given slideshow widget. More... | |
const char * | elm_slideshow_layout_get (const Elm_Slideshow *obj) |
Get the current slide layout in use for a given slideshow widget. More... | |
void | elm_slideshow_transition_set (Elm_Slideshow *obj, const char *transition) |
Set the current slide transition/effect in use for a given slideshow widget. More... | |
const char * | elm_slideshow_transition_get (const Elm_Slideshow *obj) |
Get the current slide transition/effect in use for a given slideshow widget. More... | |
void | elm_slideshow_loop_set (Elm_Slideshow *obj, Eina_Bool loop) |
Set if, after a slideshow is started, for a given slideshow widget, its items should be displayed cyclically or not. More... | |
Eina_Bool | elm_slideshow_loop_get (const Elm_Slideshow *obj) |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not. More... | |
void | elm_slideshow_timeout_set (Elm_Slideshow *obj, double timeout) |
Set the interval between each image transition on a given slideshow widget, and start the slideshow, itself More... | |
double | elm_slideshow_timeout_get (const Elm_Slideshow *obj) |
Get the interval set for image transitions on a given slideshow widget. More... | |
const Eina_List * | elm_slideshow_items_get (const Elm_Slideshow *obj) |
Get the internal list of items in a given slideshow widget. More... | |
const Eina_List * | elm_slideshow_transitions_get (const Elm_Slideshow *obj) |
Returns the list of sliding transition/effect names available, for a given slideshow widget. More... | |
unsigned int | elm_slideshow_count_get (const Elm_Slideshow *obj) |
Get the number of items stored in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow_item_current_get (const Elm_Slideshow *obj) |
Returns the currently displayed item, in a given slideshow widget. More... | |
const Eina_List * | elm_slideshow_layouts_get (const Elm_Slideshow *obj) |
Returns the list of layout names available, for a given slideshow widget. More... | |
void | elm_slideshow_previous (Elm_Slideshow *obj) |
Slide to the previous item, in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow_item_nth_get (const Elm_Slideshow *obj, unsigned int nth) |
Get the the item, in a given slideshow widget, placed at position nth , in its internal items list. More... | |
void | elm_slideshow_next (Elm_Slideshow *obj) |
Slide to the next item, in a given slideshow widget. More... | |
void | elm_slideshow_clear (Elm_Slideshow *obj) |
Remove all items from a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow_item_add (Elm_Slideshow *obj, const Elm_Slideshow_Item_Class *itc, const void *data) |
Add (append) a new item in a given slideshow widget. More... | |
Elm_Object_Item * | elm_slideshow_item_sorted_insert (Elm_Slideshow *obj, const Elm_Slideshow_Item_Class *itc, const void *data, Eina_Compare_Cb func) |
Insert a new item into the given slideshow widget, using the func function to sort items (by item handles). More... | |
EOAPI void | elm_obj_slideshow_item_show (void) |
Display a given slideshow widget's item, programmatically. More... | |
EOAPI Evas_Object * | elm_obj_slideshow_item_object_get (void) |
Get the real Evas object created to implement the view of a given slideshow item. More... | |
void | elm_slideshow_item_show (Elm_Slideshow_Item *obj) |
Display a given slideshow widget's item, programmatically. More... | |
Evas_Object * | elm_slideshow_item_object_get (const Elm_Slideshow_Item *obj) |
Get the real Evas object created to implement the view of a given slideshow item. More... | |
Evas_Object * | elm_slideshow_add (Evas_Object *parent) |
Add a new slideshow widget to the given parent Elementary (container) object. More... | |
This widget, as the name indicates, is a pre-made image slideshow panel, with API functions acting on (child) image items presentation. Between those actions, are:
The transition animations are defined in the widget's theme, consequently new animations can be added without having to update the widget's code.
For slideshow items, just like for genlist ones, the user defines a classes, specifying functions that will be called on the item's creation and deletion times.
The Elm_Slideshow_Item_Class structure contains the following members:
func.get
- When an item is displayed, this function is called, and it's where one should create the item object, de facto. For example, the object can be a pure Evas image object or an Elementary photocam widget. See SlideshowItemGetFunc.func.del
- When an item is no more displayed, this function is called, where the user must delete any data associated to the item. See SlideshowItemDelFunc.The slideshow provides facilities to have items adjacent to the one being displayed already "realized" (i.e. loaded) for you, so that the system does not have to decode image data anymore at the time it has to actually switch images on its viewport. The user is able to set the numbers of items to be cached before and after the current item, in the widget's item list.
This widget inherits from the Layout one, so that all the functions acting on it also work for slideshow objects.
This widget emits the following signals, besides the ones sent from Layout:
"changed"
- when the slideshow switches its view to a new item. event_info parameter in callback contains the current visible item"transition,end"
- when a slide transition ends. event_info parameter in callback contains the current visible item"focused"
- When the slideshow has received focus. (since 1.8)"unfocused"
- When the slideshow has lost focus. (since 1.8)"language,changed"
- the program's language changed (since 1.9)Supported elm_object_item
common APIs.
List of examples for the slideshow widget:
typedef void(* SlideshowItemDelFunc) (void *data, Evas_Object *obj) |
Deletion class function for slideshow item classes.
typedef Evas_Object*(* SlideshowItemGetFunc) (void *data, Evas_Object *obj) |
Image fetching class function for slideshow item classes.
|
inline |
Retrieve the number of items to cache, on a given slideshow widget, after the current item
count | Number of items to cache after the current one |
References elm_obj_slideshow_cache_after_get().
|
inline |
Retrieve the number of items to cache, on a given slideshow widget, after the current item
count | Number of items to cache after the current one |
References elm_obj_slideshow_cache_after_set().
|
inline |
Retrieve the number of items to cache, on a given slideshow widget, before the current item
count | Number of items to cache before the current one |
References elm_obj_slideshow_cache_before_get().
|
inline |
Retrieve the number of items to cache, on a given slideshow widget, before the current item
count | Number of items to cache before the current one |
References elm_obj_slideshow_cache_before_set().
|
inline |
Remove all items from a given slideshow widget.
This removes (and deletes) all items in obj
, leaving it empty.
References elm_obj_slideshow_clear().
|
inline |
Get the number of items stored in a given slideshow widget.
obj
, at the moment of this call References elm_obj_slideshow_count_get().
EOAPI int elm_obj_slideshow_cache_after_get | ( | void | ) |
Get the number of items to cache, on a given slideshow widget, after the current item
Referenced by elm_slideshow::cache_after_get(), and elm_slideshow_cache_after_get().
EOAPI void elm_obj_slideshow_cache_after_set | ( | int | count | ) |
Set the number of items to cache, on a given slideshow widget, after the current item
The default value for this property is 2
. See slideshow caching for more details.
[in] | count | Number of items to cache after the current one |
Referenced by elm_slideshow::cache_after_set(), and elm_slideshow_cache_after_set().
EOAPI int elm_obj_slideshow_cache_before_get | ( | void | ) |
Get the number of items to cache, on a given slideshow widget, before the current item
Referenced by elm_slideshow::cache_before_get(), and elm_slideshow_cache_before_get().
EOAPI void elm_obj_slideshow_cache_before_set | ( | int | count | ) |
Set the number of items to cache, on a given slideshow widget, before the current item
The default value for this property is 2
. See slideshow caching for more details.
[in] | count | Number of items to cache before the current one |
Referenced by elm_slideshow::cache_before_set(), and elm_slideshow_cache_before_set().
EOAPI void elm_obj_slideshow_clear | ( | void | ) |
Remove all items from a given slideshow widget.
This removes (and deletes) all items in obj
, leaving it empty.
Referenced by elm_slideshow::clear(), and elm_slideshow_clear().
EOAPI unsigned int elm_obj_slideshow_count_get | ( | void | ) |
Get the number of items stored in a given slideshow widget.
obj
, at the moment of this call Referenced by elm_slideshow::count_get(), and elm_slideshow_count_get().
EOAPI Elm_Object_Item* elm_obj_slideshow_item_add | ( | const Elm_Slideshow_Item_Class * | itc, |
const void * | data | ||
) |
Add (append) a new item in a given slideshow widget.
NULL
, on errorsAdd a new item to obj's
internal list of items, appending it. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
[in] | itc | The item class for the item |
[in] | data | The item's data |
Referenced by elm_slideshow_item_add(), and elm_slideshow::item_add().
EOAPI Elm_Object_Item* elm_obj_slideshow_item_current_get | ( | void | ) |
Returns the currently displayed item, in a given slideshow widget.
obj
or NULL
, if none is (and on errors) Referenced by elm_slideshow_item_current_get(), and elm_slideshow::item_current_get().
EOAPI Elm_Object_Item* elm_obj_slideshow_item_nth_get | ( | unsigned int | nth | ) |
Get the the item, in a given slideshow widget, placed at position nth
, in its internal items list.
obj
at position nth
or NULL
, if there's no item with that index (and on errors)[in] | nth | The number of the item to grab a handle to (0 being the first) |
Referenced by elm_slideshow_item_nth_get(), and elm_slideshow::item_nth_get().
EOAPI Evas_Object* elm_obj_slideshow_item_object_get | ( | void | ) |
Get the real Evas object created to implement the view of a given slideshow item.
This returns the actual Evas object used to implement the specified slideshow item's view. This may be NULL
, as it may not have been created or may have been deleted, at any time, by the slideshow. Do not modify this object (move, resize, show, hide, etc.), as the slideshow is controlling it. This function is for querying, emitting custom signals or hooking lower level callbacks for events on that object. Do not delete this object under any circumstances.
Referenced by elm_slideshow_item_object_get().
EOAPI void elm_obj_slideshow_item_show | ( | void | ) |
Display a given slideshow widget's item, programmatically.
The change between the current item and item
will use the transition obj
is set to use (
Referenced by elm_slideshow_item_show().
EOAPI Elm_Object_Item* elm_obj_slideshow_item_sorted_insert | ( | const Elm_Slideshow_Item_Class * | itc, |
const void * | data, | ||
Eina_Compare_Cb | func | ||
) |
Insert a new item into the given slideshow widget, using the func
function to sort items (by item handles).
NULL
, on errorsAdd a new item to obj's
internal list of items, in a position determined by the func
comparing function. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
[in] | itc | The item class for the item |
[in] | data | The item's data |
[in] | func | The comparing function to be used to sort slideshow items by Elm_Slideshow_Item_Class item handles |
Referenced by elm_slideshow_item_sorted_insert(), and elm_slideshow::item_sorted_insert().
EOAPI const Eina_List* elm_obj_slideshow_items_get | ( | void | ) |
Get the internal list of items in a given slideshow widget.
NULL
on errors.This list is not to be modified in any way and must not be freed. Use the list members with functions like elm_object_item_del(), elm_object_item_data_get().
obj
object's internal items list is changed. It should be fetched again with another call to this function when changes happen. Referenced by elm_slideshow_items_get(), and elm_slideshow::items_get().
EOAPI const char* elm_obj_slideshow_layout_get | ( | void | ) |
Get the current slide layout in use for a given slideshow widget.
Referenced by elm_slideshow_layout_get(), and elm_slideshow::layout_get().
EOAPI void elm_obj_slideshow_layout_set | ( | const char * | layout | ) |
Set the current slide layout in use for a given slideshow widget.
If layout
is implemented in obj's
theme (i.e., is contained in the list returned by elm_slideshow_layouts_get()), this new images layout will be used on the widget.
[in] | layout | The new layout's name string |
Referenced by elm_slideshow_layout_set(), and elm_slideshow::layout_set().
EOAPI const Eina_List* elm_obj_slideshow_layouts_get | ( | void | ) |
Returns the list of layout names available, for a given slideshow widget.
Slideshow layouts will change how the widget is to dispose each image item in its viewport, with regard to cropping, scaling, etc.
The layouts, which come from obj's
theme, must be an EDC data item name "layouts"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available layouts for slideshows on the default theme are:
"fullscreen"
- item images with original aspect, scaled to touch top and down slideshow borders or, if the image's height is not enough, left and right slideshow borders."not_fullscreen"
- the same behavior as the "fullscreen"
one, but always leaving 10% of the slideshow's dimensions of distance between the item image's borders and the slideshow borders, for each axis.eina_stringshare_ref()
them.Referenced by elm_slideshow_layouts_get(), and elm_slideshow::layouts_get().
EOAPI Eina_Bool elm_obj_slideshow_loop_get | ( | void | ) |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not.
EINA_TRUE
, if the items in obj
will be cycled through or EINA_FALSE
, otherwiseReferenced by elm_slideshow_loop_get(), and elm_slideshow::loop_get().
EOAPI void elm_obj_slideshow_loop_set | ( | Eina_Bool | loop | ) |
Set if, after a slideshow is started, for a given slideshow widget, its items should be displayed cyclically or not.
[in] | loop | Use EINA_TRUE to make it cycle through items or EINA_FALSE for it to stop at the end of obj's internal list of items |
Referenced by elm_slideshow_loop_set(), and elm_slideshow::loop_set().
EOAPI void elm_obj_slideshow_next | ( | void | ) |
Slide to the next item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
Referenced by elm_slideshow_next(), and elm_slideshow::next().
EOAPI void elm_obj_slideshow_previous | ( | void | ) |
Slide to the previous item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
Referenced by elm_slideshow_previous(), and elm_slideshow::previous().
EOAPI double elm_obj_slideshow_timeout_get | ( | void | ) |
Get the interval set for image transitions on a given slideshow widget.
Referenced by elm_slideshow_timeout_get(), and elm_slideshow::timeout_get().
EOAPI void elm_obj_slideshow_timeout_set | ( | double | timeout | ) |
Set the interval between each image transition on a given slideshow widget, and start the slideshow, itself
After this call, the slideshow widget will start cycling its view, sequentially and automatically, with the images of the items it has. The time between each new image displayed is going to be timeout
, in seconds. If a different timeout was set previously and an slideshow was in progress, it will continue with the new time between transitions, after this call.
timeout
will disable the widget's internal timer, thus halting any slideshow which could be happening on obj
.[in] | timeout | The new displaying timeout for images |
Referenced by elm_slideshow_timeout_set(), and elm_slideshow::timeout_set().
EOAPI const char* elm_obj_slideshow_transition_get | ( | void | ) |
Get the current slide transition/effect in use for a given slideshow widget.
Referenced by elm_slideshow_transition_get(), and elm_slideshow::transition_get().
EOAPI void elm_obj_slideshow_transition_set | ( | const char * | transition | ) |
Set the current slide transition/effect in use for a given slideshow widget.
If transition
is implemented in obj's
theme (i.e., is contained in the list returned by elm_slideshow_transitions_get()), this new sliding effect will be used on the widget.
[in] | transition | The new transition's name string |
Referenced by elm_slideshow_transition_set(), and elm_slideshow::transition_set().
EOAPI const Eina_List* elm_obj_slideshow_transitions_get | ( | void | ) |
Returns the list of sliding transition/effect names available, for a given slideshow widget.
The transitions, which come from obj's
theme, must be an EDC data item named "transitions"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available transitions for slideshows on the default theme are:
"fade"
- the current item fades out, while the new one fades in to the slideshow's viewport."black_fade"
- the current item fades to black, and just then, the new item will fade in."horizontal"
- the current item slides horizontally, until it gets out of the slideshow's viewport, while the new item comes from the left to take its place."vertical"
- the current item slides vertically, until it gets out of the slideshow's viewport, while the new item comes from the bottom to take its place."square"
- the new item starts to appear from the middle of the current one, but with a tiny size, growing until its target (full) size and covering the old one.eina_stringshare_ref()
them. Also the list is an internal list and so is only valid for as long as the slideshow object is valid and has not internally changed its list for some reason, so make a copy if you need it around.Referenced by elm_slideshow_transitions_get(), and elm_slideshow::transitions_get().
Evas_Object* elm_slideshow_add | ( | Evas_Object * | parent | ) |
Add a new slideshow widget to the given parent Elementary (container) object.
parent | The parent object |
NULL
, on errorsThis function inserts a new slideshow widget on the canvas.
int elm_slideshow_cache_after_get | ( | const Elm_Slideshow * | obj | ) |
Get the number of items to cache, on a given slideshow widget, after the current item
References elm_obj_slideshow_cache_after_get().
void elm_slideshow_cache_after_set | ( | Elm_Slideshow * | obj, |
int | count | ||
) |
Set the number of items to cache, on a given slideshow widget, after the current item
The default value for this property is 2
. See slideshow caching for more details.
[in] | count | Number of items to cache after the current one |
References elm_obj_slideshow_cache_after_set().
int elm_slideshow_cache_before_get | ( | const Elm_Slideshow * | obj | ) |
Get the number of items to cache, on a given slideshow widget, before the current item
References elm_obj_slideshow_cache_before_get().
void elm_slideshow_cache_before_set | ( | Elm_Slideshow * | obj, |
int | count | ||
) |
Set the number of items to cache, on a given slideshow widget, before the current item
The default value for this property is 2
. See slideshow caching for more details.
[in] | count | Number of items to cache before the current one |
References elm_obj_slideshow_cache_before_set().
void elm_slideshow_clear | ( | Elm_Slideshow * | obj | ) |
Remove all items from a given slideshow widget.
This removes (and deletes) all items in obj
, leaving it empty.
References elm_obj_slideshow_clear().
unsigned int elm_slideshow_count_get | ( | const Elm_Slideshow * | obj | ) |
Get the number of items stored in a given slideshow widget.
obj
, at the moment of this call References elm_obj_slideshow_count_get().
Elm_Object_Item* elm_slideshow_item_add | ( | Elm_Slideshow * | obj, |
const Elm_Slideshow_Item_Class * | itc, | ||
const void * | data | ||
) |
Add (append) a new item in a given slideshow widget.
NULL
, on errorsAdd a new item to obj's
internal list of items, appending it. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
[in] | itc | The item class for the item |
[in] | data | The item's data |
References elm_obj_slideshow_item_add().
Elm_Object_Item* elm_slideshow_item_current_get | ( | const Elm_Slideshow * | obj | ) |
Returns the currently displayed item, in a given slideshow widget.
obj
or NULL
, if none is (and on errors) References elm_obj_slideshow_item_current_get().
Elm_Object_Item* elm_slideshow_item_nth_get | ( | const Elm_Slideshow * | obj, |
unsigned int | nth | ||
) |
Get the the item, in a given slideshow widget, placed at position nth
, in its internal items list.
obj
at position nth
or NULL
, if there's no item with that index (and on errors)[in] | nth | The number of the item to grab a handle to (0 being the first) |
References elm_obj_slideshow_item_nth_get().
Evas_Object* elm_slideshow_item_object_get | ( | const Elm_Slideshow_Item * | obj | ) |
Get the real Evas object created to implement the view of a given slideshow item.
This returns the actual Evas object used to implement the specified slideshow item's view. This may be NULL
, as it may not have been created or may have been deleted, at any time, by the slideshow. Do not modify this object (move, resize, show, hide, etc.), as the slideshow is controlling it. This function is for querying, emitting custom signals or hooking lower level callbacks for events on that object. Do not delete this object under any circumstances.
References elm_obj_slideshow_item_object_get().
void elm_slideshow_item_show | ( | Elm_Slideshow_Item * | obj | ) |
Display a given slideshow widget's item, programmatically.
The change between the current item and item
will use the transition obj
is set to use (
References elm_obj_slideshow_item_show().
Elm_Object_Item* elm_slideshow_item_sorted_insert | ( | Elm_Slideshow * | obj, |
const Elm_Slideshow_Item_Class * | itc, | ||
const void * | data, | ||
Eina_Compare_Cb | func | ||
) |
Insert a new item into the given slideshow widget, using the func
function to sort items (by item handles).
NULL
, on errorsAdd a new item to obj's
internal list of items, in a position determined by the func
comparing function. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
[in] | itc | The item class for the item |
[in] | data | The item's data |
[in] | func | The comparing function to be used to sort slideshow items by Elm_Slideshow_Item_Class item handles |
References elm_obj_slideshow_item_sorted_insert().
const Eina_List* elm_slideshow_items_get | ( | const Elm_Slideshow * | obj | ) |
Get the internal list of items in a given slideshow widget.
NULL
on errors.This list is not to be modified in any way and must not be freed. Use the list members with functions like elm_object_item_del(), elm_object_item_data_get().
obj
object's internal items list is changed. It should be fetched again with another call to this function when changes happen. References elm_obj_slideshow_items_get().
const char* elm_slideshow_layout_get | ( | const Elm_Slideshow * | obj | ) |
Get the current slide layout in use for a given slideshow widget.
References elm_obj_slideshow_layout_get().
void elm_slideshow_layout_set | ( | Elm_Slideshow * | obj, |
const char * | layout | ||
) |
Set the current slide layout in use for a given slideshow widget.
If layout
is implemented in obj's
theme (i.e., is contained in the list returned by elm_slideshow_layouts_get()), this new images layout will be used on the widget.
[in] | layout | The new layout's name string |
References elm_obj_slideshow_layout_set().
const Eina_List* elm_slideshow_layouts_get | ( | const Elm_Slideshow * | obj | ) |
Returns the list of layout names available, for a given slideshow widget.
Slideshow layouts will change how the widget is to dispose each image item in its viewport, with regard to cropping, scaling, etc.
The layouts, which come from obj's
theme, must be an EDC data item name "layouts"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available layouts for slideshows on the default theme are:
"fullscreen"
- item images with original aspect, scaled to touch top and down slideshow borders or, if the image's height is not enough, left and right slideshow borders."not_fullscreen"
- the same behavior as the "fullscreen"
one, but always leaving 10% of the slideshow's dimensions of distance between the item image's borders and the slideshow borders, for each axis.eina_stringshare_ref()
them.References elm_obj_slideshow_layouts_get().
Eina_Bool elm_slideshow_loop_get | ( | const Elm_Slideshow * | obj | ) |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not.
EINA_TRUE
, if the items in obj
will be cycled through or EINA_FALSE
, otherwiseReferences elm_obj_slideshow_loop_get().
void elm_slideshow_loop_set | ( | Elm_Slideshow * | obj, |
Eina_Bool | loop | ||
) |
Set if, after a slideshow is started, for a given slideshow widget, its items should be displayed cyclically or not.
[in] | loop | Use EINA_TRUE to make it cycle through items or EINA_FALSE for it to stop at the end of obj's internal list of items |
References elm_obj_slideshow_loop_set().
void elm_slideshow_next | ( | Elm_Slideshow * | obj | ) |
Slide to the next item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
References elm_obj_slideshow_next().
void elm_slideshow_previous | ( | Elm_Slideshow * | obj | ) |
Slide to the previous item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
References elm_obj_slideshow_previous().
double elm_slideshow_timeout_get | ( | const Elm_Slideshow * | obj | ) |
Get the interval set for image transitions on a given slideshow widget.
References elm_obj_slideshow_timeout_get().
void elm_slideshow_timeout_set | ( | Elm_Slideshow * | obj, |
double | timeout | ||
) |
Set the interval between each image transition on a given slideshow widget, and start the slideshow, itself
After this call, the slideshow widget will start cycling its view, sequentially and automatically, with the images of the items it has. The time between each new image displayed is going to be timeout
, in seconds. If a different timeout was set previously and an slideshow was in progress, it will continue with the new time between transitions, after this call.
timeout
will disable the widget's internal timer, thus halting any slideshow which could be happening on obj
.[in] | timeout | The new displaying timeout for images |
References elm_obj_slideshow_timeout_set().
const char* elm_slideshow_transition_get | ( | const Elm_Slideshow * | obj | ) |
Get the current slide transition/effect in use for a given slideshow widget.
References elm_obj_slideshow_transition_get().
void elm_slideshow_transition_set | ( | Elm_Slideshow * | obj, |
const char * | transition | ||
) |
Set the current slide transition/effect in use for a given slideshow widget.
If transition
is implemented in obj's
theme (i.e., is contained in the list returned by elm_slideshow_transitions_get()), this new sliding effect will be used on the widget.
[in] | transition | The new transition's name string |
References elm_obj_slideshow_transition_set().
const Eina_List* elm_slideshow_transitions_get | ( | const Elm_Slideshow * | obj | ) |
Returns the list of sliding transition/effect names available, for a given slideshow widget.
The transitions, which come from obj's
theme, must be an EDC data item named "transitions"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available transitions for slideshows on the default theme are:
"fade"
- the current item fades out, while the new one fades in to the slideshow's viewport."black_fade"
- the current item fades to black, and just then, the new item will fade in."horizontal"
- the current item slides horizontally, until it gets out of the slideshow's viewport, while the new item comes from the left to take its place."vertical"
- the current item slides vertically, until it gets out of the slideshow's viewport, while the new item comes from the bottom to take its place."square"
- the new item starts to appear from the middle of the current one, but with a tiny size, growing until its target (full) size and covering the old one.eina_stringshare_ref()
them. Also the list is an internal list and so is only valid for as long as the slideshow object is valid and has not internally changed its list for some reason, so make a copy if you need it around.References elm_obj_slideshow_transitions_get().
|
inline |
Add (append) a new item in a given slideshow widget.
NULL
, on errorsAdd a new item to obj's
internal list of items, appending it. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
itc | The item class for the item |
data | The item's data |
References elm_obj_slideshow_item_add().
|
inline |
Returns the currently displayed item, in a given slideshow widget.
obj
or NULL
, if none is (and on errors) References elm_obj_slideshow_item_current_get().
|
inline |
Get the the item, in a given slideshow widget, placed at position nth
, in its internal items list.
obj
at position nth
or NULL
, if there's no item with that index (and on errors)nth | The number of the item to grab a handle to (0 being the first) |
References elm_obj_slideshow_item_nth_get().
|
inline |
Insert a new item into the given slideshow widget, using the func
function to sort items (by item handles).
NULL
, on errorsAdd a new item to obj's
internal list of items, in a position determined by the func
comparing function. The item's class must contain the function really fetching the image object to show for this item, which could be an Evas image object or an Elementary photo, for example. The data
parameter is going to be passed to both class functions of the item.
itc | The item class for the item |
data | The item's data |
func | The comparing function to be used to sort slideshow items by Elm_Slideshow_Item_Class item handles |
References elm_obj_slideshow_item_sorted_insert().
|
inline |
Get the internal list of items in a given slideshow widget.
NULL
on errors.This list is not to be modified in any way and must not be freed. Use the list members with functions like elm_object_item_del(), elm_object_item_data_get().
obj
object's internal items list is changed. It should be fetched again with another call to this function when changes happen. References elm_obj_slideshow_items_get().
|
inline |
Get the current slide layout in use for a given slideshow widget.
layout | The new layout's name string |
References elm_obj_slideshow_layout_get().
|
inline |
Get the current slide layout in use for a given slideshow widget.
layout | The new layout's name string |
References elm_obj_slideshow_layout_set().
|
inline |
Returns the list of layout names available, for a given slideshow widget.
Slideshow layouts will change how the widget is to dispose each image item in its viewport, with regard to cropping, scaling, etc.
The layouts, which come from obj's
theme, must be an EDC data item name "layouts"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available layouts for slideshows on the default theme are:
"fullscreen"
- item images with original aspect, scaled to touch top and down slideshow borders or, if the image's height is not enough, left and right slideshow borders."not_fullscreen"
- the same behavior as the "fullscreen"
one, but always leaving 10% of the slideshow's dimensions of distance between the item image's borders and the slideshow borders, for each axis.eina_stringshare_ref()
them.References elm_obj_slideshow_layouts_get().
|
inline |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not.
EINA_TRUE
, if the items in obj
will be cycled through or EINA_FALSE
, otherwiseloop | Use EINA_TRUE to make it cycle through items or EINA_FALSE for it to stop at the end of obj's internal list of items |
References elm_obj_slideshow_loop_get().
|
inline |
Get if, after a slideshow is started, for a given slideshow widget, its items are to be displayed cyclically or not.
EINA_TRUE
, if the items in obj
will be cycled through or EINA_FALSE
, otherwiseloop | Use EINA_TRUE to make it cycle through items or EINA_FALSE for it to stop at the end of obj's internal list of items |
References elm_obj_slideshow_loop_set().
|
inline |
Slide to the next item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
References elm_obj_slideshow_next().
|
inline |
Slide to the previous item, in a given slideshow widget.
The sliding animation obj
is set to use will be the transition effect used, after this call is issued.
References elm_obj_slideshow_previous().
|
inline |
Get the interval set for image transitions on a given slideshow widget.
timeout | The new displaying timeout for images |
References elm_obj_slideshow_timeout_get().
|
inline |
Get the interval set for image transitions on a given slideshow widget.
timeout | The new displaying timeout for images |
References elm_obj_slideshow_timeout_set().
|
inline |
Get the current slide transition/effect in use for a given slideshow widget.
transition | The new transition's name string |
References elm_obj_slideshow_transition_get().
|
inline |
Get the current slide transition/effect in use for a given slideshow widget.
transition | The new transition's name string |
References elm_obj_slideshow_transition_set().
|
inline |
Returns the list of sliding transition/effect names available, for a given slideshow widget.
The transitions, which come from obj's
theme, must be an EDC data item named "transitions"
on the theme file, with (prefix) names of EDC programs actually implementing them.
The available transitions for slideshows on the default theme are:
"fade"
- the current item fades out, while the new one fades in to the slideshow's viewport."black_fade"
- the current item fades to black, and just then, the new item will fade in."horizontal"
- the current item slides horizontally, until it gets out of the slideshow's viewport, while the new item comes from the left to take its place."vertical"
- the current item slides vertically, until it gets out of the slideshow's viewport, while the new item comes from the bottom to take its place."square"
- the new item starts to appear from the middle of the current one, but with a tiny size, growing until its target (full) size and covering the old one.eina_stringshare_ref()
them. Also the list is an internal list and so is only valid for as long as the slideshow object is valid and has not internally changed its list for some reason, so make a copy if you need it around.References elm_obj_slideshow_transitions_get().