efl/legacy/elementary/src/lib/elm_slideshow.c

/*
 * vim:ts=8:sw=3:sts=8:noexpandtab:cino=>5n-3f0^-2{2
 */
#include <Elementary.h>
#include "elm_priv.h"

/**
 * @defgroup Slideshow slideshow
 *
 * This object display a list of object (generally a list of images) and some actions like
 * next/previous are used to navigate. The animations are defined in the theme,
 * consequently new animations can be added without having to update the
 * applications.
 *
 */

typedef struct _Widget_Data Widget_Data;

struct _Widget_Data
{
   Evas_Object *slideshow;

   // list of Evas_Object*
   Eina_List *items;
   int current;
   Evas_Object *previous;
   int loop;

   Eina_List *transitions;
   const char *transition;

   Ecore_Timer *timer;
   int timeout;
};

static void _del_hook(Evas_Object *obj);
static void _theme_hook(Evas_Object *obj);
static void _sizing_eval(Evas_Object *obj);
static void _changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info);
static void _signal_clicked(void *data, Evas *e, Evas_Object *obj, void *event_info);
static void _signal_move(void *data, Evas *e, Evas_Object *obj, void *event_info);
static int _timer_cb(void *data);

static void
_del_hook(Evas_Object *obj)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   elm_slideshow_clear(obj);
   _stringlist_free(wd->transitions);
   if (wd->timer) ecore_timer_del(wd->timer);
   free(wd);
}

static void
_theme_hook(Evas_Object *obj)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   _elm_theme_set(wd->slideshow, "slideshow", "base", "default");
   edje_object_scale_set(wd->slideshow, elm_widget_scale_get(obj) * 
                         _elm_config->scale);
   _sizing_eval(obj);
}

static void
_sizing_eval(Evas_Object *obj)
{
   Widget_Data *wd = elm_widget_data_get(obj);
   Evas_Coord minw = -1, minh = -1;

   edje_object_size_min_calc(wd->slideshow, &minw, &minh);
   evas_object_size_hint_min_set(obj, minw, minh);
   evas_object_size_hint_max_set(obj, minw, minh);
}

static void
_changed_size_hints(void *data, Evas *e, Evas_Object *obj, void *event_info)
{
   Widget_Data *wd = elm_widget_data_get(data);

   _sizing_eval(data);
}

static void
_sub_del(void *data, Evas_Object *obj, void *event_info)
{
   Widget_Data *wd = elm_widget_data_get(obj);
   Evas_Object *sub = event_info;
}

static void
_signal_clicked(void *data, Evas *e, Evas_Object *obj, void *event_info)
{
   Widget_Data *wd = elm_widget_data_get(data);

   if (!wd) return;
   evas_object_smart_callback_call(data, "clicked", NULL);
}

static void
_signal_move(void *data, Evas *e, Evas_Object *obj, void *event_info)
{
   Widget_Data *wd = elm_widget_data_get(data);

   if (!wd) return;
   evas_object_smart_callback_call(data, "move", NULL);
}

static void
_end(void *data, Evas_Object *obj, const char *emission, const char *source)
{
   Evas_Object *o;
   Eina_List *l;
   const char *part;
   Widget_Data *wd = elm_widget_data_get(data);

   if(wd->previous)
     {
	edje_object_part_unswallow(NULL, wd->previous);
	evas_object_hide(wd->previous);
	wd->previous = NULL;
     }

   o = eina_list_nth(wd->items, wd->current);
   if(!o) return;

   edje_object_part_unswallow(NULL, o);
   edje_object_part_swallow(wd->slideshow, "elm.swallow.1", o);
   if(wd->timeout>0)
     wd->timer = ecore_timer_add(wd->timeout, _timer_cb, data);
}


static int
_timer_cb(void *data)
{
   Evas_Object *obj = data;
   Widget_Data *wd = elm_widget_data_get(obj);

   wd->timer = NULL;
   elm_slideshow_next(obj);
   return 0;
}

/**
 * Add a new slideshow to the parent
 *
 * @param parent The parent object
 * @return The new object or NULL if it cannot be created
 *
 * @ingroup Slideshow
 */
EAPI Evas_Object *
elm_slideshow_add(Evas_Object *parent)
{
   Evas_Object *obj;
   Evas *e;
   Widget_Data *wd;

   wd = ELM_NEW(Widget_Data);
   e = evas_object_evas_get(parent);
   obj = elm_widget_add(e);
   elm_widget_type_set(obj, "slideshow");
   elm_widget_sub_object_add(parent, obj);
   elm_widget_data_set(obj, wd);
   elm_widget_del_hook_set(obj, _del_hook);
   elm_widget_theme_hook_set(obj, _theme_hook);

   wd->current = -1;
   wd->previous = NULL;

   wd->slideshow = edje_object_add(e);
   _elm_theme_set(wd->slideshow, "slideshow", "base", "default");
   elm_widget_resize_object_set(obj, wd->slideshow);
   evas_object_show(wd->slideshow);

   wd->transitions = _stringlist_get(edje_object_data_get(wd->slideshow, "transitions"));
   if(eina_list_count(wd->transitions) > 0)
     wd->transition = eina_stringshare_add(eina_list_data_get(wd->transitions));

   edje_object_signal_callback_add(wd->slideshow, "end", "slideshow", _end, obj);

   evas_object_event_callback_add(wd->slideshow, EVAS_CALLBACK_MOUSE_DOWN, 
                                  _signal_clicked, obj);
   evas_object_event_callback_add(wd->slideshow, EVAS_CALLBACK_MOUSE_MOVE, 
                                  _signal_move, obj);

   evas_object_smart_callback_add(obj, "sub-object-del", _sub_del, obj);

   _sizing_eval(obj);
   return obj;
}

/**
 * Add a object in the list. The object can be a evas object image or a elm photo for example.
 * 
 * The object will become a member of the slideshow and will be deleted at the same time than the slideshow.
 * @param obj The slideshow object
 * @param file The object
 */
EAPI void
elm_slideshow_item_add(Evas_Object *obj, Evas_Object *item)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;

   wd->items = eina_list_append(wd->items, item);

   if(eina_list_count(wd->items) == 1)
     elm_slideshow_goto(obj, 0);
}

/**
 * Go to the item number @pos
 *
 * @param obj The slideshow object
 * @param pos The position of the item
 */
EAPI void
elm_slideshow_goto(Evas_Object *obj, int pos)
{
   Evas_Object *o;
   Eina_List *l;
   const char *part;
   Widget_Data *wd = elm_widget_data_get(obj);

   if (!wd) return;
   if ((pos < 0) || (pos>=eina_list_count(wd->items))) return;

   _end(obj, obj, NULL, NULL);

   wd->previous = eina_list_nth(wd->items, wd->current);
   wd->current = pos;
   o = eina_list_nth(wd->items, wd->current);

   _end(obj, obj, NULL, NULL);
}

/**
 * Go to the next item
 *
 * @param obj The slideshow object
 */
EAPI void
elm_slideshow_next(Evas_Object *obj)
{
   char buf[1024];
   Eina_List *l;
   const char *part;
   Evas_Object *o;
   int next;
   Widget_Data *wd = elm_widget_data_get(obj);

   if (!wd) return;
   if ((eina_list_count(wd->items) <= 0) || 
       ((wd->current >= eina_list_count(wd->items) - 1))
       && (!wd->loop))
     return;

   if (wd->current >= eina_list_count(wd->items) - 1)
     next = 0;
   else
     next = wd->current + 1;

   o = eina_list_nth(wd->items, next);

   _end(obj, obj, NULL, NULL);

   edje_object_part_swallow(wd->slideshow, "elm.swallow.2", o);

   snprintf(buf, 1024, "%s,next", wd->transition);
   edje_object_signal_emit(wd->slideshow, buf, "slideshow");

   wd->previous = eina_list_nth(wd->items, wd->current);
   wd->current = next;

   if (wd->timer) ecore_timer_del(wd->timer);
   wd->timer = NULL;
}

/**
 * Go to the previous item
 *
 * @param obj The slideshow object
 */
   EAPI void
elm_slideshow_previous(Evas_Object *obj)
{
   char buf[1024];
   Eina_List *l;
   const char *part;
   Evas_Object *o;
   int previous;
   Widget_Data *wd = elm_widget_data_get(obj);

   if (!wd) return;
   if ((eina_list_count(wd->items) <= 0)
       || (wd->current <= 0 && !wd->loop))
     return;

   if (wd->current <= 0)
     previous = eina_list_count(wd->items) - 1;
   else
     previous = wd->current - 1;

   o = eina_list_nth(wd->items, previous);

   _end(obj, obj, NULL, NULL);

   edje_object_part_swallow(wd->slideshow, "elm.swallow.2", o);

   snprintf(buf, 1024, "%s,previous", wd->transition);
   edje_object_signal_emit(wd->slideshow, buf, "slideshow");

   wd->previous = eina_list_nth(wd->items, wd->current);
   wd->current = previous;

   if (wd->timer) ecore_timer_del(wd->timer);
   wd->timer = NULL;
}

/**
 * Returns the list of transitions available.
 *
 * @param obj The slideshow object
 * @return Returns the list of transitions (list of char*)
 */
const Eina_List *
elm_slideshow_transitions_get(Evas_Object *obj)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   return wd->transitions;
}

/**
 * Set the transition to use
 *
 * @param obj The slideshow object
 * @param transition the new transition
 */
EAPI void
elm_slideshow_transition_set(Evas_Object *obj, const char *transition)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   eina_stringshare_del(wd->transition);
   wd->transition = eina_stringshare_add(transition);
}

/**
 * The slideshow can go to the next item automatically after a few seconds.
 * This method set the timeout to use. A timeout <=0 disable the timer.
 *
 * @param obj The slideshow object
 * @param timeout The new timeout
 */
EAPI void
elm_slideshow_timeout_set(Evas_Object *obj ,int timeout)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   wd->timeout = timeout;
   if (wd->timer) ecore_timer_del(wd->timer);
   wd->timer = NULL;
   if (timeout>0)
     wd->timer = ecore_timer_add(timeout, _timer_cb, obj);
}

/**
 * Returns the timeout value
 *
 * @param obj The slideshow object
 * @return Returns the timeout
 */
EAPI int
elm_slideshow_timeout_get(Evas_Object *obj)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   return wd->timeout;
}

/**
 * Set if the first item should follow the last and vice versa
 *
 * @param obj The slideshow object
 * @param loop if 1, the first item will follow the last and vice versa
 */
EAPI void
elm_slideshow_loop_set(Evas_Object *obj, int loop)
{
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;
   wd->loop = loop;
}

/**
 * Delete all the itemns
 *
 * @param obj The slideshow object
 */
EAPI void
elm_slideshow_clear(Evas_Object *obj)
{
   Evas_Object *o;
   Widget_Data *wd = elm_widget_data_get(obj);

   if(!wd) return;

   wd->previous = NULL;
   wd->current = -1;
   EINA_LIST_FREE(wd->items, o)
     {
	evas_object_del(o);
     }
}