diff --git a/legacy/elementary/src/lib/elm_notify.c b/legacy/elementary/src/lib/elm_notify.c index 27f0f9273a..7caabe6b5a 100644 --- a/legacy/elementary/src/lib/elm_notify.c +++ b/legacy/elementary/src/lib/elm_notify.c @@ -1,25 +1,8 @@ #include #include "elm_priv.h" -#include "elm_widget_container.h" +#include "elm_widget_notify.h" -static const char NOTIFY_SMART_NAME[] = "elm_notify"; - -typedef struct _Elm_Notify_Smart_Data Elm_Notify_Smart_Data; - -struct _Elm_Notify_Smart_Data -{ - Elm_Widget_Smart_Data base; - - Evas_Object *notify, *content, *parent; - Evas_Object *block_events; - - Elm_Notify_Orient orient; - - double timeout; - Ecore_Timer *timer; - - Eina_Bool allow_events : 1; -}; +EAPI const char ELM_NOTIFY_SMART_NAME[] = "elm_notify"; static const char SIG_BLOCK_CLICKED[] = "block,clicked"; static const char SIG_TIMEOUT[] = "timeout"; @@ -29,33 +12,8 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = { {NULL, NULL} }; -#define ELM_NOTIFY_DATA_GET(o, sd) \ - Elm_Notify_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_NOTIFY_DATA_GET_OR_RETURN(o, ptr) \ - ELM_NOTIFY_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_NOTIFY_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_NOTIFY_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_NOTIFY_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), NOTIFY_SMART_NAME, __func__)) \ - return - EVAS_SMART_SUBCLASS_NEW - (NOTIFY_SMART_NAME, _elm_notify, Elm_Container_Smart_Class, + (ELM_NOTIFY_SMART_NAME, _elm_notify, Elm_Notify_Smart_Class, Elm_Container_Smart_Class, elm_container_smart_class_get, NULL); /** @@ -609,7 +567,7 @@ _elm_notify_smart_parent_set(Evas_Object *obj, } static void -_elm_notify_smart_set_user(Elm_Container_Smart_Class *sc) +_elm_notify_smart_set_user(Elm_Notify_Smart_Class *sc) { ELM_WIDGET_CLASS(sc)->base.add = _elm_notify_smart_add; ELM_WIDGET_CLASS(sc)->base.del = _elm_notify_smart_del; @@ -631,6 +589,23 @@ _elm_notify_smart_set_user(Elm_Container_Smart_Class *sc) ELM_CONTAINER_CLASS(sc)->content_unset = _elm_notify_smart_content_unset; } +EAPI const Elm_Notify_Smart_Class * +elm_notify_smart_class_get(void) +{ + static Elm_Notify_Smart_Class _sc = + ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION(ELM_NOTIFY_SMART_NAME); + static const Elm_Notify_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) return class; + + _elm_notify_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; +} + EAPI Evas_Object * elm_notify_add(Evas_Object *parent) { diff --git a/legacy/elementary/src/lib/elm_widget_notify.h b/legacy/elementary/src/lib/elm_widget_notify.h new file mode 100644 index 0000000000..7fc3dc710e --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_notify.h @@ -0,0 +1,168 @@ +#ifndef ELM_WIDGET_NOTIFY_H +#define ELM_WIDGET_NOTIFY_H + +#include "elm_widget_container.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-notify-class The Elementary Notify Class + * + * Elementary, besides having the @ref Notify widget, exposes its + * foundation -- the Elementary Notify Class -- in order to create other + * widgets which are a notify with some more logic on top. + */ + +/** + * @def ELM_NOTIFY_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Notify_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_NOTIFY_CLASS(x) ((Elm_Notify_Smart_Class *)x) + +/** + * @def ELM_NOTIFY_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Notify_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_NOTIFY_DATA(x) ((Elm_Notify_Smart_Data *)x) + +/** + * @def ELM_NOTIFY_SMART_CLASS_VERSION + * + * Current version for Elementary notify @b base smart class, a value + * which goes to _Elm_Notify_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_NOTIFY_SMART_CLASS_VERSION 1 + +/** + * @def ELM_NOTIFY_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Notify_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_NOTIFY_SMART_CLASS_INIT_NULL + * @see ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_NOTIFY_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_NOTIFY_SMART_CLASS_VERSION} + +/** + * @def ELM_NOTIFY_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Notify_Smart_Class structure. + * + * @see ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_NOTIFY_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_NOTIFY_SMART_CLASS_INIT_NULL \ + ELM_NOTIFY_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Notify_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_NOTIFY_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Notify_Smart_Class (base field) + * to the latest #ELM_NOTIFY_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_NOTIFY_SMART_CLASS_INIT_NULL + * @see ELM_NOTIFY_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_NOTIFY_SMART_CLASS_INIT(ELM_CONTAINER_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary notify base smart class. This inherits directly from + * #Elm_Container_Smart_Class and is meant to build widgets extending the + * behavior of a notify. + * + * All of the functions listed on @ref Notify namespace will work for + * objects deriving from #Elm_Notify_Smart_Class. + */ +typedef struct _Elm_Notify_Smart_Class +{ + Elm_Container_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Notify_Smart_Class; + +/** + * Base widget smart data extended with notify instance data. + */ +typedef struct _Elm_Notify_Smart_Data Elm_Notify_Smart_Data; +struct _Elm_Notify_Smart_Data +{ + Elm_Container_Smart_Data base; + + Evas_Object *notify, *content, *parent; + Evas_Object *block_events; + + Elm_Notify_Orient orient; + + double timeout; + Ecore_Timer *timer; + + Eina_Bool allow_events : 1; +}; + +/** + * @} + */ + +EAPI extern const char ELM_NOTIFY_SMART_NAME[]; +EAPI const Elm_Notify_Smart_Class *elm_notify_smart_class_get(void); + +#define ELM_NOTIFY_DATA_GET(o, sd) \ + Elm_Notify_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_NOTIFY_DATA_GET_OR_RETURN(o, ptr) \ + ELM_NOTIFY_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_NOTIFY_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_NOTIFY_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_NOTIFY_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_NOTIFY_SMART_NAME, __func__)) \ + return + +#endif