1 #ifndef ELM_WIDGET_SCROLLER_H
2 #define ELM_WIDGET_SCROLLER_H
4 #include "elm_interface_scrollable.h"
5 #include "elm_widget_layout.h"
11 * @section elm-scroller-class The Elementary Scroller Class
13 * Elementary, besides having the @ref Scroller widget, exposes its
14 * foundation -- the Elementary Scroller Class -- in order to create
15 * other widgets which are a scroller with some more logic on top.
19 * @def ELM_SCROLLER_CLASS
21 * Use this macro to cast whichever subclass of
22 * #Elm_Scroller_Smart_Class into it, so to access its fields.
26 #define ELM_SCROLLER_CLASS(x) ((Elm_Scroller_Smart_Class *)x)
29 * @def ELM_SCROLLER_DATA
31 * Use this macro to cast whichever subdata of
32 * #Elm_Scroller_Smart_Data into it, so to access its fields.
36 #define ELM_SCROLLER_DATA(x) ((Elm_Scroller_Smart_Data *)x)
39 * @def ELM_SCROLLER_SMART_CLASS_VERSION
41 * Current version for Elementary scroller @b base smart class, a value
42 * which goes to _Elm_Scroller_Smart_Class::version.
46 #define ELM_SCROLLER_SMART_CLASS_VERSION 1
49 * @def ELM_SCROLLER_SMART_CLASS_INIT
51 * Initializer for a whole #Elm_Scroller_Smart_Class structure, with
52 * @c NULL values on its specific fields.
54 * @param smart_class_init initializer to use for the "base" field
55 * (#Evas_Smart_Class).
57 * @see EVAS_SMART_CLASS_INIT_NULL
58 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
59 * @see ELM_SCROLLER_SMART_CLASS_INIT_NULL
60 * @see ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
64 #define ELM_SCROLLER_SMART_CLASS_INIT(smart_class_init) \
65 {smart_class_init, ELM_SCROLLER_SMART_CLASS_VERSION}
68 * @def ELM_SCROLLER_SMART_CLASS_INIT_NULL
70 * Initializer to zero out a whole #Elm_Scroller_Smart_Class structure.
72 * @see ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
73 * @see ELM_SCROLLER_SMART_CLASS_INIT
77 #define ELM_SCROLLER_SMART_CLASS_INIT_NULL \
78 ELM_SCROLLER_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
81 * @def ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
83 * Initializer to zero out a whole #Elm_Scroller_Smart_Class structure and
84 * set its name and version.
86 * This is similar to #ELM_SCROLLER_SMART_CLASS_INIT_NULL, but it will
87 * also set the version field of #Elm_Scroller_Smart_Class (base field)
88 * to the latest #ELM_SCROLLER_SMART_CLASS_VERSION and name it to the
91 * It will keep a reference to the name field as a <c>"const char *"</c>,
92 * i.e., the name must be available while the structure is
93 * used (hint: static or global variable!) and must not be modified.
95 * @see ELM_SCROLLER_SMART_CLASS_INIT_NULL
96 * @see ELM_SCROLLER_SMART_CLASS_INIT
100 #define ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION(name) \
101 ELM_SCROLLER_SMART_CLASS_INIT \
102 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
105 * Elementary scroller base smart class. This inherits directly from
106 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
107 * behavior of a scroller.
109 * All of the functions listed on @ref Scroller namespace will work for
110 * objects deriving from #Elm_Scroller_Smart_Class.
112 typedef struct _Elm_Scroller_Smart_Class
114 Elm_Layout_Smart_Class base;
116 int version; /**< Version of this smart class definition */
117 } Elm_Scroller_Smart_Class;
120 * Base widget smart data extended with scroller instance data.
122 typedef struct _Elm_Scroller_Smart_Data Elm_Scroller_Smart_Data;
123 struct _Elm_Scroller_Smart_Data
125 Elm_Layout_Smart_Data base; /* base widget smart data as
126 * first member obligatory, as
127 * we're inheriting from it */
129 const Elm_Scrollable_Smart_Interface *s_iface;
131 Evas_Object *hit_rect;
132 Evas_Object *g_layer;
134 Evas_Object *content;
144 EAPI extern const char ELM_SCROLLER_SMART_NAME[];
145 EAPI const Elm_Scroller_Smart_Class *elm_scroller_smart_class_get(void);
147 #define ELM_SCROLLER_DATA_GET(o, sd) \
148 Elm_Scroller_Smart_Data * sd = evas_object_smart_data_get(o)
150 #define ELM_SCROLLER_DATA_GET_OR_RETURN(o, ptr) \
151 ELM_SCROLLER_DATA_GET(o, ptr); \
154 CRITICAL("No widget data for object %p (%s)", \
155 o, evas_object_type_get(o)); \
159 #define ELM_SCROLLER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
160 ELM_SCROLLER_DATA_GET(o, ptr); \
163 CRITICAL("No widget data for object %p (%s)", \
164 o, evas_object_type_get(o)); \
168 #define ELM_SCROLLER_CHECK(obj) \
169 if (!obj || !elm_widget_type_check \
170 ((obj), ELM_SCROLLER_SMART_NAME, __func__)) \