[elm] Slideshow now inheritable.

SVN revision: 74681

diff --git a/src/lib/elm_slideshow.c b/src/lib/elm_slideshow.c
index a784416..56fd0f9 100644 (file)
--- a/src/lib/elm_slideshow.c
+++ b/src/lib/elm_slideshow.c
@@ -1,47 +1,8 @@
 #include <Elementary.h>
 #include "elm_priv.h"
-#include "elm_widget_layout.h"
+#include "elm_widget_slideshow.h"
 
-static const char SLIDESHOW_SMART_NAME[] = "elm_slideshow";
-
-typedef struct _Elm_Slideshow_Smart_Data Elm_Slideshow_Smart_Data;
-typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item;
-
-struct _Elm_Slideshow_Item
-{
-   ELM_WIDGET_ITEM;
-
-   Eina_List                      *l, *l_built;
-
-   const Elm_Slideshow_Item_Class *itc;
-};
-
-struct _Elm_Slideshow_Smart_Data
-{
-   Elm_Layout_Smart_Data base;
-
-   // list of Elm_Slideshow_Item*
-   Eina_List            *items;
-   Eina_List            *items_built;
-
-   Elm_Slideshow_Item   *current;
-   Elm_Slideshow_Item   *previous;
-
-   Eina_List            *transitions;
-   const char           *transition;
-
-   int                   count_item_pre_before;
-   int                   count_item_pre_after;
-   Ecore_Timer          *timer;
-   double                timeout;
-   Eina_Bool             loop : 1;
-
-   struct
-   {
-      const char *current;
-      Eina_List  *list;  //list of const char *
-   } layout;
-};
+EAPI const char ELM_SLIDESHOW_SMART_NAME[] = "elm_slideshow";
 
 static const char SIG_CHANGED[] = "changed";
 static const char SIG_TRANSITION_END[] = "transition,end";
@@ -52,43 +13,8 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = {
    {NULL, NULL}
 };
 
-#define ELM_SLIDESHOW_DATA_GET(o, sd) \
-  Elm_Slideshow_Smart_Data * sd = evas_object_smart_data_get(o)
-
-#define ELM_SLIDESHOW_DATA_GET_OR_RETURN(o, ptr)     \
-  ELM_SLIDESHOW_DATA_GET(o, ptr);                    \
-  if (!ptr)                                          \
-    {                                                \
-       CRITICAL("No widget data for object %p (%s)", \
-                o, evas_object_type_get(o));         \
-       return;                                       \
-    }
-
-#define ELM_SLIDESHOW_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
-  ELM_SLIDESHOW_DATA_GET(o, ptr);                         \
-  if (!ptr)                                               \
-    {                                                     \
-       CRITICAL("No widget data for object %p (%s)",      \
-                o, evas_object_type_get(o));              \
-       return val;                                        \
-    }
-
-#define ELM_SLIDESHOW_CHECK(obj)                                             \
-  if (!obj || !elm_widget_type_check((obj), SLIDESHOW_SMART_NAME, __func__)) \
-    return
-
-#define ELM_SLIDESHOW_ITEM_CHECK(it)                        \
-  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
-  ELM_SLIDESHOW_CHECK(it->base.widget);
-
-#define ELM_SLIDESHOW_ITEM_CHECK_OR_RETURN(it, ...)                    \
-  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
-  ELM_SLIDESHOW_CHECK(it->base.widget) __VA_ARGS__;
-
-/* Inheriting from elm_layout. Besides, we need no more than what is
- * there */
 EVAS_SMART_SUBCLASS_NEW
-  (SLIDESHOW_SMART_NAME, _elm_slideshow, Elm_Layout_Smart_Class,
+  (ELM_SLIDESHOW_SMART_NAME, _elm_slideshow, Elm_Slideshow_Smart_Class,
   Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks);
 
 static Eina_Bool
@@ -429,7 +355,7 @@ _elm_slideshow_smart_del(Evas_Object *obj)
 }
 
 static void
-_elm_slideshow_smart_set_user(Elm_Layout_Smart_Class *sc)
+_elm_slideshow_smart_set_user(Elm_Slideshow_Smart_Class *sc)
 {
    ELM_WIDGET_CLASS(sc)->base.add = _elm_slideshow_smart_add;
    ELM_WIDGET_CLASS(sc)->base.del = _elm_slideshow_smart_del;
@@ -440,7 +366,25 @@ _elm_slideshow_smart_set_user(Elm_Layout_Smart_Class *sc)
    ELM_WIDGET_CLASS(sc)->focus_next = NULL;
    ELM_WIDGET_CLASS(sc)->focus_direction = NULL;
 
-   sc->sizing_eval = _elm_slideshow_smart_sizing_eval;
+   ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_slideshow_smart_sizing_eval;
+}
+
+EAPI const Elm_Slideshow_Smart_Class *
+elm_slideshow_smart_class_get(void)
+{
+   static Elm_Slideshow_Smart_Class _sc =
+     ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION(ELM_SLIDESHOW_SMART_NAME);
+   static const Elm_Slideshow_Smart_Class *class = NULL;
+   Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc;
+
+   if (class)
+     return class;
+
+   _elm_slideshow_smart_set(&_sc);
+   esc->callbacks = _smart_callbacks;
+   class = &_sc;
+
+   return class;
 }
 
 EAPI Evas_Object *

diff --git a/src/lib/elm_widget_slideshow.h b/src/lib/elm_widget_slideshow.h
new file mode 100644 (file)
index 0000000..6f96372
--- /dev/null
+++ b/src/lib/elm_widget_slideshow.h
@@ -0,0 +1,201 @@
+#ifndef ELM_WIDGET_SLIDESHOW_H
+#define ELM_WIDGET_SLIDESHOW_H
+
+#include "elm_widget_layout.h"
+
+/**
+ * @addtogroup Widget
+ * @{
+ *
+ * @section elm-slideshow-class The Elementary Slideshow Class
+ *
+ * Elementary, besides having the @ref Slideshow widget, exposes its
+ * foundation -- the Elementary Slideshow Class -- in order to create other
+ * widgets which are a slideshow with some more logic on top.
+ */
+
+/**
+ * @def ELM_SLIDESHOW_CLASS
+ *
+ * Use this macro to cast whichever subclass of
+ * #Elm_Slideshow_Smart_Class into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_CLASS(x) ((Elm_Slideshow_Smart_Class *)x)
+
+/**
+ * @def ELM_SLIDESHOW_DATA
+ *
+ * Use this macro to cast whichever subdata of
+ * #Elm_Slideshow_Smart_Data into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_DATA(x)  ((Elm_Slideshow_Smart_Data *)x)
+
+/**
+ * @def ELM_SLIDESHOW_SMART_CLASS_VERSION
+ *
+ * Current version for Elementary slideshow @b base smart class, a value
+ * which goes to _Elm_Slideshow_Smart_Class::version.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_SMART_CLASS_VERSION 1
+
+/**
+ * @def ELM_SLIDESHOW_SMART_CLASS_INIT
+ *
+ * Initializer for a whole #Elm_Slideshow_Smart_Class structure, with
+ * @c NULL values on its specific fields.
+ *
+ * @param smart_class_init initializer to use for the "base" field
+ * (#Evas_Smart_Class).
+ *
+ * @see EVAS_SMART_CLASS_INIT_NULL
+ * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_SMART_CLASS_INIT(smart_class_init) \
+  {smart_class_init, ELM_SLIDESHOW_SMART_CLASS_VERSION}
+
+/**
+ * @def ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
+ *
+ * Initializer to zero out a whole #Elm_Slideshow_Smart_Class structure.
+ *
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_SMART_CLASS_INIT_NULL \
+  ELM_SLIDESHOW_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
+
+/**
+ * @def ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * Initializer to zero out a whole #Elm_Slideshow_Smart_Class structure and
+ * set its name and version.
+ *
+ * This is similar to #ELM_SLIDESHOW_SMART_CLASS_INIT_NULL, but it will
+ * also set the version field of #Elm_Slideshow_Smart_Class (base field)
+ * to the latest #ELM_SLIDESHOW_SMART_CLASS_VERSION and name it to the
+ * specific value.
+ *
+ * It will keep a reference to the name field as a <c>"const char *"</c>,
+ * i.e., the name must be available while the structure is
+ * used (hint: static or global variable!) and must not be modified.
+ *
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT_NULL
+ * @see ELM_SLIDESHOW_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_SLIDESHOW_SMART_CLASS_INIT_NAME_VERSION(name) \
+  ELM_SLIDESHOW_SMART_CLASS_INIT                          \
+    (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
+
+/**
+ * Elementary slideshow base smart class. This inherits directly from
+ * #Elm_Layout_Smart_Class and is meant to build widgets extending the
+ * behavior of a slideshow.
+ *
+ * All of the functions listed on @ref Slideshow namespace will work for
+ * objects deriving from #Elm_Slideshow_Smart_Class.
+ */
+typedef struct _Elm_Slideshow_Smart_Class
+{
+   Elm_Layout_Smart_Class base;
+
+   int                    version;    /**< Version of this smart class definition */
+} Elm_Slideshow_Smart_Class;
+
+/**
+ * Base layout smart data extended with slideshow instance data.
+ */
+typedef struct _Elm_Slideshow_Smart_Data Elm_Slideshow_Smart_Data;
+typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item;
+
+struct _Elm_Slideshow_Item
+{
+   ELM_WIDGET_ITEM;
+
+   Eina_List                      *l, *l_built;
+
+   const Elm_Slideshow_Item_Class *itc;
+};
+
+struct _Elm_Slideshow_Smart_Data
+{
+   Elm_Layout_Smart_Data base;
+
+   // list of Elm_Slideshow_Item*
+   Eina_List            *items;
+   Eina_List            *items_built;
+
+   Elm_Slideshow_Item   *current;
+   Elm_Slideshow_Item   *previous;
+
+   Eina_List            *transitions;
+   const char           *transition;
+
+   int                   count_item_pre_before;
+   int                   count_item_pre_after;
+   Ecore_Timer          *timer;
+   double                timeout;
+   Eina_Bool             loop : 1;
+
+   struct
+   {
+      const char *current;
+      Eina_List  *list;  //list of const char *
+   } layout;
+};
+
+/**
+ * @}
+ */
+
+EAPI extern const char ELM_SLIDESHOW_SMART_NAME[];
+EAPI const Elm_Slideshow_Smart_Class *elm_slideshow_smart_class_get(void);
+
+#define ELM_SLIDESHOW_DATA_GET(o, sd) \
+  Elm_Slideshow_Smart_Data * sd = evas_object_smart_data_get(o)
+
+#define ELM_SLIDESHOW_DATA_GET_OR_RETURN(o, ptr)     \
+  ELM_SLIDESHOW_DATA_GET(o, ptr);                    \
+  if (!ptr)                                          \
+    {                                                \
+       CRITICAL("No widget data for object %p (%s)", \
+                o, evas_object_type_get(o));         \
+       return;                                       \
+    }
+
+#define ELM_SLIDESHOW_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
+  ELM_SLIDESHOW_DATA_GET(o, ptr);                         \
+  if (!ptr)                                               \
+    {                                                     \
+       CRITICAL("No widget data for object %p (%s)",      \
+                o, evas_object_type_get(o));              \
+       return val;                                        \
+    }
+
+#define ELM_SLIDESHOW_CHECK(obj)                     \
+  if (!obj || !elm_widget_type_check                 \
+        ((obj), ELM_SLIDESHOW_SMART_NAME, __func__)) \
+    return
+
+#define ELM_SLIDESHOW_ITEM_CHECK(it)                        \
+  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
+  ELM_SLIDESHOW_CHECK(it->base.widget);
+
+#define ELM_SLIDESHOW_ITEM_CHECK_OR_RETURN(it, ...)                    \
+  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
+  ELM_SLIDESHOW_CHECK(it->base.widget) __VA_ARGS__;
+
+#endif