[elm] Naviframe now inheritable.
authorGustavo Lima Chaves <glima@profusion.mobi>
Tue, 31 Jul 2012 22:06:26 +0000 (22:06 +0000)
committerGustavo Lima Chaves <glima@profusion.mobi>
Tue, 31 Jul 2012 22:06:26 +0000 (22:06 +0000)
SVN revision: 74686

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

index 7da0125..17d4760 100644 (file)
@@ -58,6 +58,7 @@ elm_widget_image.h \
 elm_widget_layout.h \
 elm_widget_map.h \
 elm_widget_menu.h \
+elm_widget_naviframe.h \
 elm_widget_notify.h \
 elm_widget_photo.h \
 elm_widget_photocam.h \
index bdfa0b4..cbc9d7f 100644 (file)
@@ -1,45 +1,8 @@
 #include <Elementary.h>
 #include "elm_priv.h"
-#include "elm_widget_layout.h"
+#include "elm_widget_naviframe.h"
 
-static const char NAVIFRAME_SMART_NAME[] = "elm_naviframe";
-
-typedef struct _Elm_Naviframe_Smart_Data Elm_Naviframe_Smart_Data;
-typedef struct _Elm_Naviframe_Item       Elm_Naviframe_Item;
-
-struct _Elm_Naviframe_Smart_Data
-{
-   Elm_Layout_Smart_Data base;
-
-   Eina_Inlist          *stack; /* top item is the list's LAST item */
-   Evas_Object          *dummy_edje;
-
-   Eina_Bool             preserve : 1;
-   Eina_Bool             on_deletion : 1;
-   Eina_Bool             auto_pushed : 1;
-   Eina_Bool             freeze_events : 1;
-};
-
-struct _Elm_Naviframe_Item
-{
-   ELM_WIDGET_ITEM;
-   EINA_INLIST;
-
-   Evas_Object *content;
-   Evas_Object *title_prev_btn;
-   Evas_Object *title_next_btn;
-   Evas_Object *title_icon;
-   Evas_Object *title;
-   Evas_Object *subtitle;
-   const char  *style;
-   const char  *title_label;
-
-   Evas_Coord   minw;
-   Evas_Coord   minh;
-
-   Eina_Bool    title_visible : 1;
-   Eina_Bool    content_unfocusable : 1;
-};
+EAPI const char ELM_NAVIFRAME_SMART_NAME[] = "elm_naviframe";
 
 static const char CONTENT_PART[] = "elm.swallow.content";
 static const char PREV_BTN_PART[] = "elm.swallow.prev_btn";
@@ -54,44 +17,8 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = {
    {NULL, NULL}
 };
 
-#define ELM_NAVIFRAME_DATA_GET(o, sd) \
-  Elm_Naviframe_Smart_Data * sd = evas_object_smart_data_get(o)
-
-#define ELM_NAVIFRAME_DATA_GET_OR_RETURN(o, ptr)     \
-  ELM_NAVIFRAME_DATA_GET(o, ptr);                    \
-  if (!ptr)                                          \
-    {                                                \
-       CRITICAL("No widget data for object %p (%s)", \
-                o, evas_object_type_get(o));         \
-       return;                                       \
-    }
-
-#define ELM_NAVIFRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
-  ELM_NAVIFRAME_DATA_GET(o, ptr);                         \
-  if (!ptr)                                               \
-    {                                                     \
-       CRITICAL("No widget data for object %p (%s)",      \
-                o, evas_object_type_get(o));              \
-       return val;                                        \
-    }
-
-#define ELM_NAVIFRAME_CHECK(obj)                                  \
-  if (!obj || !elm_widget_type_check((obj), NAVIFRAME_SMART_NAME, \
-                                     __func__))                   \
-    return
-
-#define ELM_NAVIFRAME_ITEM_CHECK(it)                        \
-  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
-  ELM_NAVIFRAME_CHECK(it->base.widget);
-
-#define ELM_NAVIFRAME_ITEM_CHECK_OR_RETURN(it, ...)                    \
-  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
-  ELM_NAVIFRAME_CHECK(it->base.widget) __VA_ARGS__;
-
-/* Inheriting from elm_layout. Besides, we need no more than what is
- * there */
 EVAS_SMART_SUBCLASS_NEW
-  (NAVIFRAME_SMART_NAME, _elm_naviframe, Elm_Layout_Smart_Class,
+  (ELM_NAVIFRAME_SMART_NAME, _elm_naviframe, Elm_Naviframe_Smart_Class,
   Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks);
 
 static void
@@ -1004,7 +931,7 @@ _elm_naviframe_smart_del(Evas_Object *obj)
 }
 
 static void
-_elm_naviframe_smart_set_user(Elm_Layout_Smart_Class *sc)
+_elm_naviframe_smart_set_user(Elm_Naviframe_Smart_Class *sc)
 {
    ELM_WIDGET_CLASS(sc)->base.add = _elm_naviframe_smart_add;
    ELM_WIDGET_CLASS(sc)->base.del = _elm_naviframe_smart_del;
@@ -1022,6 +949,25 @@ _elm_naviframe_smart_set_user(Elm_Layout_Smart_Class *sc)
    ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_naviframe_smart_sizing_eval;
 }
 
+EAPI const Elm_Naviframe_Smart_Class *
+elm_naviframe_smart_class_get(void)
+{
+   static Elm_Naviframe_Smart_Class _sc =
+     ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
+       (ELM_NAVIFRAME_SMART_NAME);
+   static const Elm_Naviframe_Smart_Class *class = NULL;
+   Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc;
+
+   if (class)
+     return class;
+
+   _elm_naviframe_smart_set(&_sc);
+   esc->callbacks = _smart_callbacks;
+   class = &_sc;
+
+   return class;
+}
+
 EAPI Evas_Object *
 elm_naviframe_add(Evas_Object *parent)
 {
diff --git a/src/lib/elm_widget_naviframe.h b/src/lib/elm_widget_naviframe.h
new file mode 100644 (file)
index 0000000..e708204
--- /dev/null
@@ -0,0 +1,198 @@
+#ifndef ELM_WIDGET_NAVIFRAME_H
+#define ELM_WIDGET_NAVIFRAME_H
+
+#include "elm_widget_layout.h"
+
+/**
+ * @addtogroup Widget
+ * @{
+ *
+ * @section elm-naviframe-class The Elementary Naviframe Class
+ *
+ * Elementary, besides having the @ref Naviframe widget, exposes its
+ * foundation -- the Elementary Naviframe Class -- in order to create other
+ * widgets which are a naviframe with some more logic on top.
+ */
+
+/**
+ * @def ELM_NAVIFRAME_CLASS
+ *
+ * Use this macro to cast whichever subclass of
+ * #Elm_Naviframe_Smart_Class into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_CLASS(x) ((Elm_Naviframe_Smart_Class *)x)
+
+/**
+ * @def ELM_NAVIFRAME_DATA
+ *
+ * Use this macro to cast whichever subdata of
+ * #Elm_Naviframe_Smart_Data into it, so to access its fields.
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_DATA(x)  ((Elm_Naviframe_Smart_Data *)x)
+
+/**
+ * @def ELM_NAVIFRAME_SMART_CLASS_VERSION
+ *
+ * Current version for Elementary naviframe @b base smart class, a value
+ * which goes to _Elm_Naviframe_Smart_Class::version.
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_SMART_CLASS_VERSION 1
+
+/**
+ * @def ELM_NAVIFRAME_SMART_CLASS_INIT
+ *
+ * Initializer for a whole #Elm_Naviframe_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_NAVIFRAME_SMART_CLASS_INIT_NULL
+ * @see ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_SMART_CLASS_INIT(smart_class_init) \
+  {smart_class_init, ELM_NAVIFRAME_SMART_CLASS_VERSION}
+
+/**
+ * @def ELM_NAVIFRAME_SMART_CLASS_INIT_NULL
+ *
+ * Initializer to zero out a whole #Elm_Naviframe_Smart_Class structure.
+ *
+ * @see ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
+ * @see ELM_NAVIFRAME_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_SMART_CLASS_INIT_NULL \
+  ELM_NAVIFRAME_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
+
+/**
+ * @def ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
+ *
+ * Initializer to zero out a whole #Elm_Naviframe_Smart_Class structure and
+ * set its name and version.
+ *
+ * This is similar to #ELM_NAVIFRAME_SMART_CLASS_INIT_NULL, but it will
+ * also set the version field of #Elm_Naviframe_Smart_Class (base field)
+ * to the latest #ELM_NAVIFRAME_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_NAVIFRAME_SMART_CLASS_INIT_NULL
+ * @see ELM_NAVIFRAME_SMART_CLASS_INIT
+ *
+ * @ingroup Widget
+ */
+#define ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION(name) \
+  ELM_NAVIFRAME_SMART_CLASS_INIT                          \
+    (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
+
+/**
+ * Elementary naviframe base smart class. This inherits directly from
+ * #Elm_Layout_Smart_Class and is meant to build widgets extending the
+ * behavior of a naviframe.
+ *
+ * All of the functions listed on @ref Naviframe namespace will work for
+ * objects deriving from #Elm_Naviframe_Smart_Class.
+ */
+typedef struct _Elm_Naviframe_Smart_Class
+{
+   Elm_Layout_Smart_Class base;
+
+   int                    version;    /**< Version of this smart class definition */
+} Elm_Naviframe_Smart_Class;
+
+/**
+ * Base layout smart data extended with naviframe instance data.
+ */
+typedef struct _Elm_Naviframe_Smart_Data Elm_Naviframe_Smart_Data;
+struct _Elm_Naviframe_Smart_Data
+{
+   Elm_Layout_Smart_Data base;
+
+   Eina_Inlist          *stack; /* top item is the list's LAST item */
+   Evas_Object          *dummy_edje;
+
+   Eina_Bool             preserve : 1;
+   Eina_Bool             on_deletion : 1;
+   Eina_Bool             auto_pushed : 1;
+   Eina_Bool             freeze_events : 1;
+};
+
+typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
+struct _Elm_Naviframe_Item
+{
+   ELM_WIDGET_ITEM;
+   EINA_INLIST;
+
+   Evas_Object *content;
+   Evas_Object *title_prev_btn;
+   Evas_Object *title_next_btn;
+   Evas_Object *title_icon;
+   Evas_Object *title;
+   Evas_Object *subtitle;
+   const char  *style;
+   const char  *title_label;
+
+   Evas_Coord   minw;
+   Evas_Coord   minh;
+
+   Eina_Bool    title_visible : 1;
+   Eina_Bool    content_unfocusable : 1;
+};
+
+/**
+ * @}
+ */
+
+EAPI extern const char ELM_NAVIFRAME_SMART_NAME[];
+EAPI const Elm_Naviframe_Smart_Class *elm_naviframe_smart_class_get(void);
+
+#define ELM_NAVIFRAME_DATA_GET(o, sd) \
+  Elm_Naviframe_Smart_Data * sd = evas_object_smart_data_get(o)
+
+#define ELM_NAVIFRAME_DATA_GET_OR_RETURN(o, ptr)     \
+  ELM_NAVIFRAME_DATA_GET(o, ptr);                    \
+  if (!ptr)                                          \
+    {                                                \
+       CRITICAL("No widget data for object %p (%s)", \
+                o, evas_object_type_get(o));         \
+       return;                                       \
+    }
+
+#define ELM_NAVIFRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
+  ELM_NAVIFRAME_DATA_GET(o, ptr);                         \
+  if (!ptr)                                               \
+    {                                                     \
+       CRITICAL("No widget data for object %p (%s)",      \
+                o, evas_object_type_get(o));              \
+       return val;                                        \
+    }
+
+#define ELM_NAVIFRAME_CHECK(obj)                                      \
+  if (!obj || !elm_widget_type_check((obj), ELM_NAVIFRAME_SMART_NAME, \
+                                     __func__))                       \
+    return
+
+#define ELM_NAVIFRAME_ITEM_CHECK(it)                        \
+  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
+  ELM_NAVIFRAME_CHECK(it->base.widget);
+
+#define ELM_NAVIFRAME_ITEM_CHECK_OR_RETURN(it, ...)                    \
+  ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
+  ELM_NAVIFRAME_CHECK(it->base.widget) __VA_ARGS__;
+
+#endif