1 #include <Elementary.h>
5 * @defgroup Slideshow slideshow
7 * This object display a list of object (generally a list of images) and some actions like
8 * next/previous are used to navigate. The animations are defined in the theme,
9 * consequently new animations can be added without having to update the
12 * The slideshow use 2 callbacks to create and delete the objects displayed. When an item
13 * is displayed the function itc->func.get() is called. This function should create the object,
14 * for example the object can be an evas_object_image or a photocam. When a object is no more
15 * displayed the function itc->func.del() is called, the user can delete the dana associated to the item.
18 typedef struct _Widget_Data Widget_Data;
20 struct _Elm_Slideshow_Item
24 Eina_List *l, *l_built;
26 const Elm_Slideshow_Item_Class *itc;
31 Evas_Object *slideshow;
33 // list of Elm_Slideshow_Item*
35 Eina_List *items_built;
37 Elm_Slideshow_Item *current;
38 Elm_Slideshow_Item *previous;
40 Eina_List *transitions;
41 const char *transition;
49 Eina_List *list; //list of const char *
53 static const char *widtype = NULL;
54 static void _del_hook(Evas_Object *obj);
55 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
56 static void _theme_hook(Evas_Object *obj);
57 static void _sizing_eval(Evas_Object *obj);
58 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
59 static Eina_Bool _timer_cb(void *data);
60 static void _on_focus_hook(void *data, Evas_Object *obj);
61 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
62 Evas_Callback_Type type, void *event_info);
65 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
67 if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
68 Evas_Event_Key_Down *ev = event_info;
69 Widget_Data *wd = elm_widget_data_get(obj);
70 if (!wd) return EINA_FALSE;
71 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
72 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
73 if ((!strcmp(ev->keyname, "Left")) || (!strcmp(ev->keyname, "KP_Left")))
75 elm_slideshow_previous(obj);
76 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
79 if ((!strcmp(ev->keyname, "Right")) || (!strcmp(ev->keyname, "KP_Right")))
81 elm_slideshow_next(obj);
82 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
85 if ((!strcmp(ev->keyname, "Return")) ||
86 (!strcmp(ev->keyname, "KP_Enter")) ||
87 (!strcmp(ev->keyname, "space")))
93 ecore_timer_del(wd->timer);
97 elm_slideshow_timeout_set(obj, wd->timeout);
99 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
106 _del_hook(Evas_Object *obj)
109 Widget_Data *wd = elm_widget_data_get(obj);
111 elm_slideshow_clear(obj);
112 elm_widget_stringlist_free(wd->transitions);
113 if (wd->timer) ecore_timer_del(wd->timer);
114 EINA_LIST_FREE(wd->layout.list, layout)
115 eina_stringshare_del(layout);
120 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
122 Widget_Data *wd = elm_widget_data_get(obj);
124 if (elm_widget_focus_get(obj))
126 edje_object_signal_emit(wd->slideshow, "elm,action,focus", "elm");
127 evas_object_focus_set(wd->slideshow, EINA_TRUE);
131 edje_object_signal_emit(wd->slideshow, "elm,action,unfocus", "elm");
132 evas_object_focus_set(wd->slideshow, EINA_FALSE);
137 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
139 Widget_Data *wd = elm_widget_data_get(obj);
141 edje_object_mirrored_set(wd->slideshow, rtl);
145 _theme_hook(Evas_Object *obj)
147 Widget_Data *wd = elm_widget_data_get(obj);
149 _mirrored_set(obj, elm_widget_mirrored_get(obj));
150 _elm_theme_object_set(obj, wd->slideshow, "slideshow", "base", elm_widget_style_get(obj));
151 edje_object_scale_set(wd->slideshow, elm_widget_scale_get(obj) *
157 _sizing_eval(Evas_Object *obj)
159 Widget_Data *wd = elm_widget_data_get(obj);
160 Evas_Coord minw = -1, minh = -1;
162 edje_object_size_min_calc(wd->slideshow, &minw, &minh);
163 evas_object_size_hint_min_set(obj, minw, minh);
164 evas_object_size_hint_max_set(obj, minw, minh);
168 static Elm_Slideshow_Item* _item_prev_get(Elm_Slideshow_Item* item)
170 Widget_Data *wd = elm_widget_data_get(item->base.widget);
171 Elm_Slideshow_Item* prev = eina_list_data_get(eina_list_prev(item->l));
172 if((!prev) && (wd->loop))
173 prev = eina_list_data_get(eina_list_last(item->l));
177 static Elm_Slideshow_Item* _item_next_get(Elm_Slideshow_Item* item)
179 Widget_Data *wd = elm_widget_data_get(item->base.widget);
180 Elm_Slideshow_Item* next = eina_list_data_get(eina_list_next(item->l));
181 if((!next) && (wd->loop))
182 next = eina_list_data_get(wd->items);
188 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
194 _sub_del(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
200 _item_realize(Elm_Slideshow_Item *item)
202 Elm_Slideshow_Item *_item;
203 Evas_Object *obj = item->base.widget;
204 Widget_Data *wd = elm_widget_data_get(obj);
207 if ((!item->base.view) && (item->itc->func.get))
209 item->base.view = item->itc->func.get((void*)item->base.data, obj);
210 evas_object_smart_member_add(item->base.view, obj);
211 item->l_built = eina_list_append(NULL, item);
212 wd->items_built = eina_list_merge(wd->items_built, item->l_built);
213 evas_object_hide(item->base.view);
215 else if (item->l_built)
216 wd->items_built = eina_list_demote_list(wd->items_built, item->l_built);
218 //pre-create previous and next item
219 _item = _item_next_get(item);
220 if ((_item) && (!_item->base.view) && (_item->itc->func.get))
222 _item->base.view = _item->itc->func.get((void*)_item->base.data, obj);
223 evas_object_smart_member_add(_item->base.view, obj);
224 _item->l_built = eina_list_append(NULL, _item);
225 wd->items_built = eina_list_merge(wd->items_built, _item->l_built);
226 evas_object_hide(_item->base.view);
228 else if ((_item) && (_item->l_built))
229 wd->items_built = eina_list_demote_list(wd->items_built, _item->l_built);
231 _item = _item_prev_get(item);
232 if ((_item) && (!_item->base.view) && (_item->itc->func.get))
234 _item->base.view = _item->itc->func.get((void*)_item->base.data, obj);
235 evas_object_smart_member_add(_item->base.view, obj);
236 _item->l_built = eina_list_append(NULL, _item);
237 wd->items_built = eina_list_merge(wd->items_built, _item->l_built);
238 evas_object_hide(_item->base.view);
240 else if ((_item) && (_item->l_built))
241 wd->items_built = eina_list_demote_list(wd->items_built, _item->l_built);
243 //delete unused items
244 while (eina_list_count(wd->items_built) > 3)
246 _item = eina_list_data_get(wd->items_built);
247 wd->items_built = eina_list_remove_list(wd->items_built, wd->items_built);
248 if(item->itc->func.del)
249 item->itc->func.del((void*)item->base.data, _item->base.view);
250 evas_object_del(_item->base.view);
251 _item->base.view = NULL;
256 _end(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
258 Elm_Slideshow_Item *item;
259 Widget_Data *wd = elm_widget_data_get(data);
265 edje_object_part_unswallow(NULL, item->base.view);
266 evas_object_hide(item->base.view);
272 if ((!item) || (!item->base.view)) return;
275 edje_object_part_unswallow(NULL, item->base.view);
276 evas_object_show(item->base.view);
278 edje_object_signal_emit(wd->slideshow, "anim,end", "slideshow");
279 edje_object_part_swallow(wd->slideshow, "elm.swallow.1", item->base.view);
284 _timer_cb(void *data)
286 Evas_Object *obj = data;
287 Widget_Data *wd = elm_widget_data_get(obj);
288 if (!wd) return ECORE_CALLBACK_CANCEL;
290 elm_slideshow_next(obj);
291 return ECORE_CALLBACK_CANCEL;
297 * Add a new slideshow to the parent
299 * @param parent The parent object
300 * @return The new object or NULL if it cannot be created
305 elm_slideshow_add(Evas_Object *parent)
311 EINA_SAFETY_ON_NULL_RETURN_VAL(parent, NULL);
313 wd = ELM_NEW(Widget_Data);
314 e = evas_object_evas_get(parent);
316 obj = elm_widget_add(e);
317 ELM_SET_WIDTYPE(widtype, "slideshow");
318 elm_widget_type_set(obj, "slideshow");
319 elm_widget_sub_object_add(parent, obj);
320 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
321 elm_widget_data_set(obj, wd);
322 elm_widget_del_hook_set(obj, _del_hook);
323 elm_widget_theme_hook_set(obj, _theme_hook);
324 elm_widget_can_focus_set(obj, EINA_TRUE);
325 elm_widget_event_hook_set(obj, _event_hook);
330 wd->slideshow = edje_object_add(e);
331 _elm_theme_object_set(obj, wd->slideshow, "slideshow", "base", "default");
332 evas_object_smart_member_add(wd->slideshow, obj);
333 elm_widget_resize_object_set(obj, wd->slideshow);
334 evas_object_show(wd->slideshow);
336 wd->transitions = elm_widget_stringlist_get(edje_object_data_get(wd->slideshow, "transitions"));
337 if (eina_list_count(wd->transitions) > 0)
338 wd->transition = eina_stringshare_add(eina_list_data_get(wd->transitions));
340 wd->layout.list = elm_widget_stringlist_get(edje_object_data_get(wd->slideshow, "layouts"));
341 if (eina_list_count(wd->layout.list) > 0)
342 wd->layout.current = eina_list_data_get(wd->layout.list);
344 edje_object_signal_callback_add(wd->slideshow, "end", "slideshow", _end, obj);
346 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
347 evas_object_event_callback_add(obj, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
349 _mirrored_set(obj, elm_widget_mirrored_get(obj));
355 * Add a object in the list. The object can be a evas object image or a elm photo for example.
357 * @param obj The slideshow object
358 * @aram itc Callbacks used to create the object and delete the data associated when the item is deleted.
359 * @param data Data used by the user to identified the item
360 * @return Returns The slideshow item
364 EAPI Elm_Slideshow_Item*
365 elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data)
367 Elm_Slideshow_Item *item;
368 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
369 Widget_Data *wd = elm_widget_data_get(obj);
371 if (!wd) return NULL;
372 item = elm_widget_item_new(obj, Elm_Slideshow_Item);
373 item->base.data = data;
375 item->l = eina_list_append(item->l, item);
377 wd->items = eina_list_merge(wd->items, item->l);
379 if (!wd->current) elm_slideshow_show(item);
387 * @param obj The slideshow object
388 * @param item The item
393 elm_slideshow_show(Elm_Slideshow_Item *item)
396 Elm_Slideshow_Item *next = NULL;
398 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
399 wd = elm_widget_data_get(item->base.widget);
402 if (item == wd->current)
406 _end(item->base.widget, item->base.widget, NULL, NULL);
408 if (wd->timer) ecore_timer_del(wd->timer);
409 if (wd->timeout > 0.0)
410 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, item->base.widget);
412 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", next->base.view);
413 evas_object_show(next->base.view);
414 snprintf(buf, sizeof(buf), "%s,next", wd->transition);
415 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
416 wd->previous = wd->current;
418 evas_object_smart_callback_call(item->base.widget, "changed", wd->current);
422 * Go to the next item
424 * @param obj The slideshow object
429 elm_slideshow_next(Evas_Object *obj)
432 Elm_Slideshow_Item *next = NULL;
433 ELM_CHECK_WIDTYPE(obj, widtype);
434 Widget_Data *wd = elm_widget_data_get(obj);
439 next = _item_next_get(wd->current);
441 if ((!next) || (next == wd->current)) return;
443 _end(obj, obj, NULL, NULL);
445 if (wd->timer) ecore_timer_del(wd->timer);
446 if (wd->timeout > 0.0)
447 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, obj);
451 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", next->base.view);
452 evas_object_show(next->base.view);
454 snprintf(buf, sizeof(buf), "%s,next", wd->transition);
455 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
457 wd->previous = wd->current;
459 evas_object_smart_callback_call(obj, "changed", wd->current);
463 * Go to the previous item
465 * @param obj The slideshow object
470 elm_slideshow_previous(Evas_Object *obj)
473 Elm_Slideshow_Item *prev = NULL;
474 ELM_CHECK_WIDTYPE(obj, widtype);
475 Widget_Data *wd = elm_widget_data_get(obj);
480 prev = _item_prev_get(wd->current);
482 if ((!prev) || (prev == wd->current)) return;
484 _end(obj, obj, NULL, NULL);
486 if (wd->timer) ecore_timer_del(wd->timer);
487 if (wd->timeout > 0.0)
488 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, obj);
492 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", prev->base.view);
493 evas_object_show(prev->base.view);
495 snprintf(buf, 1024, "%s,previous", wd->transition);
496 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
498 wd->previous = wd->current;
500 evas_object_smart_callback_call(obj, "changed", wd->current);
504 * Returns the list of transitions available.
506 * @param obj The slideshow object
507 * @return Returns the list of transitions (list of const char*)
511 EAPI const Eina_List *
512 elm_slideshow_transitions_get(const Evas_Object *obj)
514 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
515 Widget_Data *wd = elm_widget_data_get(obj);
516 if (!wd) return NULL;
517 return wd->transitions;
521 * Returns the list of layouts available.
523 * @param obj The slideshow object
524 * @return Returns the list of layout (list of const char*)
528 EAPI const Eina_List *
529 elm_slideshow_layouts_get(const Evas_Object *obj)
531 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
532 Widget_Data *wd = elm_widget_data_get(obj);
533 if (!wd) return NULL;
534 return wd->layout.list;
538 * Set the transition to use
540 * @param obj The slideshow object
541 * @param transition the new transition
546 elm_slideshow_transition_set(Evas_Object *obj, const char *transition)
548 ELM_CHECK_WIDTYPE(obj, widtype);
549 Widget_Data *wd = elm_widget_data_get(obj);
551 eina_stringshare_replace(&wd->transition, transition);
555 * Returns the transition to use
557 * @param obj The slideshow object
558 * @return the transition set
563 elm_slideshow_transition_get(const Evas_Object *obj)
565 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
566 Widget_Data *wd = elm_widget_data_get(obj);
567 if (!wd) return NULL;
568 return wd->transition;
572 * The slideshow can go to the next item automatically after a few seconds.
573 * This method set the timeout to use. A timeout <=0 disable the timer.
575 * @param obj The slideshow object
576 * @param timeout The new timeout
581 elm_slideshow_timeout_set(Evas_Object *obj, double timeout)
583 ELM_CHECK_WIDTYPE(obj, widtype);
584 Widget_Data *wd = elm_widget_data_get(obj);
586 wd->timeout = timeout;
587 if (wd->timer) ecore_timer_del(wd->timer);
590 wd->timer = ecore_timer_add(timeout, _timer_cb, obj);
594 * Returns the timeout value
596 * @param obj The slideshow object
597 * @return Returns the timeout
602 elm_slideshow_timeout_get(const Evas_Object *obj)
604 ELM_CHECK_WIDTYPE(obj, widtype) -1.0;
605 Widget_Data *wd = elm_widget_data_get(obj);
606 if (!wd) return -1.0;
611 * Set if the first item should follow the last and vice versa
613 * @param obj The slideshow object
614 * @param loop if EINA_TRUE, the first item will follow the last and vice versa
619 elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop)
621 ELM_CHECK_WIDTYPE(obj, widtype);
622 Widget_Data *wd = elm_widget_data_get(obj);
628 * Returns the current layout name
630 * @param obj The slideshow object
631 * @returns Returns the layout name
636 elm_slideshow_layout_get(const Evas_Object *obj)
638 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
639 Widget_Data *wd = elm_widget_data_get(obj);
640 if (!wd) return EINA_FALSE;
641 return wd->layout.current;
647 * @param obj The slideshow object
648 * @param layout the new layout
653 elm_slideshow_layout_set(Evas_Object *obj, const char *layout)
656 ELM_CHECK_WIDTYPE(obj, widtype);
657 Widget_Data *wd = elm_widget_data_get(obj);
660 wd->layout.current = layout;
661 snprintf(buf, sizeof(buf), "layout,%s", layout);
662 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
666 * Return if the first item should follow the last and vice versa
668 * @param obj The slideshow object
669 * @returns Returns the loop flag
674 elm_slideshow_loop_get(const Evas_Object *obj)
676 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
677 Widget_Data *wd = elm_widget_data_get(obj);
678 if (!wd) return EINA_FALSE;
683 * Delete all the items
685 * @param obj The slideshow object
690 elm_slideshow_clear(Evas_Object *obj)
692 Elm_Slideshow_Item *item;
693 ELM_CHECK_WIDTYPE(obj, widtype);
694 Widget_Data *wd = elm_widget_data_get(obj);
698 EINA_LIST_FREE(wd->items_built, item)
700 if (item->itc->func.del)
701 item->itc->func.del((void*)item->base.data, item->base.view);
702 evas_object_del(item->base.view);
703 item->base.view = NULL;
706 EINA_LIST_FREE(wd->items, item)
708 elm_widget_item_del(item);
716 * @param item The slideshow item
721 elm_slideshow_item_del(Elm_Slideshow_Item *item)
723 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
724 Widget_Data *wd = elm_widget_data_get(item->base.widget);
726 if (wd->previous == item) wd->previous = NULL;
727 if (wd->current == item)
729 Eina_List *l = eina_list_data_find_list(wd->items, item);
730 Eina_List *l2 = eina_list_next(l);
733 l2 = eina_list_nth_list(wd->items, eina_list_count(wd->items) - 1);
735 elm_slideshow_show(eina_list_data_get(l2));
738 wd->items = eina_list_remove_list(wd->items, item->l);
739 wd->items_built = eina_list_remove_list(wd->items_built, item->l_built);
741 if ((item->base.view) && (item->itc->func.del))
742 item->itc->func.del((void*)item->base.data, item->base.view);
744 evas_object_del(item->base.view);
749 * Returns the list of items
750 * @param obj The slideshow object
751 * @return Returns the list of items (list of Elm_Slideshow_Item).
755 EAPI const Eina_List *
756 elm_slideshow_items_get(const Evas_Object *obj)
758 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
759 Widget_Data *wd = elm_widget_data_get(obj);
760 if (!wd) return NULL;
766 * Returns the current item displayed
768 * @param obj The slideshow object
769 * @return Returns the current item displayed
773 EAPI Elm_Slideshow_Item *
774 elm_slideshow_item_current_get(const Evas_Object *obj)
776 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
777 Widget_Data *wd = elm_widget_data_get(obj);
778 if (!wd) return NULL;
783 * Returns the evas object associated to an item
785 * @param item The slideshow item
786 * @return Returns the evas object associated to this item
791 elm_slideshow_item_object_get(const Elm_Slideshow_Item * item)
793 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
794 return item->base.view;
798 * Returns the data associated to an item
800 * @param item The slideshow item
801 * @return Returns the data associated to this item
806 elm_slideshow_item_data_get(const Elm_Slideshow_Item * item)
808 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
809 return elm_widget_item_data_get(item);