1 #ifndef ELM_WIDGET_BG_H
2 #define ELM_WIDGET_BG_H
4 #include "elm_widget_layout.h"
10 * @section elm-bg-class The Elementary Bg Class
12 * Elementary, besides having the @ref Bg widget, exposes its
13 * foundation -- the Elementary Bg Class -- in order to create other
14 * widgets which are a bg with some more logic on top.
20 * Use this macro to cast whichever subclass of
21 * #Elm_Bg_Smart_Class into it, so to access its fields.
25 #define ELM_BG_CLASS(x) ((Elm_Bg_Smart_Class *)x)
30 * Use this macro to cast whichever subdata of
31 * #Elm_Bg_Smart_Data into it, so to access its fields.
35 #define ELM_BG_DATA(x) ((Elm_Bg_Smart_Data *)x)
38 * @def ELM_BG_SMART_CLASS_VERSION
40 * Current version for Elementary bg @b base smart class, a value
41 * which goes to _Elm_Bg_Smart_Class::version.
45 #define ELM_BG_SMART_CLASS_VERSION 1
48 * @def ELM_BG_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Bg_Smart_Class structure, with
51 * @c NULL values on its specific fields.
53 * @param smart_class_init initializer to use for the "base" field
54 * (#Evas_Smart_Class).
56 * @see EVAS_SMART_CLASS_INIT_NULL
57 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
58 * @see ELM_BG_SMART_CLASS_INIT_NULL
59 * @see ELM_BG_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_BG_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_BG_SMART_CLASS_VERSION}
67 * @def ELM_BG_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Bg_Smart_Class structure.
71 * @see ELM_BG_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_BG_SMART_CLASS_INIT
76 #define ELM_BG_SMART_CLASS_INIT_NULL \
77 ELM_BG_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_BG_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Bg_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_BG_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Bg_Smart_Class (base field)
87 * to the latest #ELM_BG_SMART_CLASS_VERSION and name it to the
90 * It will keep a reference to the name field as a <c>"const char *"</c>,
91 * i.e., the name must be available while the structure is
92 * used (hint: static or global variable!) and must not be modified.
94 * @see ELM_BG_SMART_CLASS_INIT_NULL
95 * @see ELM_BG_SMART_CLASS_INIT
99 #define ELM_BG_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_BG_SMART_CLASS_INIT \
101 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
104 * Elementary bg base smart class. This inherits directly from
105 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
108 * All of the functions listed on @ref Bg namespace will work for
109 * objects deriving from #Elm_Bg_Smart_Class.
111 typedef struct _Elm_Bg_Smart_Class
113 Elm_Layout_Smart_Class base;
115 int version; /**< Version of this smart class definition */
116 } Elm_Bg_Smart_Class;
119 * Base layout smart data extended with bg instance data.
121 typedef struct _Elm_Bg_Smart_Data Elm_Bg_Smart_Data;
122 struct _Elm_Bg_Smart_Data
124 Elm_Layout_Smart_Data base;
126 /* the basic background's edje object has three swallow spots, namely:
127 * - "elm.swallow.rectangle" (elm_bg_color_set),
128 * - "elm.swallow.background" (elm_bg_file_set) and
129 * - "elm.swallow.content" (elm_bg_overlay_set).
130 * the following three variables hold possible content to fit in each
131 * of them, respectively. */
133 Evas_Object *rect, *img;
134 const char *file, *group; /* path to file and group name
135 * to give life to "img" */
136 Elm_Bg_Option option;
147 EAPI extern const char ELM_BG_SMART_NAME[];
148 EAPI const Elm_Bg_Smart_Class *elm_bg_smart_class_get(void);
150 #define ELM_BG_DATA_GET(o, sd) \
151 Elm_Bg_Smart_Data * sd = evas_object_smart_data_get(o)
153 #define ELM_BG_DATA_GET_OR_RETURN(o, ptr) \
154 ELM_BG_DATA_GET(o, ptr); \
157 CRITICAL("No widget data for object %p (%s)", \
158 o, evas_object_type_get(o)); \
162 #define ELM_BG_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
163 ELM_BG_DATA_GET(o, ptr); \
166 CRITICAL("No widget data for object %p (%s)", \
167 o, evas_object_type_get(o)); \
171 #define ELM_BG_CHECK(obj) \
172 if (!obj || !elm_widget_type_check((obj), ELM_BG_SMART_NAME, \