1 #ifndef ELM_WIDGET_BOX_H
2 #define ELM_WIDGET_BOX_H
8 * @section elm-box-class The Elementary Box Class
10 * Elementary, besides having the @ref Box widget, exposes its
11 * foundation -- the Elementary Box Class -- in order to create
12 * other widgets which are a box with some more logic on top.
18 * Use this macro to cast whichever subclass of
19 * #Elm_Box_Smart_Class into it, so to access its fields.
23 #define ELM_BOX_CLASS(x) ((Elm_Box_Smart_Class *) x)
28 * Use this macro to cast whichever subdata of
29 * #Elm_Box_Smart_Data into it, so to access its fields.
33 #define ELM_BOX_DATA(x) ((Elm_Box_Smart_Data *) x)
36 * @def ELM_BOX_SMART_CLASS_VERSION
38 * Current version for Elementary box @b base smart class, a value
39 * which goes to _Elm_Box_Smart_Class::version.
43 #define ELM_BOX_SMART_CLASS_VERSION 1
46 * @def ELM_BOX_SMART_CLASS_INIT
48 * Initializer for a whole #Elm_Box_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_BOX_SMART_CLASS_INIT_NULL
57 * @see ELM_BOX_SMART_CLASS_INIT_NAME_VERSION
61 #define ELM_BOX_SMART_CLASS_INIT(smart_class_init) \
62 {smart_class_init, ELM_BOX_SMART_CLASS_VERSION}
65 * @def ELM_BOX_SMART_CLASS_INIT_NULL
67 * Initializer to zero out a whole #Elm_Box_Smart_Class structure.
69 * @see ELM_BOX_SMART_CLASS_INIT_NAME_VERSION
70 * @see ELM_BOX_SMART_CLASS_INIT
74 #define ELM_BOX_SMART_CLASS_INIT_NULL \
75 ELM_BOX_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
78 * @def ELM_BOX_SMART_CLASS_INIT_NAME_VERSION
80 * Initializer to zero out a whole #Elm_Box_Smart_Class structure and
81 * set its name and version.
83 * This is similar to #ELM_BOX_SMART_CLASS_INIT_NULL, but it will
84 * also set the version field of #Elm_Box_Smart_Class (base field)
85 * to the latest #ELM_BOX_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_BOX_SMART_CLASS_INIT_NULL
93 * @see ELM_BOX_SMART_CLASS_INIT
97 #define ELM_BOX_SMART_CLASS_INIT_NAME_VERSION(name) \
98 ELM_BOX_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
101 * Elementary box base smart class. This inherits directly from
102 * #Elm_Widget_Smart_Class and is meant to build widgets extending the
105 * All of the functions listed on @ref Box namespace will work for
106 * objects deriving from #Elm_Box_Smart_Class.
108 typedef struct _Elm_Box_Smart_Class
110 Elm_Widget_Smart_Class base;
112 int version; /**< Version of this smart class definition */
113 } Elm_Box_Smart_Class;
116 * Base widget smart data extended with box instance data.
118 typedef struct _Elm_Box_Smart_Data Elm_Box_Smart_Data;
119 struct _Elm_Box_Smart_Data
121 Elm_Widget_Smart_Data base; /* base widget smart data as
122 * first member obligatory, as
123 * we're inheriting from it */
125 Eina_Bool homogeneous : 1;
126 Eina_Bool on_deletion : 1;
127 Eina_Bool horizontal : 1;
128 Eina_Bool recalc : 1;
131 struct _Elm_Box_Transition
135 Ecore_Animator *animator;
139 Evas_Object_Box_Layout layout;
141 void (*free_data)(void *data);
144 void (*transition_end_cb)(void *data);
145 void *transition_end_data;
146 void (*transition_end_free_data)(void *data);
150 Eina_Bool animation_ended : 1;
151 Eina_Bool recalculate : 1;
154 typedef struct _Transition_Animation_Data Transition_Animation_Data;
155 struct _Transition_Animation_Data
160 Evas_Coord x, y, w, h;
168 EAPI extern const char ELM_BOX_SMART_NAME[];
169 EAPI const Elm_Box_Smart_Class *elm_box_smart_class_get(void);
171 #define ELM_BOX_DATA_GET(o, sd) \
172 Elm_Box_Smart_Data * sd = evas_object_smart_data_get(o)
174 #define ELM_BOX_DATA_GET_OR_RETURN(o, ptr) \
175 ELM_BOX_DATA_GET(o, ptr); \
178 CRITICAL("No widget data for object %p (%s)", \
179 o, evas_object_type_get(o)); \
183 #define ELM_BOX_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
184 ELM_BOX_DATA_GET(o, ptr); \
187 CRITICAL("No widget data for object %p (%s)", \
188 o, evas_object_type_get(o)); \
192 #define ELM_BOX_CHECK(obj) \
193 if (!obj || !elm_widget_type_check((obj), ELM_BOX_SMART_NAME, __func__)) \