1 #include <Elementary.h>
5 * @defgroup Slideshow Slideshow
8 * This object display a list of object (generally a list of images) and some actions like
9 * next/previous are used to navigate. The animations are defined in the theme,
10 * consequently new animations can be added without having to update the
13 * The slideshow use 2 callbacks to create and delete the objects displayed. When an item
14 * is displayed the function itc->func.get() is called. This function should create the object,
15 * for example the object can be an evas_object_image or a photocam. When a object is no more
16 * displayed the function itc->func.del() is called, the user can delete the dana associated to the item.
18 * Signals that you can add callbacks for are:
20 * "changed" - when the slideshow switch to another item
23 typedef struct _Widget_Data Widget_Data;
25 struct _Elm_Slideshow_Item
29 Eina_List *l, *l_built;
31 const Elm_Slideshow_Item_Class *itc;
36 Evas_Object *slideshow;
38 // list of Elm_Slideshow_Item*
40 Eina_List *items_built;
42 Elm_Slideshow_Item *current;
43 Elm_Slideshow_Item *previous;
45 Eina_List *transitions;
46 const char *transition;
54 Eina_List *list; //list of const char *
58 static const char *widtype = NULL;
59 static void _del_hook(Evas_Object *obj);
60 static void _mirrored_set(Evas_Object *obj, Eina_Bool rtl);
61 static void _theme_hook(Evas_Object *obj);
62 static void _sizing_eval(Evas_Object *obj);
63 static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
64 static Eina_Bool _timer_cb(void *data);
65 static void _on_focus_hook(void *data, Evas_Object *obj);
66 static Eina_Bool _event_hook(Evas_Object *obj, Evas_Object *src,
67 Evas_Callback_Type type, void *event_info);
70 _event_hook(Evas_Object *obj, Evas_Object *src __UNUSED__, Evas_Callback_Type type, void *event_info)
72 if (type != EVAS_CALLBACK_KEY_DOWN) return EINA_FALSE;
73 Evas_Event_Key_Down *ev = event_info;
74 Widget_Data *wd = elm_widget_data_get(obj);
75 if (!wd) return EINA_FALSE;
76 if (ev->event_flags & EVAS_EVENT_FLAG_ON_HOLD) return EINA_FALSE;
77 if (elm_widget_disabled_get(obj)) return EINA_FALSE;
78 if ((!strcmp(ev->keyname, "Left")) || (!strcmp(ev->keyname, "KP_Left")))
80 elm_slideshow_previous(obj);
81 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
84 if ((!strcmp(ev->keyname, "Right")) || (!strcmp(ev->keyname, "KP_Right")))
86 elm_slideshow_next(obj);
87 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
90 if ((!strcmp(ev->keyname, "Return")) ||
91 (!strcmp(ev->keyname, "KP_Enter")) ||
92 (!strcmp(ev->keyname, "space")))
98 ecore_timer_del(wd->timer);
102 elm_slideshow_timeout_set(obj, wd->timeout);
104 ev->event_flags |= EVAS_EVENT_FLAG_ON_HOLD;
111 _del_hook(Evas_Object *obj)
114 Widget_Data *wd = elm_widget_data_get(obj);
116 elm_slideshow_clear(obj);
117 elm_widget_stringlist_free(wd->transitions);
118 if (wd->timer) ecore_timer_del(wd->timer);
119 EINA_LIST_FREE(wd->layout.list, layout)
120 eina_stringshare_del(layout);
125 _on_focus_hook(void *data __UNUSED__, Evas_Object *obj)
127 Widget_Data *wd = elm_widget_data_get(obj);
129 if (elm_widget_focus_get(obj))
131 edje_object_signal_emit(wd->slideshow, "elm,action,focus", "elm");
132 evas_object_focus_set(wd->slideshow, EINA_TRUE);
136 edje_object_signal_emit(wd->slideshow, "elm,action,unfocus", "elm");
137 evas_object_focus_set(wd->slideshow, EINA_FALSE);
142 _mirrored_set(Evas_Object *obj, Eina_Bool rtl)
144 Widget_Data *wd = elm_widget_data_get(obj);
146 edje_object_mirrored_set(wd->slideshow, rtl);
150 _theme_hook(Evas_Object *obj)
152 Widget_Data *wd = elm_widget_data_get(obj);
154 _elm_widget_mirrored_reload(obj);
155 _mirrored_set(obj, elm_widget_mirrored_get(obj));
156 _elm_theme_object_set(obj, wd->slideshow, "slideshow", "base", elm_widget_style_get(obj));
157 edje_object_scale_set(wd->slideshow, elm_widget_scale_get(obj) *
163 _sizing_eval(Evas_Object *obj)
165 Widget_Data *wd = elm_widget_data_get(obj);
166 Evas_Coord minw = -1, minh = -1;
168 edje_object_size_min_calc(wd->slideshow, &minw, &minh);
169 evas_object_size_hint_min_set(obj, minw, minh);
170 evas_object_size_hint_max_set(obj, minw, minh);
174 static Elm_Slideshow_Item* _item_prev_get(Elm_Slideshow_Item* item)
176 Widget_Data *wd = elm_widget_data_get(item->base.widget);
177 Elm_Slideshow_Item* prev = eina_list_data_get(eina_list_prev(item->l));
178 if((!prev) && (wd->loop))
179 prev = eina_list_data_get(eina_list_last(item->l));
183 static Elm_Slideshow_Item* _item_next_get(Elm_Slideshow_Item* item)
185 Widget_Data *wd = elm_widget_data_get(item->base.widget);
186 Elm_Slideshow_Item* next = eina_list_data_get(eina_list_next(item->l));
187 if((!next) && (wd->loop))
188 next = eina_list_data_get(wd->items);
194 _changed_size_hints(void *data, Evas *e __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
200 _sub_del(void *data __UNUSED__, Evas_Object *obj __UNUSED__, void *event_info __UNUSED__)
206 _item_realize(Elm_Slideshow_Item *item)
208 Elm_Slideshow_Item *_item;
209 Evas_Object *obj = item->base.widget;
210 Widget_Data *wd = elm_widget_data_get(obj);
213 if ((!item->base.view) && (item->itc->func.get))
215 item->base.view = item->itc->func.get((void*)item->base.data, obj);
216 evas_object_smart_member_add(item->base.view, obj);
217 item->l_built = eina_list_append(NULL, item);
218 wd->items_built = eina_list_merge(wd->items_built, item->l_built);
219 evas_object_hide(item->base.view);
221 else if (item->l_built)
222 wd->items_built = eina_list_demote_list(wd->items_built, item->l_built);
224 //pre-create previous and next item
225 _item = _item_next_get(item);
226 if ((_item) && (!_item->base.view) && (_item->itc->func.get))
228 _item->base.view = _item->itc->func.get((void*)_item->base.data, obj);
229 evas_object_smart_member_add(_item->base.view, obj);
230 _item->l_built = eina_list_append(NULL, _item);
231 wd->items_built = eina_list_merge(wd->items_built, _item->l_built);
232 evas_object_hide(_item->base.view);
234 else if ((_item) && (_item->l_built))
235 wd->items_built = eina_list_demote_list(wd->items_built, _item->l_built);
237 _item = _item_prev_get(item);
238 if ((_item) && (!_item->base.view) && (_item->itc->func.get))
240 _item->base.view = _item->itc->func.get((void*)_item->base.data, obj);
241 evas_object_smart_member_add(_item->base.view, obj);
242 _item->l_built = eina_list_append(NULL, _item);
243 wd->items_built = eina_list_merge(wd->items_built, _item->l_built);
244 evas_object_hide(_item->base.view);
246 else if ((_item) && (_item->l_built))
247 wd->items_built = eina_list_demote_list(wd->items_built, _item->l_built);
249 //delete unused items
250 while (eina_list_count(wd->items_built) > 3)
252 _item = eina_list_data_get(wd->items_built);
253 wd->items_built = eina_list_remove_list(wd->items_built, wd->items_built);
254 if(item->itc->func.del)
255 item->itc->func.del((void*)item->base.data, _item->base.view);
256 evas_object_del(_item->base.view);
257 _item->base.view = NULL;
262 _end(void *data, Evas_Object *obj __UNUSED__, const char *emission __UNUSED__, const char *source __UNUSED__)
264 Elm_Slideshow_Item *item;
265 Widget_Data *wd = elm_widget_data_get(data);
271 edje_object_part_unswallow(NULL, item->base.view);
272 evas_object_hide(item->base.view);
278 if ((!item) || (!item->base.view)) return;
281 edje_object_part_unswallow(NULL, item->base.view);
282 evas_object_show(item->base.view);
284 edje_object_signal_emit(wd->slideshow, "anim,end", "slideshow");
285 edje_object_part_swallow(wd->slideshow, "elm.swallow.1", item->base.view);
290 _timer_cb(void *data)
292 Evas_Object *obj = data;
293 Widget_Data *wd = elm_widget_data_get(obj);
294 if (!wd) return ECORE_CALLBACK_CANCEL;
296 elm_slideshow_next(obj);
297 return ECORE_CALLBACK_CANCEL;
303 * Add a new slideshow to the parent
305 * @param parent The parent object
306 * @return The new object or NULL if it cannot be created
311 elm_slideshow_add(Evas_Object *parent)
317 ELM_WIDGET_STANDARD_SETUP(wd, Widget_Data, parent, e, obj, NULL);
319 ELM_SET_WIDTYPE(widtype, "slideshow");
320 elm_widget_type_set(obj, "slideshow");
321 elm_widget_sub_object_add(parent, obj);
322 elm_widget_on_focus_hook_set(obj, _on_focus_hook, NULL);
323 elm_widget_data_set(obj, wd);
324 elm_widget_del_hook_set(obj, _del_hook);
325 elm_widget_theme_hook_set(obj, _theme_hook);
326 elm_widget_can_focus_set(obj, EINA_TRUE);
327 elm_widget_event_hook_set(obj, _event_hook);
332 wd->slideshow = edje_object_add(e);
333 _elm_theme_object_set(obj, wd->slideshow, "slideshow", "base", "default");
334 evas_object_smart_member_add(wd->slideshow, obj);
335 elm_widget_resize_object_set(obj, wd->slideshow);
336 evas_object_show(wd->slideshow);
338 wd->transitions = elm_widget_stringlist_get(edje_object_data_get(wd->slideshow, "transitions"));
339 if (eina_list_count(wd->transitions) > 0)
340 wd->transition = eina_stringshare_add(eina_list_data_get(wd->transitions));
342 wd->layout.list = elm_widget_stringlist_get(edje_object_data_get(wd->slideshow, "layouts"));
343 if (eina_list_count(wd->layout.list) > 0)
344 wd->layout.current = eina_list_data_get(wd->layout.list);
346 edje_object_signal_callback_add(wd->slideshow, "end", "slideshow", _end, obj);
348 evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);
349 evas_object_event_callback_add(obj, EVAS_CALLBACK_CHANGED_SIZE_HINTS, _changed_size_hints, obj);
351 _mirrored_set(obj, elm_widget_mirrored_get(obj));
357 * Add a object in the list. The object can be a evas object image or a elm photo for example.
359 * @param obj The slideshow object
360 * @aram itc Callbacks used to create the object and delete the data associated when the item is deleted.
361 * @param data Data used by the user to identified the item
362 * @return Returns The slideshow item
366 EAPI Elm_Slideshow_Item*
367 elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data)
369 Elm_Slideshow_Item *item;
370 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
371 Widget_Data *wd = elm_widget_data_get(obj);
373 if (!wd) return NULL;
374 item = elm_widget_item_new(obj, Elm_Slideshow_Item);
375 item->base.data = data;
377 item->l = eina_list_append(item->l, item);
379 wd->items = eina_list_merge(wd->items, item->l);
381 if (!wd->current) elm_slideshow_show(item);
389 * @param obj The slideshow object
390 * @param item The item
395 elm_slideshow_show(Elm_Slideshow_Item *item)
398 Elm_Slideshow_Item *next = NULL;
400 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
401 wd = elm_widget_data_get(item->base.widget);
404 if (item == wd->current)
408 _end(item->base.widget, item->base.widget, NULL, NULL);
410 if (wd->timer) ecore_timer_del(wd->timer);
411 if (wd->timeout > 0.0)
412 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, item->base.widget);
414 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", next->base.view);
415 evas_object_show(next->base.view);
416 snprintf(buf, sizeof(buf), "%s,next", wd->transition);
417 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
418 wd->previous = wd->current;
420 evas_object_smart_callback_call(item->base.widget, "changed", wd->current);
424 * Go to the next item
426 * @param obj The slideshow object
431 elm_slideshow_next(Evas_Object *obj)
434 Elm_Slideshow_Item *next = NULL;
435 ELM_CHECK_WIDTYPE(obj, widtype);
436 Widget_Data *wd = elm_widget_data_get(obj);
441 next = _item_next_get(wd->current);
443 if ((!next) || (next == wd->current)) return;
445 _end(obj, obj, NULL, NULL);
447 if (wd->timer) ecore_timer_del(wd->timer);
448 if (wd->timeout > 0.0)
449 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, obj);
453 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", next->base.view);
454 evas_object_show(next->base.view);
456 snprintf(buf, sizeof(buf), "%s,next", wd->transition);
457 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
459 wd->previous = wd->current;
461 evas_object_smart_callback_call(obj, "changed", wd->current);
465 * Go to the previous item
467 * @param obj The slideshow object
472 elm_slideshow_previous(Evas_Object *obj)
475 Elm_Slideshow_Item *prev = NULL;
476 ELM_CHECK_WIDTYPE(obj, widtype);
477 Widget_Data *wd = elm_widget_data_get(obj);
482 prev = _item_prev_get(wd->current);
484 if ((!prev) || (prev == wd->current)) return;
486 _end(obj, obj, NULL, NULL);
488 if (wd->timer) ecore_timer_del(wd->timer);
489 if (wd->timeout > 0.0)
490 wd->timer = ecore_timer_add(wd->timeout, _timer_cb, obj);
494 edje_object_part_swallow(wd->slideshow, "elm.swallow.2", prev->base.view);
495 evas_object_show(prev->base.view);
497 snprintf(buf, 1024, "%s,previous", wd->transition);
498 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
500 wd->previous = wd->current;
502 evas_object_smart_callback_call(obj, "changed", wd->current);
506 * Returns the list of transitions available.
508 * @param obj The slideshow object
509 * @return Returns the list of transitions (list of const char*)
513 EAPI const Eina_List *
514 elm_slideshow_transitions_get(const Evas_Object *obj)
516 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
517 Widget_Data *wd = elm_widget_data_get(obj);
518 if (!wd) return NULL;
519 return wd->transitions;
523 * Returns the list of layouts available.
525 * @param obj The slideshow object
526 * @return Returns the list of layout (list of const char*)
530 EAPI const Eina_List *
531 elm_slideshow_layouts_get(const Evas_Object *obj)
533 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
534 Widget_Data *wd = elm_widget_data_get(obj);
535 if (!wd) return NULL;
536 return wd->layout.list;
540 * Set the transition to use
542 * @param obj The slideshow object
543 * @param transition the new transition
548 elm_slideshow_transition_set(Evas_Object *obj, const char *transition)
550 ELM_CHECK_WIDTYPE(obj, widtype);
551 Widget_Data *wd = elm_widget_data_get(obj);
553 eina_stringshare_replace(&wd->transition, transition);
557 * Returns the transition to use
559 * @param obj The slideshow object
560 * @return the transition set
565 elm_slideshow_transition_get(const Evas_Object *obj)
567 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
568 Widget_Data *wd = elm_widget_data_get(obj);
569 if (!wd) return NULL;
570 return wd->transition;
574 * The slideshow can go to the next item automatically after a few seconds.
575 * This method set the timeout to use. A timeout <=0 disable the timer.
577 * @param obj The slideshow object
578 * @param timeout The new timeout
583 elm_slideshow_timeout_set(Evas_Object *obj, double timeout)
585 ELM_CHECK_WIDTYPE(obj, widtype);
586 Widget_Data *wd = elm_widget_data_get(obj);
588 wd->timeout = timeout;
589 if (wd->timer) ecore_timer_del(wd->timer);
592 wd->timer = ecore_timer_add(timeout, _timer_cb, obj);
596 * Returns the timeout value
598 * @param obj The slideshow object
599 * @return Returns the timeout
604 elm_slideshow_timeout_get(const Evas_Object *obj)
606 ELM_CHECK_WIDTYPE(obj, widtype) -1.0;
607 Widget_Data *wd = elm_widget_data_get(obj);
608 if (!wd) return -1.0;
613 * Set if the first item should follow the last and vice versa
615 * @param obj The slideshow object
616 * @param loop if EINA_TRUE, the first item will follow the last and vice versa
621 elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop)
623 ELM_CHECK_WIDTYPE(obj, widtype);
624 Widget_Data *wd = elm_widget_data_get(obj);
630 * Returns the current layout name
632 * @param obj The slideshow object
633 * @returns Returns the layout name
638 elm_slideshow_layout_get(const Evas_Object *obj)
640 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
641 Widget_Data *wd = elm_widget_data_get(obj);
642 if (!wd) return EINA_FALSE;
643 return wd->layout.current;
649 * @param obj The slideshow object
650 * @param layout the new layout
655 elm_slideshow_layout_set(Evas_Object *obj, const char *layout)
658 ELM_CHECK_WIDTYPE(obj, widtype);
659 Widget_Data *wd = elm_widget_data_get(obj);
662 wd->layout.current = layout;
663 snprintf(buf, sizeof(buf), "layout,%s", layout);
664 edje_object_signal_emit(wd->slideshow, buf, "slideshow");
668 * Return if the first item should follow the last and vice versa
670 * @param obj The slideshow object
671 * @returns Returns the loop flag
676 elm_slideshow_loop_get(const Evas_Object *obj)
678 ELM_CHECK_WIDTYPE(obj, widtype) EINA_FALSE;
679 Widget_Data *wd = elm_widget_data_get(obj);
680 if (!wd) return EINA_FALSE;
685 * Delete all the items
687 * @param obj The slideshow object
692 elm_slideshow_clear(Evas_Object *obj)
694 Elm_Slideshow_Item *item;
695 ELM_CHECK_WIDTYPE(obj, widtype);
696 Widget_Data *wd = elm_widget_data_get(obj);
700 EINA_LIST_FREE(wd->items_built, item)
702 if (item->itc->func.del)
703 item->itc->func.del((void*)item->base.data, item->base.view);
704 evas_object_del(item->base.view);
705 item->base.view = NULL;
708 EINA_LIST_FREE(wd->items, item)
710 elm_widget_item_del(item);
718 * @param item The slideshow item
723 elm_slideshow_item_del(Elm_Slideshow_Item *item)
725 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item);
726 Widget_Data *wd = elm_widget_data_get(item->base.widget);
728 if (wd->previous == item) wd->previous = NULL;
729 if (wd->current == item)
731 Eina_List *l = eina_list_data_find_list(wd->items, item);
732 Eina_List *l2 = eina_list_next(l);
735 l2 = eina_list_nth_list(wd->items, eina_list_count(wd->items) - 1);
737 elm_slideshow_show(eina_list_data_get(l2));
740 wd->items = eina_list_remove_list(wd->items, item->l);
741 wd->items_built = eina_list_remove_list(wd->items_built, item->l_built);
743 if ((item->base.view) && (item->itc->func.del))
744 item->itc->func.del((void*)item->base.data, item->base.view);
746 evas_object_del(item->base.view);
751 * Returns the list of items
752 * @param obj The slideshow object
753 * @return Returns the list of items (list of Elm_Slideshow_Item).
757 EAPI const Eina_List *
758 elm_slideshow_items_get(const Evas_Object *obj)
760 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
761 Widget_Data *wd = elm_widget_data_get(obj);
762 if (!wd) return NULL;
768 * Returns the current item displayed
770 * @param obj The slideshow object
771 * @return Returns the current item displayed
775 EAPI Elm_Slideshow_Item *
776 elm_slideshow_item_current_get(const Evas_Object *obj)
778 ELM_CHECK_WIDTYPE(obj, widtype) NULL;
779 Widget_Data *wd = elm_widget_data_get(obj);
780 if (!wd) return NULL;
785 * Returns the evas object associated to an item
787 * @param item The slideshow item
788 * @return Returns the evas object associated to this item
793 elm_slideshow_item_object_get(const Elm_Slideshow_Item * item)
795 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
796 return item->base.view;
800 * Returns the data associated to an item
802 * @param item The slideshow item
803 * @return Returns the data associated to this item
808 elm_slideshow_item_data_get(const Elm_Slideshow_Item * item)
810 ELM_WIDGET_ITEM_WIDTYPE_CHECK_OR_RETURN(item, NULL);
811 return elm_widget_item_data_get(item);