1 #ifndef ELM_WIDGET_ENTRY_H
2 #define ELM_WIDGET_ENTRY_H
4 #include "elm_interface_scrollable.h"
5 #include "elm_widget_layout.h"
11 * @section elm-entry-class The Elementary Entry Class
13 * Elementary, besides having the @ref Entry widget, exposes its
14 * foundation -- the Elementary Entry Class -- in order to create
15 * other widgets which are a entry with some more logic on top.
19 * @def ELM_ENTRY_CLASS
21 * Use this macro to cast whichever subclass of
22 * #Elm_Entry_Smart_Class into it, so to access its fields.
26 #define ELM_ENTRY_CLASS(x) ((Elm_Entry_Smart_Class *)x)
31 * Use this macro to cast whichever subdata of
32 * #Elm_Entry_Smart_Data into it, so to access its fields.
36 #define ELM_ENTRY_DATA(x) ((Elm_Entry_Smart_Data *)x)
39 * @def ELM_ENTRY_SMART_CLASS_VERSION
41 * Current version for Elementary entry @b base smart class, a value
42 * which goes to _Elm_Entry_Smart_Class::version.
46 #define ELM_ENTRY_SMART_CLASS_VERSION 1
49 * @def ELM_ENTRY_SMART_CLASS_INIT
51 * Initializer for a whole #Elm_Entry_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_ENTRY_SMART_CLASS_INIT_NULL
60 * @see ELM_ENTRY_SMART_CLASS_INIT_NAME_VERSION
64 #define ELM_ENTRY_SMART_CLASS_INIT(smart_class_init) \
65 {smart_class_init, ELM_ENTRY_SMART_CLASS_VERSION}
68 * @def ELM_ENTRY_SMART_CLASS_INIT_NULL
70 * Initializer to zero out a whole #Elm_Entry_Smart_Class structure.
72 * @see ELM_ENTRY_SMART_CLASS_INIT_NAME_VERSION
73 * @see ELM_ENTRY_SMART_CLASS_INIT
77 #define ELM_ENTRY_SMART_CLASS_INIT_NULL \
78 ELM_ENTRY_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
81 * @def ELM_ENTRY_SMART_CLASS_INIT_NAME_VERSION
83 * Initializer to zero out a whole #Elm_Entry_Smart_Class structure and
84 * set its name and version.
86 * This is similar to #ELM_ENTRY_SMART_CLASS_INIT_NULL, but it will
87 * also set the version field of #Elm_Entry_Smart_Class (base field)
88 * to the latest #ELM_ENTRY_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_ENTRY_SMART_CLASS_INIT_NULL
96 * @see ELM_ENTRY_SMART_CLASS_INIT
100 #define ELM_ENTRY_SMART_CLASS_INIT_NAME_VERSION(name) \
101 ELM_ENTRY_SMART_CLASS_INIT \
102 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
105 * Elementary entry base smart class. This inherits directly from
106 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
107 * behavior of a entry.
109 * All of the functions listed on @ref Entry namespace will work for
110 * objects deriving from #Elm_Entry_Smart_Class.
112 typedef struct _Elm_Entry_Smart_Class
114 Elm_Layout_Smart_Class base;
116 int version; /**< Version of this smart class definition */
117 } Elm_Entry_Smart_Class;
119 typedef struct _Mod_Api Mod_Api;
122 * Base widget smart data extended with entry instance data.
124 typedef struct _Elm_Entry_Smart_Data Elm_Entry_Smart_Data;
125 struct _Elm_Entry_Smart_Data
127 Elm_Layout_Smart_Data base; /* base widget smart data as
128 * first member obligatory, as
129 * we're inheriting from it */
131 Evas_Object *hit_rect, *entry_edje, *scr_edje;
132 const Elm_Scrollable_Smart_Interface *s_iface;
134 Evas_Object *hoversel;
135 Ecore_Job *deferred_recalc_job;
136 Ecore_Event_Handler *sel_notify_handler;
137 Ecore_Event_Handler *sel_clear_handler;
138 Ecore_Event_Handler *client_msg_handler; // TIZEN ONLY
139 Ecore_Timer *longpress_timer;
140 Ecore_Timer *delay_write;
141 Ecore_Timer *click_timer; // TIZEN ONLY
142 /* for deferred appending */
143 Ecore_Idler *append_text_idler;
144 char *append_text_left;
145 int append_text_position;
147 /* Only for clipboard */
151 Elm_Text_Format format;
152 Evas_Coord last_w, ent_mw, ent_mh;
153 Evas_Coord downx, downy;
155 Eina_List *item_providers;
156 Eina_List *text_filters;
157 Eina_List *markup_filters;
158 Ecore_Job *hov_deljob;
159 Mod_Api *api; // module api if supplied
161 Elm_Scroller_Policy policy_h, policy_v;
162 Elm_Wrap_Type line_wrap;
163 Elm_Input_Panel_Layout input_panel_layout;
164 Elm_Autocapital_Type autocapital_type;
165 Elm_Input_Panel_Lang input_panel_lang;
166 Elm_Input_Panel_Return_Key_Type input_panel_return_key_type;
167 void *input_panel_imdata;
168 int input_panel_imdata_len;
171 Evas_Object *hover_parent;
172 Evas_Object *pop, *hover;
173 const char *hover_style;
176 Elm_Cnp_Mode cnp_mode;
178 Evas_Object *mgf_proxy;
179 Evas_Object *mgf_clip;
181 Evas_Coord mgf_height;
183 int mgf_arrow_height;
185 Ecore_Job *region_get_job;
186 Ecore_Job *region_recalc_job;
187 const char *password_text;
188 Evas_Coord cx, cy, cw, ch;
190 Eina_Bool double_clicked : 1;
191 Eina_Bool long_pressed : 1;
192 Eina_Bool magnifier_enabled : 1;
193 Eina_Bool magnifier_showing : 1;
194 Eina_Bool mouse_upped : 1;
195 Eina_Bool sel_allow : 1;
196 Eina_Bool cursor_handler_disabled : 1;
198 Eina_Bool input_panel_return_key_disabled : 1;
199 Eina_Bool drag_selection_asked : 1;
200 Eina_Bool input_panel_enable : 1;
201 Eina_Bool prediction_allow : 1;
202 Eina_Bool selection_asked : 1;
203 Eina_Bool auto_return_key : 1;
204 Eina_Bool have_selection : 1;
205 Eina_Bool deferred_cur : 1;
206 Eina_Bool context_menu : 1;
207 Eina_Bool cur_changed : 1;
208 Eina_Bool single_line : 1;
209 Eina_Bool can_write : 1;
210 Eina_Bool auto_save : 1;
211 Eina_Bool password : 1;
212 Eina_Bool editable : 1;
213 Eina_Bool disabled : 1;
214 Eina_Bool h_bounce : 1;
215 Eina_Bool v_bounce : 1;
216 Eina_Bool has_text : 1;
217 Eina_Bool use_down : 1;
218 Eina_Bool sel_mode : 1;
219 Eina_Bool changed : 1;
220 Eina_Bool scroll : 1;
223 typedef struct _Elm_Entry_Context_Menu_Item Elm_Entry_Context_Menu_Item;
224 typedef struct _Elm_Entry_Item_Provider Elm_Entry_Item_Provider;
225 typedef struct _Elm_Entry_Markup_Filter Elm_Entry_Markup_Filter;
227 struct _Elm_Entry_Context_Menu_Item
231 const char *icon_file;
232 const char *icon_group;
233 Elm_Icon_Type icon_type;
238 struct _Elm_Entry_Item_Provider
240 Evas_Object *(*func)(void *data, Evas_Object * entry, const char *item);
244 struct _Elm_Entry_Markup_Filter
246 Elm_Entry_Filter_Cb func;
250 typedef enum _Length_Unit
261 EAPI extern const char ELM_ENTRY_SMART_NAME[];
262 EAPI const Elm_Entry_Smart_Class *elm_entry_smart_class_get(void);
264 #define ELM_ENTRY_DATA_GET(o, sd) \
265 Elm_Entry_Smart_Data * sd = evas_object_smart_data_get(o)
267 #define ELM_ENTRY_DATA_GET_OR_RETURN(o, ptr) \
268 ELM_ENTRY_DATA_GET(o, ptr); \
271 CRITICAL("No widget data for object %p (%s)", \
272 o, evas_object_type_get(o)); \
276 #define ELM_ENTRY_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
277 ELM_ENTRY_DATA_GET(o, ptr); \
280 CRITICAL("No widget data for object %p (%s)", \
281 o, evas_object_type_get(o)); \
285 #define ELM_ENTRY_CHECK(obj) \
286 if (!obj || !elm_widget_type_check \
287 ((obj), ELM_ENTRY_SMART_NAME, __func__)) \
293 typedef enum _Elm_Entry_Magnifier_Type
295 _ENTRY_MAGNIFIER_FIXEDSIZE = 0,
296 _ENTRY_MAGNIFIER_FILLWIDTH,
297 _ENTRY_MAGNIFIER_CIRCULAR,
298 } Elm_Entry_Magnifier_Type;