From 052c2e1c21c3f1ee81fcd05597219035d7f059d2 Mon Sep 17 00:00:00 2001 From: Gustavo Lima Chaves Date: Mon, 30 Jul 2012 22:35:22 +0000 Subject: [PATCH] [elm] Making box inheritable. SVN revision: 74602 --- legacy/elementary/src/lib/Makefile.am | 1 + legacy/elementary/src/lib/elm_box.c | 107 +++-------- legacy/elementary/src/lib/elm_widget_box.h | 195 +++++++++++++++++++++ 3 files changed, 223 insertions(+), 80 deletions(-) create mode 100644 legacy/elementary/src/lib/elm_widget_box.h diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index a1e2fde358..65053534e5 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -43,6 +43,7 @@ includesdir = $(includedir)/elementary-@VMAJ@ includesunstable_HEADERS = \ elm_interface_scrollable.h \ elm_widget.h \ +elm_widget_box.h \ elm_widget_button.h \ elm_widget_container.h \ elm_widget_image.h \ diff --git a/legacy/elementary/src/lib/elm_box.c b/legacy/elementary/src/lib/elm_box.c index 524c73d684..ed3916c9e0 100644 --- a/legacy/elementary/src/lib/elm_box.c +++ b/legacy/elementary/src/lib/elm_box.c @@ -1,82 +1,12 @@ #include #include "elm_priv.h" #include "els_box.h" +#include "elm_widget_box.h" -static const char BOX_SMART_NAME[] = "elm_box"; - -typedef struct _Elm_Box_Smart_Data Elm_Box_Smart_Data; -typedef struct _Transition_Animation_Data Transition_Animation_Data; - -struct _Elm_Box_Smart_Data -{ - Elm_Widget_Smart_Data base; /* base widget smart data as - * first member obligatory, as - * we're inheriting from it */ - - Eina_Bool horizontal : 1; - Eina_Bool homogeneous : 1; - Eina_Bool recalc : 1; -}; - -struct _Elm_Box_Transition -{ - double initial_time; - double duration; - Ecore_Animator *animator; - - struct - { - Evas_Object_Box_Layout layout; - void *data; - void (*free_data)(void *data); - } start, end; - - void (*transition_end_cb)(void *data); - void *transition_end_data; - void (*transition_end_free_data)(void *data); - Eina_List *objs; - Evas_Object *box; - - Eina_Bool animation_ended : 1; - Eina_Bool recalculate : 1; -}; - -struct _Transition_Animation_Data -{ - Evas_Object *obj; - struct - { - Evas_Coord x, y, w, h; - } start, end; -}; - -#define ELM_BOX_DATA_GET(o, sd) \ - Elm_Box_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_BOX_DATA_GET_OR_RETURN(o, ptr) \ - ELM_BOX_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_BOX_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_BOX_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_BOX_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), BOX_SMART_NAME, __func__)) \ - return +EAPI const char ELM_BOX_SMART_NAME[] = "elm_box"; EVAS_SMART_SUBCLASS_NEW - (BOX_SMART_NAME, _elm_box, Elm_Widget_Smart_Class, + (ELM_BOX_SMART_NAME, _elm_box, Elm_Box_Smart_Class, Elm_Widget_Smart_Class, elm_widget_smart_class_get, NULL); static const char SIG_CHILD_ADDED[] = "child,added"; @@ -480,15 +410,32 @@ _elm_box_smart_del(Evas_Object *obj) } static void -_elm_box_smart_set_user(Elm_Widget_Smart_Class *sc) +_elm_box_smart_set_user(Elm_Box_Smart_Class *sc) { - sc->base.add = _elm_box_smart_add; - sc->base.del = _elm_box_smart_del; + ELM_WIDGET_CLASS(sc)->base.add = _elm_box_smart_add; + ELM_WIDGET_CLASS(sc)->base.del = _elm_box_smart_del; - sc->sub_object_del = _elm_box_smart_sub_object_del; - sc->theme = _elm_box_smart_theme; - sc->focus_next = _elm_box_smart_focus_next; - sc->focus_direction = _elm_box_smart_focus_direction; + ELM_WIDGET_CLASS(sc)->sub_object_del = _elm_box_smart_sub_object_del; + ELM_WIDGET_CLASS(sc)->theme = _elm_box_smart_theme; + ELM_WIDGET_CLASS(sc)->focus_next = _elm_box_smart_focus_next; + ELM_WIDGET_CLASS(sc)->focus_direction = _elm_box_smart_focus_direction; +} + +EAPI const Elm_Box_Smart_Class * +elm_box_smart_class_get(void) +{ + static Elm_Box_Smart_Class _sc = + ELM_BOX_SMART_CLASS_INIT_NAME_VERSION(ELM_BOX_SMART_NAME); + static const Elm_Box_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) return class; + + _elm_box_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; } EAPI Evas_Object * diff --git a/legacy/elementary/src/lib/elm_widget_box.h b/legacy/elementary/src/lib/elm_widget_box.h new file mode 100644 index 0000000000..f01c4b3bbc --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_box.h @@ -0,0 +1,195 @@ +#ifndef ELM_WIDGET_BOX_H +#define ELM_WIDGET_BOX_H + +/** + * @addtogroup Widget + * @{ + * + * @section elm-box-class The Elementary Box Class + * + * Elementary, besides having the @ref Box widget, exposes its + * foundation -- the Elementary Box Class -- in order to create + * other widgets which are a box with some more logic on top. + */ + +/** + * @def ELM_BOX_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Box_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_BOX_CLASS(x) ((Elm_Box_Smart_Class *) x) + +/** + * @def ELM_BOX_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Box_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_BOX_DATA(x) ((Elm_Box_Smart_Data *) x) + +/** + * @def ELM_BOX_SMART_CLASS_VERSION + * + * Current version for Elementary box @b base smart class, a value + * which goes to _Elm_Box_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_BOX_SMART_CLASS_VERSION 1 + +/** + * @def ELM_BOX_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Box_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_BOX_SMART_CLASS_INIT_NULL + * @see ELM_BOX_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_BOX_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_BOX_SMART_CLASS_VERSION} + +/** + * @def ELM_BOX_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Box_Smart_Class structure. + * + * @see ELM_BOX_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_BOX_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_BOX_SMART_CLASS_INIT_NULL \ + ELM_BOX_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_BOX_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Box_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_BOX_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Box_Smart_Class (base field) + * to the latest #ELM_BOX_SMART_CLASS_VERSION and name it to the + * specific value. + * + * It will keep a reference to the name field as a "const char *", + * i.e., the name must be available while the structure is + * used (hint: static or global variable!) and must not be modified. + * + * @see ELM_BOX_SMART_CLASS_INIT_NULL + * @see ELM_BOX_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_BOX_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_BOX_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary box base smart class. This inherits directly from + * #Elm_Widget_Smart_Class and is meant to build widgets extending the + * behavior of a box. + * + * All of the functions listed on @ref Box namespace will work for + * objects deriving from #Elm_Box_Smart_Class. + */ +typedef struct _Elm_Box_Smart_Class +{ + Elm_Widget_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Box_Smart_Class; + +/** + * Base widget smart data extended with box instance data. + */ +typedef struct _Elm_Box_Smart_Data Elm_Box_Smart_Data; +struct _Elm_Box_Smart_Data +{ + Elm_Widget_Smart_Data base; /* base widget smart data as + * first member obligatory, as + * we're inheriting from it */ + + Eina_Bool horizontal : 1; + Eina_Bool homogeneous : 1; + Eina_Bool recalc : 1; +}; + +struct _Elm_Box_Transition +{ + double initial_time; + double duration; + Ecore_Animator *animator; + + struct + { + Evas_Object_Box_Layout layout; + void *data; + void (*free_data)(void *data); + } start, end; + + void (*transition_end_cb)(void *data); + void *transition_end_data; + void (*transition_end_free_data)(void *data); + Eina_List *objs; + Evas_Object *box; + + Eina_Bool animation_ended : 1; + Eina_Bool recalculate : 1; +}; + +typedef struct _Transition_Animation_Data Transition_Animation_Data; +struct _Transition_Animation_Data +{ + Evas_Object *obj; + struct + { + Evas_Coord x, y, w, h; + } start, end; +}; + +/** + * @} + */ + +EAPI extern const char ELM_BOX_SMART_NAME[]; +EAPI const Elm_Box_Smart_Class *elm_box_smart_class_get(void); + +#define ELM_BOX_DATA_GET(o, sd) \ + Elm_Box_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_BOX_DATA_GET_OR_RETURN(o, ptr) \ + ELM_BOX_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_BOX_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_BOX_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_BOX_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_BOX_SMART_NAME, __func__)) \ + return + +#endif