1 #ifndef ELM_WIDGET_SLIDESHOW_H
2 #define ELM_WIDGET_SLIDESHOW_H
4 #include "elm_widget_layout.h"
10 * @section elm-slideshow-class The Elementary Slideshow Class
12 * Elementary, besides having the @ref Slideshow widget, exposes its
13 * foundation -- the Elementary Slideshow Class -- in order to create other
14 * widgets which are a slideshow with some more logic on top.
18 * @def ELM_SLIDESHOW_CLASS
20 * Use this macro to cast whichever subclass of
21 * #Elm_Slideshow_Smart_Class into it, so to access its fields.
25 #define ELM_SLIDESHOW_CLASS(x) ((Elm_Slideshow_Smart_Class *)x)
28 * @def ELM_SLIDESHOW_DATA
30 * Use this macro to cast whichever subdata of
31 * #Elm_Slideshow_Smart_Data into it, so to access its fields.
35 #define ELM_SLIDESHOW_DATA(x) ((Elm_Slideshow_Smart_Data *)x)
38 * @def ELM_SLIDESHOW_SMART_CLASS_VERSION
40 * Current version for Elementary slideshow @b base smart class, a value
41 * which goes to _Elm_Slideshow_Smart_Class::version.
45 #define ELM_SLIDESHOW_SMART_CLASS_VERSION 1
48 * @def ELM_SLIDESHOW_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Slideshow_Smart_Class structure, with
51 * @c NULL values on its specific fields.
53 * @param smart_class_init initializer to use for the "base" field
54 * (#Evas_Smart_Class).
56 * @see EVAS_SMART_CLASS_INIT_NULL
57 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
58 * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
59 * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_SLIDESHOW_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_SLIDESHOW_SMART_CLASS_VERSION}
67 * @def ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Slideshow_Smart_Class structure.
71 * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_SLIDESHOW_SMART_CLASS_INIT
76 #define ELM_SLIDESHOW_SMART_CLASS_INIT_NULL \
77 ELM_SLIDESHOW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Slideshow_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_SLIDESHOW_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Slideshow_Smart_Class (base field)
87 * to the latest #ELM_SLIDESHOW_SMART_CLASS_VERSION and name it to the
90 * It will keep a reference to the name field as a <c>"const char *"</c>,
91 * i.e., the name must be available while the structure is
92 * used (hint: static or global variable!) and must not be modified.
94 * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
95 * @see ELM_SLIDESHOW_SMART_CLASS_INIT
99 #define ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_SLIDESHOW_SMART_CLASS_INIT \
101 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
104 * Elementary slideshow base smart class. This inherits directly from
105 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
106 * behavior of a slideshow.
108 * All of the functions listed on @ref Slideshow namespace will work for
109 * objects deriving from #Elm_Slideshow_Smart_Class.
111 typedef struct _Elm_Slideshow_Smart_Class
113 Elm_Layout_Smart_Class base;
115 int version; /**< Version of this smart class definition */
116 } Elm_Slideshow_Smart_Class;
119 * Base layout smart data extended with slideshow instance data.
121 typedef struct _Elm_Slideshow_Smart_Data Elm_Slideshow_Smart_Data;
122 typedef struct _Elm_Slideshow_Item Elm_Slideshow_Item;
124 struct _Elm_Slideshow_Item
128 Eina_List *l, *l_built;
130 const Elm_Slideshow_Item_Class *itc;
133 struct _Elm_Slideshow_Smart_Data
135 Elm_Layout_Smart_Data base;
137 // list of Elm_Slideshow_Item*
139 Eina_List *items_built;
141 Elm_Slideshow_Item *current;
142 Elm_Slideshow_Item *previous;
144 Eina_List *transitions;
145 const char *transition;
147 int count_item_pre_before;
148 int count_item_pre_after;
156 Eina_List *list; //list of const char *
164 EAPI extern const char ELM_SLIDESHOW_SMART_NAME[];
165 EAPI const Elm_Slideshow_Smart_Class *elm_slideshow_smart_class_get(void);
167 #define ELM_SLIDESHOW_DATA_GET(o, sd) \
168 Elm_Slideshow_Smart_Data * sd = evas_object_smart_data_get(o)
170 #define ELM_SLIDESHOW_DATA_GET_OR_RETURN(o, ptr) \
171 ELM_SLIDESHOW_DATA_GET(o, ptr); \
174 CRITICAL("No widget data for object %p (%s)", \
175 o, evas_object_type_get(o)); \
179 #define ELM_SLIDESHOW_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
180 ELM_SLIDESHOW_DATA_GET(o, ptr); \
183 CRITICAL("No widget data for object %p (%s)", \
184 o, evas_object_type_get(o)); \
188 #define ELM_SLIDESHOW_CHECK(obj) \
189 if (!obj || !elm_widget_type_check \
190 ((obj), ELM_SLIDESHOW_SMART_NAME, __func__)) \
193 #define ELM_SLIDESHOW_ITEM_CHECK(it) \
194 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
195 ELM_SLIDESHOW_CHECK(it->base.widget);
197 #define ELM_SLIDESHOW_ITEM_CHECK_OR_RETURN(it, ...) \
198 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
199 ELM_SLIDESHOW_CHECK(it->base.widget) __VA_ARGS__;