1 #ifndef ELM_WIDGET_THUMB_H
2 #define ELM_WIDGET_THUMB_H
8 * @section elm-thumb-class The Elementary Thumb Class
10 * Elementary, besides having the @ref Thumb widget, exposes its
11 * foundation -- the Elementary Thumb Class -- in order to create
12 * other widgets which are a thumb with some more logic on top.
16 * @def ELM_THUMB_CLASS
18 * Use this macro to cast whichever subclass of
19 * #Elm_Thumb_Smart_Class into it, so to access its fields.
23 #define ELM_THUMB_CLASS(x) ((Elm_Thumb_Smart_Class *) x)
28 * Use this macro to cast whichever subdata of
29 * #Elm_Thumb_Smart_Data into it, so to access its fields.
33 #define ELM_THUMB_DATA(x) ((Elm_Thumb_Smart_Data *) x)
36 * @def ELM_THUMB_SMART_CLASS_VERSION
38 * Current version for Elementary thumb @b base smart class, a value
39 * which goes to _Elm_Thumb_Smart_Class::version.
43 #define ELM_THUMB_SMART_CLASS_VERSION 1
46 * @def ELM_THUMB_SMART_CLASS_INIT
48 * Initializer for a whole #Elm_Thumb_Smart_Class structure, with
49 * @c NULL values on its specific fields.
51 * @param smart_class_init initializer to use for the "base" field
52 * (#Evas_Smart_Class).
54 * @see EVAS_SMART_CLASS_INIT_NULL
55 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
56 * @see ELM_THUMB_SMART_CLASS_INIT_NULL
57 * @see ELM_THUMB_SMART_CLASS_INIT_NAME_VERSION
61 #define ELM_THUMB_SMART_CLASS_INIT(smart_class_init) \
62 {smart_class_init, ELM_THUMB_SMART_CLASS_VERSION}
65 * @def ELM_THUMB_SMART_CLASS_INIT_NULL
67 * Initializer to zero out a whole #Elm_Thumb_Smart_Class structure.
69 * @see ELM_THUMB_SMART_CLASS_INIT_NAME_VERSION
70 * @see ELM_THUMB_SMART_CLASS_INIT
74 #define ELM_THUMB_SMART_CLASS_INIT_NULL \
75 ELM_THUMB_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
78 * @def ELM_THUMB_SMART_CLASS_INIT_NAME_VERSION
80 * Initializer to zero out a whole #Elm_Thumb_Smart_Class structure and
81 * set its name and version.
83 * This is similar to #ELM_THUMB_SMART_CLASS_INIT_NULL, but it will
84 * also set the version field of #Elm_Thumb_Smart_Class (base field)
85 * to the latest #ELM_THUMB_SMART_CLASS_VERSION and name it to the
88 * It will keep a reference to the name field as a <c>"const char *"</c>,
89 * i.e., the name must be available while the structure is
90 * used (hint: static or global variable!) and must not be modified.
92 * @see ELM_THUMB_SMART_CLASS_INIT_NULL
93 * @see ELM_THUMB_SMART_CLASS_INIT
97 #define ELM_THUMB_SMART_CLASS_INIT_NAME_VERSION(name) \
98 ELM_THUMB_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
101 * Elementary thumb base smart class. This inherits directly from
102 * #Elm_Widget_Smart_Class and is meant to build widgets extending the
103 * behavior of a thumb.
105 * All of the functions listed on @ref Thumb namespace will work for
106 * objects deriving from #Elm_Thumb_Smart_Class.
108 typedef struct _Elm_Thumb_Smart_Class
110 Elm_Widget_Smart_Class base;
112 int version; /**< Version of this smart class definition */
113 } Elm_Thumb_Smart_Class;
116 * Base widget smart data extended with thumb instance data.
118 typedef struct _Elm_Thumb_Smart_Data Elm_Thumb_Smart_Data;
119 struct _Elm_Thumb_Smart_Data
121 Elm_Widget_Smart_Data base;
123 Evas_Object *view; /* actual thumbnail, to be swallowed
124 * at the thumb frame */
126 /* original object's file/key pair */
132 /* object's thumbnail file/key pair */
135 #ifdef HAVE_ELEMENTARY_ETHUMB
136 const char *thumb_path;
137 const char *thumb_key;
138 Ethumb_Client_Async *request;
140 Ethumb_Thumb_Format format;
146 Ecore_Event_Handler *eeh;
147 Elm_Thumb_Animation_Setting anim_setting;
150 Eina_Bool on_hold : 1;
151 Eina_Bool is_video : 1;
152 Eina_Bool was_video : 1;
159 EAPI extern const char ELM_THUMB_SMART_NAME[];
160 EAPI const Elm_Thumb_Smart_Class *elm_thumb_smart_class_get(void);
162 #define ELM_THUMB_DATA_GET(o, sd) \
163 Elm_Thumb_Smart_Data * sd = evas_object_smart_data_get(o)
165 #define ELM_THUMB_DATA_GET_OR_RETURN(o, ptr) \
166 ELM_THUMB_DATA_GET(o, ptr); \
169 CRITICAL("No widget data for object %p (%s)", \
170 o, evas_object_type_get(o)); \
174 #define ELM_THUMB_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
175 ELM_THUMB_DATA_GET(o, ptr); \
178 CRITICAL("No widget data for object %p (%s)", \
179 o, evas_object_type_get(o)); \
183 #define ELM_THUMB_CHECK(obj) \
184 if (!obj || !elm_widget_type_check((obj), ELM_THUMB_SMART_NAME, __func__)) \