[elm] Spinner now inheritable.
authorGustavo Lima Chaves <glima@profusion.mobi>
Wed, 1 Aug 2012 21:03:58 +0000 (21:03 +0000)
committerGustavo Lima Chaves <glima@profusion.mobi>
Wed, 1 Aug 2012 21:03:58 +0000 (21:03 +0000)
SVN revision: 74759

src/lib/Makefile.am
src/lib/elm_spinner.c
src/lib/elm_widget_spinner.h [new file with mode: 0644]

index 1fa3a65..b2768b5 100644 (file)
@@ -85,6 +85,7 @@ elm_widget_segment_control.h \
 elm_widget_separator.h \
 elm_widget_slider.h \
 elm_widget_slideshow.h \
+elm_widget_spinner.h \
 elm_widget_table.h \
 elm_widget_thumb.h \
 elm_widget_video.h \
index 7abbce3..bfa72c7 100644 (file)
@@ -1,36 +1,9 @@
 #include <Elementary.h>
+//#include <ctype.h>
 #include "elm_priv.h"
-#include "elm_widget_layout.h"
-#include <ctype.h>
+#include "elm_widget_spinner.h"
 
-static const char SPINNER_SMART_NAME[] = "elm_spinner";
-
-typedef struct _Elm_Spinner_Smart_Data    Elm_Spinner_Smart_Data;
-typedef struct _Elm_Spinner_Special_Value Elm_Spinner_Special_Value;
-
-struct _Elm_Spinner_Smart_Data
-{
-   Elm_Layout_Smart_Data base;
-
-   Evas_Object          *ent;
-   const char           *label;
-   double                val, val_min, val_max, orig_val, step, val_base;
-   double                drag_start_pos, spin_speed, interval, first_interval;
-   int                   round;
-   Ecore_Timer          *delay, *spin;
-   Eina_List            *special_values;
-
-   Eina_Bool             entry_visible : 1;
-   Eina_Bool             dragging : 1;
-   Eina_Bool             editable : 1;
-   Eina_Bool             wrap : 1;
-};
-
-struct _Elm_Spinner_Special_Value
-{
-   double      value;
-   const char *label;
-};
+EAPI const char ELM_SPINNER_SMART_NAME[] = "elm_spinner";
 
 static const char SIG_CHANGED[] = "changed";
 static const char SIG_DELAY_CHANGED[] = "delay,changed";
@@ -40,39 +13,8 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = {
    {NULL, NULL}
 };
 
-#define ELM_SPINNER_SMART_DATA(_sd) \
-  ((Elm_Spinner_Smart_Data *)_sd)
-
-#define ELM_SPINNER_DATA_GET(o, sd) \
-  Elm_Spinner_Smart_Data * sd = evas_object_smart_data_get(o)
-
-#define ELM_SPINNER_DATA_GET_OR_RETURN(o, ptr)       \
-  ELM_SPINNER_DATA_GET(o, ptr);                      \
-  if (!ptr)                                          \
-    {                                                \
-       CRITICAL("No widget data for object %p (%s)", \
-                o, evas_object_type_get(o));         \
-       return;                                       \
-    }
-
-#define ELM_SPINNER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
-  ELM_SPINNER_DATA_GET(o, ptr);                         \
-  if (!ptr)                                             \
-    {                                                   \
-       CRITICAL("No widget data for object %p (%s)",    \
-                o, evas_object_type_get(o));            \
-       return val;                                      \
-    }
-
-#define ELM_SPINNER_CHECK(obj)                                  \
-  if (!obj || !elm_widget_type_check((obj), SPINNER_SMART_NAME, \
-                                     __func__))                 \
-    return
-
-/* Inheriting from elm_layout. Besides, we need no more than what is
- * there */
 EVAS_SMART_SUBCLASS_NEW
-  (SPINNER_SMART_NAME, _elm_spinner, Elm_Layout_Smart_Class,
+  (ELM_SPINNER_SMART_NAME, _elm_spinner, Elm_Spinner_Smart_Class,
   Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks);
 
 static void
@@ -596,7 +538,7 @@ _elm_spinner_smart_del(Evas_Object *obj)
 }
 
 static void
-_elm_spinner_smart_set_user(Elm_Layout_Smart_Class *sc)
+_elm_spinner_smart_set_user(Elm_Spinner_Smart_Class *sc)
 {
    ELM_WIDGET_CLASS(sc)->base.add = _elm_spinner_smart_add;
    ELM_WIDGET_CLASS(sc)->base.del = _elm_spinner_smart_del;
@@ -604,7 +546,24 @@ _elm_spinner_smart_set_user(Elm_Layout_Smart_Class *sc)
    ELM_WIDGET_CLASS(sc)->focus_next = NULL; /* not 'focus chain manager' */
    ELM_WIDGET_CLASS(sc)->event = _elm_spinner_smart_event;
 
-   sc->sizing_eval = _elm_spinner_smart_sizing_eval;
+   ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_spinner_smart_sizing_eval;
+}
+
+EAPI const Elm_Spinner_Smart_Class *
+elm_spinner_smart_class_get(void)
+{
+   static Elm_Spinner_Smart_Class _sc =
+     ELM_SPINNER_SMART_CLASS_INIT_NAME_VERSION(ELM_SPINNER_SMART_NAME);
+   static const Elm_Spinner_Smart_Class *class = NULL;
+   Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc;
+
+   if (class) return class;
+
+   _elm_spinner_smart_set(&_sc);
+   esc->callbacks = _smart_callbacks;
+   class = &_sc;
+
+   return class;
 }
 
 EAPI Evas_Object *
diff --git a/src/lib/elm_widget_spinner.h b/src/lib/elm_widget_spinner.h
new file mode 100644 (file)
index 0000000..5468916
--- /dev/null
@@ -0,0 +1,184 @@
+#ifndef ELM_WIDGET_SPINNER_H
+#define ELM_WIDGET_SPINNER_H
+
+#include "elm_widget_layout.h"
+
+#ifdef HAVE_EIO
+# include <Eio.h>
+#endif
+
+/**
+ * @addtogroup Widget
+ * @{
+ *
+ * @section elm-spinner-class The Elementary Spinner Class
+ *
+ * Elementary, besides having the @ref Spinner widget, exposes its
+ * foundation -- the Elementary Spinner Class -- in order to create other
+ * widgets which are a spinner with some more logic on top.
+ */
+
+/**
+ * @def ELM_SPINNER_CLASS
+ *
+ * Use this macro to cast whichever subclass of
+ * #Elm_Spinner_Smart_Class into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_CLASS(x) ((Elm_Spinner_Smart_Class *)x)
+
+/**
+ * @def ELM_SPINNER_DATA
+ *
+ * Use this macro to cast whichever subdata of
+ * #Elm_Spinner_Smart_Data into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_DATA(x)  ((Elm_Spinner_Smart_Data *)x)
+
+/**
+ * @def ELM_SPINNER_SMART_CLASS_VERSION
+ *
+ * Current version for Elementary spinner @b base smart class, a value
+ * which goes to _Elm_Spinner_Smart_Class::version.
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_SMART_CLASS_VERSION 1
+
+/**
+ * @def ELM_SPINNER_SMART_CLASS_INIT
+ *
+ * Initializer for a whole #Elm_Spinner_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_SPINNER_SMART_CLASS_INIT_NULL
+ * @see ELM_SPINNER_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_SMART_CLASS_INIT(smart_class_init) \
+  {smart_class_init, ELM_SPINNER_SMART_CLASS_VERSION}
+
+/**
+ * @def ELM_SPINNER_SMART_CLASS_INIT_NULL
+ *
+ * Initializer to zero out a whole #Elm_Spinner_Smart_Class structure.
+ *
+ * @see ELM_SPINNER_SMART_CLASS_INIT_NAME_VERSION
+ * @see ELM_SPINNER_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_SMART_CLASS_INIT_NULL \
+  ELM_SPINNER_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
+
+/**
+ * @def ELM_SPINNER_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * Initializer to zero out a whole #Elm_Spinner_Smart_Class structure and
+ * set its name and version.
+ *
+ * This is similar to #ELM_SPINNER_SMART_CLASS_INIT_NULL, but it will
+ * also set the version field of #Elm_Spinner_Smart_Class (base field)
+ * to the latest #ELM_SPINNER_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_SPINNER_SMART_CLASS_INIT_NULL
+ * @see ELM_SPINNER_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_SPINNER_SMART_CLASS_INIT_NAME_VERSION(name) \
+  ELM_SPINNER_SMART_CLASS_INIT                          \
+    (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
+
+/**
+ * Elementary spinner base smart class. This inherits directly from
+ * #Elm_Layout_Smart_Class and is meant to build widgets extending the
+ * behavior of a spinner.
+ *
+ * All of the functions listed on @ref Spinner namespace will work for
+ * objects deriving from #Elm_Spinner_Smart_Class.
+ */
+typedef struct _Elm_Spinner_Smart_Class
+{
+   Elm_Layout_Smart_Class base;
+
+   int                    version;    /**< Version of this smart class definition */
+} Elm_Spinner_Smart_Class;
+
+/**
+ * Base layout smart data extended with spinner instance data.
+ */
+typedef struct _Elm_Spinner_Smart_Data    Elm_Spinner_Smart_Data;
+struct _Elm_Spinner_Smart_Data
+{
+   Elm_Layout_Smart_Data base;
+
+   Evas_Object          *ent;
+   const char           *label;
+   double                val, val_min, val_max, orig_val, step, val_base;
+   double                drag_start_pos, spin_speed, interval, first_interval;
+   int                   round;
+   Ecore_Timer          *delay, *spin;
+   Eina_List            *special_values;
+
+   Eina_Bool             entry_visible : 1;
+   Eina_Bool             dragging : 1;
+   Eina_Bool             editable : 1;
+   Eina_Bool             wrap : 1;
+};
+
+typedef struct _Elm_Spinner_Special_Value Elm_Spinner_Special_Value;
+struct _Elm_Spinner_Special_Value
+{
+   double      value;
+   const char *label;
+};
+
+/**
+ * @}
+ */
+
+EAPI extern const char ELM_SPINNER_SMART_NAME[];
+EAPI const Elm_Spinner_Smart_Class *elm_spinner_smart_class_get(void);
+
+#define ELM_SPINNER_DATA_GET(o, sd) \
+  Elm_Spinner_Smart_Data * sd = evas_object_smart_data_get(o)
+
+#define ELM_SPINNER_DATA_GET_OR_RETURN(o, ptr)       \
+  ELM_SPINNER_DATA_GET(o, ptr);                      \
+  if (!ptr)                                          \
+    {                                                \
+       CRITICAL("No widget data for object %p (%s)", \
+                o, evas_object_type_get(o));         \
+       return;                                       \
+    }
+
+#define ELM_SPINNER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
+  ELM_SPINNER_DATA_GET(o, ptr);                         \
+  if (!ptr)                                             \
+    {                                                   \
+       CRITICAL("No widget data for object %p (%s)",    \
+                o, evas_object_type_get(o));            \
+       return val;                                      \
+    }
+
+#define ELM_SPINNER_CHECK(obj)                     \
+  if (!obj || !elm_widget_type_check               \
+        ((obj), ELM_SPINNER_SMART_NAME, __func__)) \
+    return
+
+#endif