diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index 6c0d8316df..350d0a8372 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -50,6 +50,7 @@ elm_widget_calendar.h \ elm_widget_conform.h \ elm_widget_container.h \ elm_widget_diskselector.h \ +elm_widget_frame.h \ elm_widget_gengrid.h \ elm_widget_genlist.h \ elm_widget_glview.h \ diff --git a/legacy/elementary/src/lib/elm_frame.c b/legacy/elementary/src/lib/elm_frame.c index e4d78cbd24..982ca60d8e 100644 --- a/legacy/elementary/src/lib/elm_frame.c +++ b/legacy/elementary/src/lib/elm_frame.c @@ -1,19 +1,8 @@ #include #include "elm_priv.h" -#include "elm_widget_layout.h" +#include "elm_widget_frame.h" -static const char FRAME_SMART_NAME[] = "elm_frame"; - -typedef struct _Elm_Frame_Smart_Data Elm_Frame_Smart_Data; - -struct _Elm_Frame_Smart_Data -{ - Elm_Layout_Smart_Data base; - - Eina_Bool collapsed : 1; - Eina_Bool collapsible : 1; - Eina_Bool anim : 1; -}; +EAPI const char ELM_FRAME_SMART_NAME[] = "elm_frame"; static const char SIG_CLICKED[] = "clicked"; @@ -21,32 +10,6 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = { {SIG_CLICKED, ""}, {NULL, NULL} }; - -#define ELM_FRAME_DATA_GET(o, sd) \ - Elm_Frame_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_FRAME_DATA_GET_OR_RETURN(o, ptr) \ - ELM_FRAME_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_FRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_FRAME_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_FRAME_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), FRAME_SMART_NAME, __func__)) \ - return - static const Elm_Layout_Part_Alias_Description _content_aliases[] = { {"default", "elm.swallow.content"}, @@ -62,7 +25,7 @@ static const Elm_Layout_Part_Alias_Description _text_aliases[] = /* Inheriting from elm_layout. Besides, we need no more than what is * there */ EVAS_SMART_SUBCLASS_NEW - (FRAME_SMART_NAME, _elm_frame, Elm_Layout_Smart_Class, + (ELM_FRAME_SMART_NAME, _elm_frame, Elm_Frame_Smart_Class, Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks); static void @@ -193,7 +156,7 @@ _elm_frame_smart_add(Evas_Object *obj) } static void -_elm_frame_smart_set_user(Elm_Layout_Smart_Class *sc) +_elm_frame_smart_set_user(Elm_Frame_Smart_Class *sc) { ELM_WIDGET_CLASS(sc)->base.add = _elm_frame_smart_add; ELM_WIDGET_CLASS(sc)->base.calculate = _elm_frame_smart_calculate; @@ -201,8 +164,26 @@ _elm_frame_smart_set_user(Elm_Layout_Smart_Class *sc) ELM_WIDGET_CLASS(sc)->focus_next = _elm_frame_smart_focus_next; ELM_WIDGET_CLASS(sc)->focus_direction = _elm_frame_smart_focus_direction; - sc->content_aliases = _content_aliases; - sc->text_aliases = _text_aliases; + ELM_LAYOUT_CLASS(sc)->content_aliases = _content_aliases; + ELM_LAYOUT_CLASS(sc)->text_aliases = _text_aliases; +} + +EAPI const Elm_Frame_Smart_Class * +elm_frame_smart_class_get(void) +{ + static Elm_Frame_Smart_Class _sc = + ELM_FRAME_SMART_CLASS_INIT_NAME_VERSION(ELM_FRAME_SMART_NAME); + static const Elm_Frame_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) + return class; + + _elm_frame_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; } EAPI Evas_Object * diff --git a/legacy/elementary/src/lib/elm_widget_frame.h b/legacy/elementary/src/lib/elm_widget_frame.h new file mode 100644 index 0000000000..b0c7eb56cd --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_frame.h @@ -0,0 +1,164 @@ +#ifndef ELM_WIDGET_FRAME_H +#define ELM_WIDGET_FRAME_H + +#include "elm_widget_layout.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-frame-class The Elementary Frame Class + * + * Elementary, besides having the @ref Frame widget, exposes its + * foundation -- the Elementary Frame Class -- in order to create other + * widgets which are a frame with some more logic on top. + */ + +/** + * @def ELM_FRAME_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Frame_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_FRAME_CLASS(x) ((Elm_Frame_Smart_Class *)x) + +/** + * @def ELM_FRAME_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Frame_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_FRAME_DATA(x) ((Elm_Frame_Smart_Data *)x) + +/** + * @def ELM_FRAME_SMART_CLASS_VERSION + * + * Current version for Elementary frame @b base smart class, a value + * which goes to _Elm_Frame_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_FRAME_SMART_CLASS_VERSION 1 + +/** + * @def ELM_FRAME_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Frame_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_FRAME_SMART_CLASS_INIT_NULL + * @see ELM_FRAME_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_FRAME_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_FRAME_SMART_CLASS_VERSION} + +/** + * @def ELM_FRAME_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Frame_Smart_Class structure. + * + * @see ELM_FRAME_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_FRAME_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_FRAME_SMART_CLASS_INIT_NULL \ + ELM_FRAME_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_FRAME_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Frame_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_FRAME_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Frame_Smart_Class (base field) + * to the latest #ELM_FRAME_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_FRAME_SMART_CLASS_INIT_NULL + * @see ELM_FRAME_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_FRAME_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_FRAME_SMART_CLASS_INIT \ + (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary frame base smart class. This inherits directly from + * #Elm_Layout_Smart_Class and is meant to build widgets extending the + * behavior of a frame. + * + * All of the functions listed on @ref Frame namespace will work for + * objects deriving from #Elm_Frame_Smart_Class. + */ +typedef struct _Elm_Frame_Smart_Class +{ + Elm_Layout_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Frame_Smart_Class; + +/** + * Base layout smart data extended with frame instance data. + */ +typedef struct _Elm_Frame_Smart_Data Elm_Frame_Smart_Data; +struct _Elm_Frame_Smart_Data +{ + Elm_Layout_Smart_Data base; + + Eina_Bool collapsed : 1; + Eina_Bool collapsible : 1; + Eina_Bool anim : 1; +}; + +/** + * @} + */ + +EAPI extern const char ELM_FRAME_SMART_NAME[]; +EAPI const Elm_Frame_Smart_Class *elm_frame_smart_class_get(void); + +#define ELM_FRAME_DATA_GET(o, sd) \ + Elm_Frame_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_FRAME_DATA_GET_OR_RETURN(o, ptr) \ + ELM_FRAME_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_FRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_FRAME_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_FRAME_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_FRAME_SMART_NAME, \ + __func__)) \ + return + +#endif