diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index 8deb9f8c99..b242e8b144 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -56,6 +56,7 @@ elm_widget_grid.h \ elm_widget_hover.h \ elm_widget_icon.h \ elm_widget_image.h \ +elm_widget_inwin.h \ elm_widget_layout.h \ elm_widget_list.h \ elm_widget_map.h \ diff --git a/legacy/elementary/src/lib/elm_inwin.c b/legacy/elementary/src/lib/elm_inwin.c index fe363dccf8..36fd74cccf 100644 --- a/legacy/elementary/src/lib/elm_inwin.c +++ b/legacy/elementary/src/lib/elm_inwin.c @@ -1,38 +1,11 @@ #include #include "elm_priv.h" -#include "elm_widget_layout.h" +#include "elm_widget_inwin.h" -static const char INWIN_SMART_NAME[] = "elm_inwin"; +EAPI const char ELM_INWIN_SMART_NAME[] = "elm_inwin"; -#define ELM_INWIN_DATA_GET(o, sd) \ - Elm_Layout_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_INWIN_DATA_GET_OR_RETURN(o, ptr) \ - ELM_INWIN_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_INWIN_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_INWIN_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_INWIN_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), INWIN_SMART_NAME, __func__)) \ - return - -/* Inheriting from elm_layout. Besides, we need no more than what is - * there */ EVAS_SMART_SUBCLASS_NEW - (INWIN_SMART_NAME, _elm_inwin, Elm_Layout_Smart_Class, + (ELM_INWIN_SMART_NAME, _elm_inwin, Elm_Inwin_Smart_Class, Elm_Layout_Smart_Class, elm_layout_smart_class_get, NULL); static const Elm_Layout_Part_Alias_Description _content_aliases[] = @@ -84,7 +57,7 @@ _elm_inwin_smart_focus_next(const Evas_Object *obj, static void _elm_inwin_smart_add(Evas_Object *obj) { - EVAS_SMART_DATA_ALLOC(obj, Elm_Layout_Smart_Data); + EVAS_SMART_DATA_ALLOC(obj, Elm_Inwin_Smart_Data); ELM_WIDGET_CLASS(_elm_inwin_parent_sc)->base.add(obj); @@ -106,16 +79,32 @@ _elm_inwin_smart_parent_set(Evas_Object *obj, } static void -_elm_inwin_smart_set_user(Elm_Layout_Smart_Class *sc) +_elm_inwin_smart_set_user(Elm_Inwin_Smart_Class *sc) { ELM_WIDGET_CLASS(sc)->base.add = _elm_inwin_smart_add; ELM_WIDGET_CLASS(sc)->focus_next = _elm_inwin_smart_focus_next; ELM_WIDGET_CLASS(sc)->parent_set = _elm_inwin_smart_parent_set; - sc->sizing_eval = _elm_inwin_smart_sizing_eval; + ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_inwin_smart_sizing_eval; - sc->content_aliases = _content_aliases; + ELM_LAYOUT_CLASS(sc)->content_aliases = _content_aliases; +} + +EAPI const Elm_Inwin_Smart_Class * +elm_inwin_smart_class_get(void) +{ + static Elm_Inwin_Smart_Class _sc = + ELM_INWIN_SMART_CLASS_INIT_NAME_VERSION(ELM_INWIN_SMART_NAME); + static const Elm_Inwin_Smart_Class *class = NULL; + + if (class) + return class; + + _elm_inwin_smart_set(&_sc); + class = &_sc; + + return class; } EAPI Evas_Object * diff --git a/legacy/elementary/src/lib/elm_widget_inwin.h b/legacy/elementary/src/lib/elm_widget_inwin.h new file mode 100644 index 0000000000..05118c614d --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_inwin.h @@ -0,0 +1,160 @@ +#ifndef ELM_WIDGET_INWIN_H +#define ELM_WIDGET_INWIN_H + +#include "elm_widget_layout.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-inwin-class The Elementary Inwin Class + * + * Elementary, besides having the @ref Inwin widget, exposes its + * foundation -- the Elementary Inwin Class -- in order to create other + * widgets which are a inwin with some more logic on top. + */ + +/** + * @def ELM_INWIN_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Inwin_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_INWIN_CLASS(x) ((Elm_Inwin_Smart_Class *)x) + +/** + * @def ELM_INWIN_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Inwin_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_INWIN_DATA(x) ((Elm_Inwin_Smart_Data *)x) + +/** + * @def ELM_INWIN_SMART_CLASS_VERSION + * + * Current version for Elementary inwin @b base smart class, a value + * which goes to _Elm_Inwin_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_INWIN_SMART_CLASS_VERSION 1 + +/** + * @def ELM_INWIN_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Inwin_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_INWIN_SMART_CLASS_INIT_NULL + * @see ELM_INWIN_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_INWIN_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_INWIN_SMART_CLASS_VERSION} + +/** + * @def ELM_INWIN_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Inwin_Smart_Class structure. + * + * @see ELM_INWIN_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_INWIN_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_INWIN_SMART_CLASS_INIT_NULL \ + ELM_INWIN_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_INWIN_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Inwin_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_INWIN_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Inwin_Smart_Class (base field) + * to the latest #ELM_INWIN_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_INWIN_SMART_CLASS_INIT_NULL + * @see ELM_INWIN_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_INWIN_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_INWIN_SMART_CLASS_INIT \ + (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary inwin base smart class. This inherits directly from + * #Elm_Layout_Smart_Class and is meant to build widgets extending the + * behavior of a inwin. + * + * All of the functions listed on @ref Inwin namespace will work for + * objects deriving from #Elm_Inwin_Smart_Class. + */ +typedef struct _Elm_Inwin_Smart_Class +{ + Elm_Layout_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Inwin_Smart_Class; + +/** + * Base layout smart data extended with inwin instance data. + */ +typedef struct _Elm_Inwin_Smart_Data Elm_Inwin_Smart_Data; +struct _Elm_Inwin_Smart_Data +{ + Elm_Layout_Smart_Data base; +}; + +/** + * @} + */ + +EAPI extern const char ELM_INWIN_SMART_NAME[]; +EAPI const Elm_Inwin_Smart_Class *elm_inwin_smart_class_get(void); + +#define ELM_INWIN_DATA_GET(o, sd) \ + Elm_Inwin_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_INWIN_DATA_GET_OR_RETURN(o, ptr) \ + ELM_INWIN_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_INWIN_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_INWIN_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_INWIN_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_INWIN_SMART_NAME, \ + __func__)) \ + return + +#endif