diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index 44d7f7c7a8..a1e2fde358 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -46,7 +46,8 @@ elm_widget.h \ elm_widget_button.h \ elm_widget_container.h \ elm_widget_image.h \ -elm_widget_layout.h +elm_widget_layout.h \ +elm_widget_photo.h includesunstabledir = $(includedir)/elementary-@VMAJ@ includesub_HEADERS = \ diff --git a/legacy/elementary/src/lib/elm_photo.c b/legacy/elementary/src/lib/elm_photo.c index c0313bc90b..9b43517c9b 100644 --- a/legacy/elementary/src/lib/elm_photo.c +++ b/legacy/elementary/src/lib/elm_photo.c @@ -1,55 +1,8 @@ #include #include "elm_priv.h" +#include "elm_widget_photo.h" -static const char PHOTO_SMART_NAME[] = "elm_photo"; - -typedef struct _Elm_Photo_Smart_Data Elm_Photo_Smart_Data; - -struct _Elm_Photo_Smart_Data -{ - Elm_Widget_Smart_Data base; - - Evas_Object *icon; - int size; - Eina_Bool fill_inside; - Ecore_Timer *long_press_timer; - -#ifdef HAVE_ELEMENTARY_ETHUMB - struct - { - struct - { - const char *path; - const char *key; - } file, thumb; - } thumb; -#endif -}; - -#define ELM_PHOTO_DATA_GET(o, sd) \ - Elm_Photo_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_PHOTO_DATA_GET_OR_RETURN(o, ptr) \ - ELM_PHOTO_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_PHOTO_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_PHOTO_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_PHOTO_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), PHOTO_SMART_NAME, __func__)) \ - return +EAPI const char ELM_PHOTO_SMART_NAME[] = "elm_photo"; static const char SIG_CLICKED[] = "clicked"; static const char SIG_DRAG_START[] = "drag,start"; @@ -62,7 +15,7 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = { }; EVAS_SMART_SUBCLASS_NEW - (PHOTO_SMART_NAME, _elm_photo, Elm_Widget_Smart_Class, + (ELM_PHOTO_SMART_NAME, _elm_photo, Elm_Photo_Smart_Class, Elm_Widget_Smart_Class, elm_widget_smart_class_get, _smart_callbacks); static void @@ -338,7 +291,7 @@ _elm_photo_smart_del(Evas_Object *obj) } static void -_elm_photo_smart_set_user(Elm_Widget_Smart_Class *sc) +_elm_photo_smart_set_user(Elm_Photo_Smart_Class *sc) { ELM_WIDGET_CLASS(sc)->base.add = _elm_photo_smart_add; ELM_WIDGET_CLASS(sc)->base.del = _elm_photo_smart_del; @@ -346,6 +299,23 @@ _elm_photo_smart_set_user(Elm_Widget_Smart_Class *sc) ELM_WIDGET_CLASS(sc)->theme = _elm_photo_smart_theme; } +EAPI const Elm_Photo_Smart_Class * +elm_photo_smart_class_get(void) +{ + static Elm_Photo_Smart_Class _sc = + ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION(ELM_PHOTO_SMART_NAME); + static const Elm_Photo_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) return class; + + _elm_photo_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; +} + EAPI Evas_Object * elm_photo_add(Evas_Object *parent) { diff --git a/legacy/elementary/src/lib/elm_widget_photo.h b/legacy/elementary/src/lib/elm_widget_photo.h new file mode 100644 index 0000000000..217fe31c98 --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_photo.h @@ -0,0 +1,175 @@ +#ifndef ELM_WIDGET_PHOTO_H +#define ELM_WIDGET_PHOTO_H + +#include "elm_widget_layout.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-photo-class The Elementary Photo Class + * + * Elementary, besides having the @ref Photo widget, exposes its + * foundation -- the Elementary Photo Class -- in order to create + * other widgets which are a photo with some more logic on top. + */ + +/** + * @def ELM_PHOTO_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Photo_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PHOTO_CLASS(x) ((Elm_Photo_Smart_Class *) x) + +/** + * @def ELM_PHOTO_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Photo_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PHOTO_DATA(x) ((Elm_Photo_Smart_Data *) x) + +/** + * @def ELM_PHOTO_SMART_CLASS_VERSION + * + * Current version for Elementary photo @b base smart class, a value + * which goes to _Elm_Photo_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_PHOTO_SMART_CLASS_VERSION 1 + +/** + * @def ELM_PHOTO_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Photo_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_PHOTO_SMART_CLASS_INIT_NULL + * @see ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_PHOTO_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_PHOTO_SMART_CLASS_VERSION} + +/** + * @def ELM_PHOTO_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Photo_Smart_Class structure. + * + * @see ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PHOTO_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PHOTO_SMART_CLASS_INIT_NULL \ + ELM_PHOTO_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Photo_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_PHOTO_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Photo_Smart_Class (base field) + * to the latest #ELM_PHOTO_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_PHOTO_SMART_CLASS_INIT_NULL + * @see ELM_PHOTO_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_PHOTO_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary photo base smart class. This inherits directly from + * #Elm_Widget_Smart_Class and is meant to build widgets extending the + * behavior of a photo. + * + * All of the functions listed on @ref Photo namespace will work for + * objects deriving from #Elm_Photo_Smart_Class. + */ +typedef struct _Elm_Photo_Smart_Class +{ + Elm_Widget_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Photo_Smart_Class; + +/** + * Base widget smart data extended with photo instance data. + */ +typedef struct _Elm_Photo_Smart_Data Elm_Photo_Smart_Data; + +struct _Elm_Photo_Smart_Data +{ + Elm_Widget_Smart_Data base; + + Evas_Object *icon; + int size; + Eina_Bool fill_inside; + Ecore_Timer *long_press_timer; + +#ifdef HAVE_ELEMENTARY_ETHUMB + struct + { + struct + { + const char *path; + const char *key; + } file, thumb; + } thumb; +#endif +}; + +/** + * @} + */ + +EAPI extern const char ELM_PHOTO_SMART_NAME[]; +EAPI const Elm_Photo_Smart_Class *elm_photo_smart_class_get(void); + +#define ELM_PHOTO_DATA_GET(o, sd) \ + Elm_Photo_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_PHOTO_DATA_GET_OR_RETURN(o, ptr) \ + ELM_PHOTO_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_PHOTO_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_PHOTO_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_PHOTO_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_PHOTO_SMART_NAME, __func__)) \ + return + +#endif