[elm] Mapbuf now inheritable.

SVN revision: 74676

diff --git a/src/lib/elm_mapbuf.c b/src/lib/elm_mapbuf.c
index 3365b69..70ed60f 100644 (file)
--- a/src/lib/elm_mapbuf.c
+++ b/src/lib/elm_mapbuf.c
@@ -1,49 +1,11 @@
 #include <Elementary.h>
 #include "elm_priv.h"
-#include "elm_widget_container.h"
+#include "elm_widget_mapbuf.h"
 
-static const char MAPBUF_SMART_NAME[] = "elm_mapbuf";
-
-typedef struct _Elm_Mapbuf_Smart_Data Elm_Mapbuf_Smart_Data;
-
-struct _Elm_Mapbuf_Smart_Data
-{
-   Elm_Widget_Smart_Data base;
-
-   Evas_Object          *content;
-
-   Eina_Bool             enabled : 1;
-   Eina_Bool             smooth : 1;
-   Eina_Bool             alpha : 1;
-};
-
-#define ELM_MAPBUF_DATA_GET(o, sd) \
-  Elm_Mapbuf_Smart_Data * sd = evas_object_smart_data_get(o)
-
-#define ELM_MAPBUF_DATA_GET_OR_RETURN(o, ptr)        \
-  ELM_MAPBUF_DATA_GET(o, ptr);                       \
-  if (!ptr)                                          \
-    {                                                \
-       CRITICAL("No widget data for object %p (%s)", \
-                o, evas_object_type_get(o));         \
-       return;                                       \
-    }
-
-#define ELM_MAPBUF_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
-  ELM_MAPBUF_DATA_GET(o, ptr);                         \
-  if (!ptr)                                            \
-    {                                                  \
-       CRITICAL("No widget data for object %p (%s)",   \
-                o, evas_object_type_get(o));           \
-       return val;                                     \
-    }
-
-#define ELM_MAPBUF_CHECK(obj)                                             \
-  if (!obj || !elm_widget_type_check((obj), MAPBUF_SMART_NAME, __func__)) \
-    return
+EAPI const char ELM_MAPBUF_SMART_NAME[] = "elm_mapbuf";
 
 EVAS_SMART_SUBCLASS_NEW
-  (MAPBUF_SMART_NAME, _elm_mapbuf, Elm_Container_Smart_Class,
+  (ELM_MAPBUF_SMART_NAME, _elm_mapbuf, Elm_Mapbuf_Smart_Class,
   Elm_Container_Smart_Class, elm_container_smart_class_get, NULL);
 
 static void
@@ -272,7 +234,7 @@ _elm_mapbuf_smart_add(Evas_Object *obj)
 }
 
 static void
-_elm_mapbuf_smart_set_user(Elm_Container_Smart_Class *sc)
+_elm_mapbuf_smart_set_user(Elm_Mapbuf_Smart_Class *sc)
 {
    ELM_WIDGET_CLASS(sc)->base.add = _elm_mapbuf_smart_add;
    ELM_WIDGET_CLASS(sc)->base.resize = _elm_mapbuf_smart_resize;
@@ -281,9 +243,24 @@ _elm_mapbuf_smart_set_user(Elm_Container_Smart_Class *sc)
    ELM_WIDGET_CLASS(sc)->theme = _elm_mapbuf_smart_theme;
    ELM_WIDGET_CLASS(sc)->sub_object_del = _elm_mapbuf_smart_sub_object_del;
 
-   sc->content_set = _elm_mapbuf_smart_content_set;
-   sc->content_get = _elm_mapbuf_smart_content_get;
-   sc->content_unset = _elm_mapbuf_smart_content_unset;
+   ELM_CONTAINER_CLASS(sc)->content_set = _elm_mapbuf_smart_content_set;
+   ELM_CONTAINER_CLASS(sc)->content_get = _elm_mapbuf_smart_content_get;
+   ELM_CONTAINER_CLASS(sc)->content_unset = _elm_mapbuf_smart_content_unset;
+}
+
+EAPI const Elm_Mapbuf_Smart_Class *
+elm_mapbuf_smart_class_get(void)
+{
+   static Elm_Mapbuf_Smart_Class _sc =
+     ELM_MAPBUF_SMART_CLASS_INIT_NAME_VERSION(ELM_MAPBUF_SMART_NAME);
+   static const Elm_Mapbuf_Smart_Class *class = NULL;
+
+   if (class) return class;
+
+   _elm_mapbuf_smart_set(&_sc);
+   class = &_sc;
+
+   return class;
 }
 
 EAPI Evas_Object *

diff --git a/src/lib/elm_widget_mapbuf.h b/src/lib/elm_widget_mapbuf.h
new file mode 100644 (file)
index 0000000..7d4d8e6
--- /dev/null
+++ b/src/lib/elm_widget_mapbuf.h
@@ -0,0 +1,165 @@
+#ifndef ELM_WIDGET_MAPBUF_H
+#define ELM_WIDGET_MAPBUF_H
+
+#include "elm_widget_container.h"
+
+/**
+ * @addtogroup Widget
+ * @{
+ *
+ * @section elm-mapbuf-class The Elementary Mapbuf Class
+ *
+ * Elementary, besides having the @ref Mapbuf widget, exposes its
+ * foundation -- the Elementary Mapbuf Class -- in order to create other
+ * widgets which are a mapbuf with some more logic on top.
+ */
+
+/**
+ * @def ELM_MAPBUF_CLASS
+ *
+ * Use this macro to cast whichever subclass of
+ * #Elm_Mapbuf_Smart_Class into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_CLASS(x) ((Elm_Mapbuf_Smart_Class *)x)
+
+/**
+ * @def ELM_MAPBUF_DATA
+ *
+ * Use this macro to cast whichever subdata of
+ * #Elm_Mapbuf_Smart_Data into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_DATA(x)  ((Elm_Mapbuf_Smart_Data *)x)
+
+/**
+ * @def ELM_MAPBUF_SMART_CLASS_VERSION
+ *
+ * Current version for Elementary mapbuf @b base smart class, a value
+ * which goes to _Elm_Mapbuf_Smart_Class::version.
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_SMART_CLASS_VERSION 1
+
+/**
+ * @def ELM_MAPBUF_SMART_CLASS_INIT
+ *
+ * Initializer for a whole #Elm_Mapbuf_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_MAPBUF_SMART_CLASS_INIT_NULL
+ * @see ELM_MAPBUF_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_SMART_CLASS_INIT(smart_class_init) \
+  {smart_class_init, ELM_MAPBUF_SMART_CLASS_VERSION}
+
+/**
+ * @def ELM_MAPBUF_SMART_CLASS_INIT_NULL
+ *
+ * Initializer to zero out a whole #Elm_Mapbuf_Smart_Class structure.
+ *
+ * @see ELM_MAPBUF_SMART_CLASS_INIT_NAME_VERSION
+ * @see ELM_MAPBUF_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_SMART_CLASS_INIT_NULL \
+  ELM_MAPBUF_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
+
+/**
+ * @def ELM_MAPBUF_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * Initializer to zero out a whole #Elm_Mapbuf_Smart_Class structure and
+ * set its name and version.
+ *
+ * This is similar to #ELM_MAPBUF_SMART_CLASS_INIT_NULL, but it will
+ * also set the version field of #Elm_Mapbuf_Smart_Class (base field)
+ * to the latest #ELM_MAPBUF_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_MAPBUF_SMART_CLASS_INIT_NULL
+ * @see ELM_MAPBUF_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_MAPBUF_SMART_CLASS_INIT_NAME_VERSION(name) \
+  ELM_MAPBUF_SMART_CLASS_INIT                          \
+    (ELM_CONTAINER_SMART_CLASS_INIT_NAME_VERSION(name))
+
+/**
+ * Elementary mapbuf base smart class. This inherits directly from
+ * #Elm_Container_Smart_Class and is meant to build widgets extending the
+ * behavior of a mapbuf.
+ *
+ * All of the functions listed on @ref Mapbuf namespace will work for
+ * objects deriving from #Elm_Mapbuf_Smart_Class.
+ */
+typedef struct _Elm_Mapbuf_Smart_Class
+{
+   Elm_Container_Smart_Class base;
+
+   int                       version; /**< Version of this smart class definition */
+} Elm_Mapbuf_Smart_Class;
+
+/**
+ * Base widget smart data extended with mapbuf instance data.
+ */
+typedef struct _Elm_Mapbuf_Smart_Data Elm_Mapbuf_Smart_Data;
+struct _Elm_Mapbuf_Smart_Data
+{
+   Elm_Container_Smart_Data base;
+
+   Evas_Object          *content;
+
+   Eina_Bool             enabled : 1;
+   Eina_Bool             smooth : 1;
+   Eina_Bool             alpha : 1;
+};
+
+/**
+ * @}
+ */
+
+EAPI extern const char ELM_MAPBUF_SMART_NAME[];
+EAPI const Elm_Mapbuf_Smart_Class *elm_mapbuf_smart_class_get(void);
+
+#define ELM_MAPBUF_DATA_GET(o, sd) \
+  Elm_Mapbuf_Smart_Data * sd = evas_object_smart_data_get(o)
+
+#define ELM_MAPBUF_DATA_GET_OR_RETURN(o, ptr)        \
+  ELM_MAPBUF_DATA_GET(o, ptr);                       \
+  if (!ptr)                                          \
+    {                                                \
+       CRITICAL("No widget data for object %p (%s)", \
+                o, evas_object_type_get(o));         \
+       return;                                       \
+    }
+
+#define ELM_MAPBUF_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
+  ELM_MAPBUF_DATA_GET(o, ptr);                         \
+  if (!ptr)                                            \
+    {                                                  \
+       CRITICAL("No widget data for object %p (%s)",   \
+                o, evas_object_type_get(o));           \
+       return val;                                     \
+    }
+
+#define ELM_MAPBUF_CHECK(obj)                                                 \
+  if (!obj || !elm_widget_type_check((obj), ELM_MAPBUF_SMART_NAME, __func__)) \
+    return
+
+#endif