diff --git a/legacy/elementary/src/lib/Makefile.am b/legacy/elementary/src/lib/Makefile.am index 4da9ae3f26..00f1ea1e7a 100644 --- a/legacy/elementary/src/lib/Makefile.am +++ b/legacy/elementary/src/lib/Makefile.am @@ -68,6 +68,7 @@ elm_widget_naviframe.h \ elm_widget_notify.h \ elm_widget_photo.h \ elm_widget_photocam.h \ +elm_widget_player.h \ elm_widget_plug.h \ elm_widget_progressbar.h \ elm_widget_radio.h \ diff --git a/legacy/elementary/src/lib/elc_player.c b/legacy/elementary/src/lib/elc_player.c index 7ec67c01b5..393892f08c 100644 --- a/legacy/elementary/src/lib/elc_player.c +++ b/legacy/elementary/src/lib/elc_player.c @@ -1,57 +1,12 @@ #include #include "elm_priv.h" -#include "elm_widget_layout.h" +#include "elm_widget_player.h" #ifdef HAVE_EMOTION # include #endif -static const char PLAYER_SMART_NAME[] = "elm_player"; - -typedef struct _Elm_Player_Smart_Data Elm_Player_Smart_Data; -struct _Elm_Player_Smart_Data -{ - Elm_Layout_Smart_Data base; - - Evas_Object *video; - Evas_Object *emotion; - - /* tracking those to ease disabling/enabling them back */ - Evas_Object *forward; - Evas_Object *info; - Evas_Object *next; - Evas_Object *pause; - Evas_Object *play; - Evas_Object *prev; - Evas_Object *rewind; - Evas_Object *stop; - Evas_Object *slider; -}; - -#define ELM_PLAYER_DATA_GET(o, sd) \ - Elm_Player_Smart_Data * sd = evas_object_smart_data_get(o) - -#define ELM_PLAYER_DATA_GET_OR_RETURN(o, ptr) \ - ELM_PLAYER_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return; \ - } - -#define ELM_PLAYER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ - ELM_PLAYER_DATA_GET(o, ptr); \ - if (!ptr) \ - { \ - CRITICAL("No widget data for object %p (%s)", \ - o, evas_object_type_get(o)); \ - return val; \ - } - -#define ELM_PLAYER_CHECK(obj) \ - if (!obj || !elm_widget_type_check((obj), PLAYER_SMART_NAME, __func__)) \ - return +EAPI const char ELM_PLAYER_SMART_NAME[] = "elm_player"; static const char SIG_FORWARD_CLICKED[] = "forward,clicked"; static const char SIG_INFO_CLICKED[] = "info,clicked"; @@ -76,7 +31,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 - (PLAYER_SMART_NAME, _elm_player, Elm_Layout_Smart_Class, + (ELM_PLAYER_SMART_NAME, _elm_player, Elm_Player_Smart_Class, Elm_Layout_Smart_Class, elm_layout_smart_class_get, _smart_callbacks); #ifdef HAVE_EMOTION @@ -541,7 +496,7 @@ _elm_player_smart_add(Evas_Object *obj) #endif static void -_elm_player_smart_set_user(Elm_Layout_Smart_Class *sc) +_elm_player_smart_set_user(Elm_Player_Smart_Class *sc) { #ifdef HAVE_EMOTION ELM_WIDGET_CLASS(sc)->base.add = _elm_player_smart_add; @@ -551,12 +506,30 @@ _elm_player_smart_set_user(Elm_Layout_Smart_Class *sc) ELM_CONTAINER_CLASS(sc)->content_set = _elm_player_smart_content_set; - sc->sizing_eval = _elm_player_smart_sizing_eval; + ELM_LAYOUT_CLASS(sc)->sizing_eval = _elm_player_smart_sizing_eval; #else (void) sc; #endif } +EAPI const Elm_Player_Smart_Class * +elm_player_smart_class_get(void) +{ + static Elm_Player_Smart_Class _sc = + ELM_PLAYER_SMART_CLASS_INIT_NAME_VERSION(ELM_PLAYER_SMART_NAME); + static const Elm_Player_Smart_Class *class = NULL; + Evas_Smart_Class *esc = (Evas_Smart_Class *)&_sc; + + if (class) + return class; + + _elm_player_smart_set(&_sc); + esc->callbacks = _smart_callbacks; + class = &_sc; + + return class; +} + EAPI Evas_Object * elm_player_add(Evas_Object *parent) { diff --git a/legacy/elementary/src/lib/elm_widget_player.h b/legacy/elementary/src/lib/elm_widget_player.h new file mode 100644 index 0000000000..bc8180d5c0 --- /dev/null +++ b/legacy/elementary/src/lib/elm_widget_player.h @@ -0,0 +1,174 @@ +#ifndef ELM_WIDGET_PLAYER_H +#define ELM_WIDGET_PLAYER_H + +#include "elm_widget_layout.h" + +/** + * @addtogroup Widget + * @{ + * + * @section elm-player-class The Elementary Player Class + * + * Elementary, besides having the @ref Player widget, exposes its + * foundation -- the Elementary Player Class -- in order to create other + * widgets which are a player with some more logic on top. + */ + +/** + * @def ELM_PLAYER_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Player_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PLAYER_CLASS(x) ((Elm_Player_Smart_Class *)x) + +/** + * @def ELM_PLAYER_DATA + * + * Use this macro to cast whichever subdata of + * #Elm_Player_Smart_Data into it, so to access its fields. + * + * @ingroup Widget + */ +#define ELM_PLAYER_DATA(x) ((Elm_Player_Smart_Data *)x) + +/** + * @def ELM_PLAYER_SMART_CLASS_VERSION + * + * Current version for Elementary player @b base smart class, a value + * which goes to _Elm_Player_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_PLAYER_SMART_CLASS_VERSION 1 + +/** + * @def ELM_PLAYER_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Player_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_PLAYER_SMART_CLASS_INIT_NULL + * @see ELM_PLAYER_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_PLAYER_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_PLAYER_SMART_CLASS_VERSION} + +/** + * @def ELM_PLAYER_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Player_Smart_Class structure. + * + * @see ELM_PLAYER_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PLAYER_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PLAYER_SMART_CLASS_INIT_NULL \ + ELM_PLAYER_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_PLAYER_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Player_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_PLAYER_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Player_Smart_Class (base field) + * to the latest #ELM_PLAYER_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_PLAYER_SMART_CLASS_INIT_NULL + * @see ELM_PLAYER_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PLAYER_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_PLAYER_SMART_CLASS_INIT \ + (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary player base smart class. This inherits directly from + * #Elm_Layout_Smart_Class and is meant to build widgets extending the + * behavior of a player. + * + * All of the functions listed on @ref Player namespace will work for + * objects deriving from #Elm_Player_Smart_Class. + */ +typedef struct _Elm_Player_Smart_Class +{ + Elm_Layout_Smart_Class base; + + int version; /**< Version of this smart class definition */ +} Elm_Player_Smart_Class; + +/** + * Base layout smart data extended with player instance data. + */ +typedef struct _Elm_Player_Smart_Data Elm_Player_Smart_Data; +struct _Elm_Player_Smart_Data +{ + Elm_Layout_Smart_Data base; + + Evas_Object *video; + Evas_Object *emotion; + + /* tracking those to ease disabling/enabling them back */ + Evas_Object *forward; + Evas_Object *info; + Evas_Object *next; + Evas_Object *pause; + Evas_Object *play; + Evas_Object *prev; + Evas_Object *rewind; + Evas_Object *stop; + Evas_Object *slider; +}; + +/** + * @} + */ + +EAPI extern const char ELM_PLAYER_SMART_NAME[]; +EAPI const Elm_Player_Smart_Class *elm_player_smart_class_get(void); + +#define ELM_PLAYER_DATA_GET(o, sd) \ + Elm_Player_Smart_Data * sd = evas_object_smart_data_get(o) + +#define ELM_PLAYER_DATA_GET_OR_RETURN(o, ptr) \ + ELM_PLAYER_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return; \ + } + +#define ELM_PLAYER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \ + ELM_PLAYER_DATA_GET(o, ptr); \ + if (!ptr) \ + { \ + CRITICAL("No widget data for object %p (%s)", \ + o, evas_object_type_get(o)); \ + return val; \ + } + +#define ELM_PLAYER_CHECK(obj) \ + if (!obj || !elm_widget_type_check((obj), ELM_PLAYER_SMART_NAME, \ + __func__)) \ + return + +#endif