1 #ifndef ELM_WIDGET_POPUP_H
2 #define ELM_WIDGET_POPUP_H
4 #include "elm_widget_layout.h"
10 * @section elm-popup-class The Elementary Popup Class
12 * Elementary, besides having the @ref Popup widget, exposes its
13 * foundation -- the Elementary Popup Class -- in order to create other
14 * widgets which are a popup with some more logic on top.
18 * @def ELM_POPUP_CLASS
20 * Use this macro to cast whichever subclass of
21 * #Elm_Popup_Smart_Class into it, so to access its fields.
25 #define ELM_POPUP_CLASS(x) ((Elm_Popup_Smart_Class *)x)
30 * Use this macro to cast whichever subdata of
31 * #Elm_Popup_Smart_Data into it, so to access its fields.
35 #define ELM_POPUP_DATA(x) ((Elm_Popup_Smart_Data *)x)
38 * @def ELM_POPUP_SMART_CLASS_VERSION
40 * Current version for Elementary popup @b base smart class, a value
41 * which goes to _Elm_Popup_Smart_Class::version.
45 #define ELM_POPUP_SMART_CLASS_VERSION 1
48 * @def ELM_POPUP_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Popup_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_POPUP_SMART_CLASS_INIT_NULL
59 * @see ELM_POPUP_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_POPUP_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_POPUP_SMART_CLASS_VERSION}
67 * @def ELM_POPUP_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Popup_Smart_Class structure.
71 * @see ELM_POPUP_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_POPUP_SMART_CLASS_INIT
76 #define ELM_POPUP_SMART_CLASS_INIT_NULL \
77 ELM_POPUP_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_POPUP_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Popup_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_POPUP_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Popup_Smart_Class (base field)
87 * to the latest #ELM_POPUP_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_POPUP_SMART_CLASS_INIT_NULL
95 * @see ELM_POPUP_SMART_CLASS_INIT
99 #define ELM_POPUP_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_POPUP_SMART_CLASS_INIT \
101 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
104 * Elementary popup base smart class. This inherits directly from
105 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
106 * behavior of a popup.
108 * All of the functions listed on @ref Popup namespace will work for
109 * objects deriving from #Elm_Popup_Smart_Class.
111 typedef struct _Elm_Popup_Smart_Class
113 Elm_Layout_Smart_Class base;
115 int version; /**< Version of this smart class definition */
116 } Elm_Popup_Smart_Class;
118 #define ELM_POPUP_ACTION_BUTTON_MAX 3
120 typedef struct _Action_Area_Data Action_Area_Data;
123 * Base layout smart data extended with popup instance data.
125 typedef struct _Elm_Popup_Smart_Data Elm_Popup_Smart_Data;
126 struct _Elm_Popup_Smart_Data
128 Elm_Layout_Smart_Data base;
131 Evas_Object *title_icon;
132 Evas_Object *title_access_obj;
133 Evas_Object *content_area;
134 Evas_Object *text_content_obj;
135 Evas_Object *action_area;
140 Evas_Object *content;
142 const char *title_text;
143 Action_Area_Data *buttons[ELM_POPUP_ACTION_BUTTON_MAX];
144 Elm_Wrap_Type content_text_wrap_type;
145 unsigned int button_count;
149 Eina_Bool visible : 1;
150 Eina_Bool no_shift : 1;
151 Eina_Bool scr_size_recalc : 1;
154 typedef struct _Elm_Popup_Item Elm_Popup_Item;
155 struct _Elm_Popup_Item
157 Elm_Widget_Item base;
162 Eina_Bool disabled : 1;
165 struct _Action_Area_Data
176 EAPI extern const char ELM_POPUP_SMART_NAME[];
177 EAPI const Elm_Popup_Smart_Class *elm_popup_smart_class_get(void);
179 #define ELM_POPUP_DATA_GET(o, sd) \
180 Elm_Popup_Smart_Data * sd = evas_object_smart_data_get(o)
182 #define ELM_POPUP_DATA_GET_OR_RETURN(o, ptr) \
183 ELM_POPUP_DATA_GET(o, ptr); \
186 CRITICAL("No widget data for object %p (%s)", \
187 o, evas_object_type_get(o)); \
191 #define ELM_POPUP_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
192 ELM_POPUP_DATA_GET(o, ptr); \
195 CRITICAL("No widget data for object %p (%s)", \
196 o, evas_object_type_get(o)); \
200 #define ELM_POPUP_CHECK(obj) \
201 if (!obj || !elm_widget_type_check \
202 ((obj), ELM_POPUP_SMART_NAME, __func__)) \
205 #define ELM_POPUP_ITEM_CHECK(it) \
206 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
207 ELM_POPUP_CHECK(it->base.widget);
209 #define ELM_POPUP_ITEM_CHECK_OR_RETURN(it, ...) \
210 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
211 ELM_POPUP_CHECK(it->base.widget) __VA_ARGS__;