diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index 9043608256..fd74eb6732 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -64,6 +64,7 @@ elm_widget_notify.h \ elm_widget_photo.h \ elm_widget_photocam.h \ elm_widget_plug.h \ +elm_widget_progressbar.h \ elm_widget_route.h \ elm_widget_scroller.h \ elm_widget_slider.h \ diff --git a/legacy/elementary/src/lib/elm_progressbar.c b/legacy/elementary/src/lib/elm_progressbar.c index 0497b46cb9..9a9f3701a9 100644 --- a/legacy/elementary/src/lib/elm_progressbar.c +++ b/legacy/elementary/src/lib/elm_progressbar.c @@ -1,61 +1,14 @@ #include #include "elm_priv.h" -#include "elm_widget_layout.h" +#include "elm_widget_progressbar.h" -static const char PROGRESSBAR_SMART_NAME[] = "elm_progressbar"; +EAPI const char ELM_PROGRESSBAR_SMART_NAME[] = "elm_progressbar"; static const char SIG_CHANGED[] = "changed"; #define MIN_RATIO_LVL 0.0 #define MAX_RATIO_LVL 1.0 -typedef struct _Elm_Progressbar_Smart_Data Elm_Progressbar_Smart_Data; - -struct _Elm_Progressbar_Smart_Data -{ - Elm_Layout_Smart_Data base; - - Evas_Object *spacer; - const char *units; - - Evas_Coord size; - double val; - - Eina_Bool horizontal : 1; - Eina_Bool inverted : 1; - Eina_Bool pulse : 1; - Eina_Bool pulse_state : 1; - - char *(*unit_format_func)(double val); - void (*unit_format_free)(char *str); -}; - -#define ELM_PROGRESSBAR_DATA_GET(o, sd) \ - Elm_Progressbar_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_PROGRESSBAR_DATA_GET_OR_RETURN(o, ptr) \ - ELM_PROGRESSBAR_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_PROGRESSBAR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_PROGRESSBAR_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_PROGRESSBAR_CHECK(obj) \ - if (!obj || !elm_widget_type_check \ - ((obj), PROGRESSBAR_SMART_NAME, __func__)) \ - return - /* smart callbacks coming from elm progressbar objects (besides the * ones coming from elm layout): */ static const Evas_Smart_Cb_Description _smart_callbacks[] = { @@ -66,7 +19,7 @@ static const Evas_Smart_Cb_Description _smart_callbacks[] = { /* Inheriting from elm_layout. Besides, we need no more than what is * there */ EVAS_SMART_SUBCLASS_NEW - (PROGRESSBAR_SMART_NAME, _elm_progressbar, Elm_Layout_Smart_Class, + (ELM_PROGRESSBAR_SMART_NAME, _elm_progressbar, Elm_Progressbar_Smart_Class, Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks); static const Elm_Layout_Part_Alias_Description _content_aliases[] = @@ -276,7 +229,7 @@ _elm_progressbar_smart_del(Evas_Object *obj) } static void -_elm_progressbar_smart_set_user(Elm_Layout_Smart_Class *sc) +_elm_progressbar_smart_set_user(Elm_Progressbar_Smart_Class *sc) { ELM_WIDGET_CLASS(sc)->base.add = _elm_progressbar_smart_add; ELM_WIDGET_CLASS(sc)->base.del = _elm_progressbar_smart_del; @@ -291,10 +244,28 @@ _elm_progressbar_smart_set_user(Elm_Layout_Smart_Class *sc) ELM_CONTAINER_CLASS(sc)->content_set = _elm_progressbar_smart_content_set; - sc->sizing_eval = _elm_progressbar_smart_sizing_eval; + ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_progressbar_smart_sizing_eval; - 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_Progressbar_Smart_Class * +elm_progressbar_smart_class_get(void) +{ + static Elm_Progressbar_Smart_Class _sc = + ELM_PROGRESSBAR_SMART_CLASS_INIT_NAME_VERSION(ELM_PROGRESSBAR_SMART_NAME); + static const Elm_Progressbar_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) + return class; + + _elm_progressbar_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; } EAPI Evas_Object * diff --git a/legacy/elementary/src/lib/elm_widget_progressbar.h b/legacy/elementary/src/lib/elm_widget_progressbar.h new file mode 100644 index 0000000000..e061936a0a --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_progressbar.h @@ -0,0 +1,174 @@ +#ifndef ELM_WIDGET_PROGRESSBAR_H +#define ELM_WIDGET_PROGRESSBAR_H + +#include "elm_widget_layout.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-progressbar-class The Elementary Progressbar Class + * + * Elementary, besides having the @ref Progressbar widget, exposes its + * foundation -- the Elementary Progressbar Class -- in order to create other + * widgets which are a progressbar with some more logic on top. + */ + +/** + * @def ELM_PROGRESSBAR_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Progressbar_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_CLASS(x) ((Elm_Progressbar_Smart_Class *)x) + +/** + * @def ELM_PROGRESSBAR_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Progressbar_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_DATA(x) ((Elm_Progressbar_Smart_Data *)x) + +/** + * @def ELM_PROGRESSBAR_SMART_CLASS_VERSION + * + * Current version for Elementary progressbar @b base smart class, a value + * which goes to _Elm_Progressbar_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_SMART_CLASS_VERSION 1 + +/** + * @def ELM_PROGRESSBAR_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Progressbar_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_PROGRESSBAR_SMART_CLASS_INIT_NULL + * @see ELM_PROGRESSBAR_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_PROGRESSBAR_SMART_CLASS_VERSION} + +/** + * @def ELM_PROGRESSBAR_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Progressbar_Smart_Class structure. + * + * @see ELM_PROGRESSBAR_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PROGRESSBAR_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_SMART_CLASS_INIT_NULL \ + ELM_PROGRESSBAR_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_PROGRESSBAR_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Progressbar_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_PROGRESSBAR_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Progressbar_Smart_Class (base field) + * to the latest #ELM_PROGRESSBAR_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_PROGRESSBAR_SMART_CLASS_INIT_NULL + * @see ELM_PROGRESSBAR_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PROGRESSBAR_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_PROGRESSBAR_SMART_CLASS_INIT \ + (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary progressbar base smart class. This inherits directly from + * #Elm_Layout_Smart_Class and is meant to build widgets extending the + * behavior of a progressbar. + * + * All of the functions listed on @ref Progressbar namespace will work for + * objects deriving from #Elm_Progressbar_Smart_Class. + */ +typedef struct _Elm_Progressbar_Smart_Class +{ + Elm_Layout_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Progressbar_Smart_Class; + +/** + * Base layout smart data extended with progressbar instance data. + */ +typedef struct _Elm_Progressbar_Smart_Data Elm_Progressbar_Smart_Data; +struct _Elm_Progressbar_Smart_Data +{ + Elm_Layout_Smart_Data base; + + Evas_Object *spacer; + const char *units; + + Evas_Coord size; + double val; + + Eina_Bool horizontal : 1; + Eina_Bool inverted : 1; + Eina_Bool pulse : 1; + Eina_Bool pulse_state : 1; + + char *(*unit_format_func)(double val); + void (*unit_format_free)(char *str); +}; + +/** + * @} + */ + +EAPI extern const char ELM_PROGRESSBAR_SMART_NAME[]; +EAPI const Elm_Progressbar_Smart_Class *elm_progressbar_smart_class_get(void); + +#define ELM_PROGRESSBAR_DATA_GET(o, sd) \ + Elm_Progressbar_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_PROGRESSBAR_DATA_GET_OR_RETURN(o, ptr) \ + ELM_PROGRESSBAR_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_PROGRESSBAR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_PROGRESSBAR_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_PROGRESSBAR_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_PROGRESSBAR_SMART_NAME, \ + __func__)) \ + return + +#endif