11 # ifdef EFL_ECORE_IMF_BUILD
13 # define EAPI __declspec(dllexport)
16 # endif /* ! DLL_EXPORT */
18 # define EAPI __declspec(dllimport)
19 # endif /* ! EFL_ECORE_IMF_BUILD */
23 # define EAPI __attribute__ ((visibility("default")))
37 * @addtogroup Ecore_IMF_Context_Group
41 /* ecore_imf_context_input_panel_event_callback_add() flag */
44 ECORE_IMF_INPUT_PANEL_STATE_EVENT, /**< called when the state of the input panel is changed. @since 1.7 */
45 ECORE_IMF_INPUT_PANEL_LANGUAGE_EVENT, /**< called when the language of the input panel is changed. @since 1.7 */
46 ECORE_IMF_INPUT_PANEL_SHIFT_MODE_EVENT, /**< called when the shift key state of the input panel is changed @since 1.7 */
47 ECORE_IMF_INPUT_PANEL_GEOMETRY_EVENT, /**< called when the size of the input panel is changed. @since 1.7 */
48 ECORE_IMF_CANDIDATE_PANEL_STATE_EVENT, /**< called when the state of the candidate word panel is changed. @since 1.7 */
49 ECORE_IMF_CANDIDATE_PANEL_GEOMETRY_EVENT /**< called when the size of the candidate word panel is changed. @since 1.7 */
50 } Ecore_IMF_Input_Panel_Event;
54 ECORE_IMF_INPUT_PANEL_STATE_SHOW, /**< Notification after the display of the input panel @since 1.7 */
55 ECORE_IMF_INPUT_PANEL_STATE_HIDE, /**< Notification prior to the dismissal of the input panel @since 1.7 */
56 ECORE_IMF_INPUT_PANEL_STATE_WILL_SHOW /**< Notification prior to the display of the input panel @since 1.7 */
57 } Ecore_IMF_Input_Panel_State;
61 ECORE_IMF_INPUT_PANEL_SHIFT_MODE_OFF, /**< @since 1.7 */
62 ECORE_IMF_INPUT_PANEL_SHIFT_MODE_ON /**< @since 1.7 */
63 } Ecore_IMF_Input_Panel_Shift_Mode;
67 ECORE_IMF_CANDIDATE_PANEL_SHOW, /**< Notification after the display of the candidate word panel @since 1.7 */
68 ECORE_IMF_CANDIDATE_PANEL_HIDE /**< Notification prior to the dismissal of the candidate word panel @since 1.7 */
69 } Ecore_IMF_Candidate_Panel_State;
71 /* Events sent by the Input Method */
72 typedef struct _Ecore_IMF_Event_Preedit_Start Ecore_IMF_Event_Preedit_Start;
73 typedef struct _Ecore_IMF_Event_Preedit_End Ecore_IMF_Event_Preedit_End;
74 typedef struct _Ecore_IMF_Event_Preedit_Changed Ecore_IMF_Event_Preedit_Changed;
75 typedef struct _Ecore_IMF_Event_Commit Ecore_IMF_Event_Commit;
76 typedef struct _Ecore_IMF_Event_Delete_Surrounding Ecore_IMF_Event_Delete_Surrounding;
78 /* Events to filter */
79 typedef struct _Ecore_IMF_Event_Mouse_Down Ecore_IMF_Event_Mouse_Down;
80 typedef struct _Ecore_IMF_Event_Mouse_Up Ecore_IMF_Event_Mouse_Up;
81 typedef struct _Ecore_IMF_Event_Mouse_In Ecore_IMF_Event_Mouse_In;
82 typedef struct _Ecore_IMF_Event_Mouse_Out Ecore_IMF_Event_Mouse_Out;
83 typedef struct _Ecore_IMF_Event_Mouse_Move Ecore_IMF_Event_Mouse_Move;
84 typedef struct _Ecore_IMF_Event_Mouse_Wheel Ecore_IMF_Event_Mouse_Wheel;
85 typedef struct _Ecore_IMF_Event_Key_Down Ecore_IMF_Event_Key_Down;
86 typedef struct _Ecore_IMF_Event_Key_Up Ecore_IMF_Event_Key_Up;
87 typedef union _Ecore_IMF_Event Ecore_IMF_Event;
89 typedef struct _Ecore_IMF_Context Ecore_IMF_Context; /**< An Input Method Context */
90 typedef struct _Ecore_IMF_Context_Class Ecore_IMF_Context_Class; /**< An Input Method Context class */
91 typedef struct _Ecore_IMF_Context_Info Ecore_IMF_Context_Info; /**< An Input Method Context info */
93 /* Preedit attribute info */
94 typedef struct _Ecore_IMF_Preedit_Attr Ecore_IMF_Preedit_Attr;
96 EAPI extern int ECORE_IMF_EVENT_PREEDIT_START;
97 EAPI extern int ECORE_IMF_EVENT_PREEDIT_END;
98 EAPI extern int ECORE_IMF_EVENT_PREEDIT_CHANGED;
99 EAPI extern int ECORE_IMF_EVENT_COMMIT;
100 EAPI extern int ECORE_IMF_EVENT_DELETE_SURROUNDING;
102 typedef void (*Ecore_IMF_Event_Cb) (void *data, Ecore_IMF_Context *ctx, void *event_info);
105 * @typedef Ecore_IMF_Callback_Type
107 * Ecore IMF Event callback types.
109 * @see ecore_imf_context_event_callback_add()
113 ECORE_IMF_CALLBACK_PREEDIT_START, /**< "PREEDIT_START" is called when a new preediting sequence starts. @since 1.2 */
114 ECORE_IMF_CALLBACK_PREEDIT_END, /**< "PREEDIT_END" is called when a preediting sequence has been completed or canceled. @since 1.2 */
115 ECORE_IMF_CALLBACK_PREEDIT_CHANGED, /**< "PREEDIT_CHANGED" is called whenever the preedit sequence currently being entered has changed. @since 1.2 */
116 ECORE_IMF_CALLBACK_COMMIT, /**< "COMMIT" is called when a complete input sequence has been entered by the user @since 1.2 */
117 ECORE_IMF_CALLBACK_DELETE_SURROUNDING /**< "DELETE_SURROUNDING" is called when the input method needs to delete all or part of the context surrounding the cursor @since 1.2 */
118 } Ecore_IMF_Callback_Type;
121 * @typedef Ecore_IMF_Event_Type
123 * Ecore IMF event types.
125 * @see ecore_imf_context_filter_event()
129 ECORE_IMF_EVENT_MOUSE_DOWN, /**< Mouse Down event */
130 ECORE_IMF_EVENT_MOUSE_UP, /**< Mouse Up event */
131 ECORE_IMF_EVENT_MOUSE_IN, /**< Mouse In event */
132 ECORE_IMF_EVENT_MOUSE_OUT, /**< Mouse Out event */
133 ECORE_IMF_EVENT_MOUSE_MOVE, /**< Mouse Move event */
134 ECORE_IMF_EVENT_MOUSE_WHEEL, /**< Mouse Wheel event */
135 ECORE_IMF_EVENT_KEY_DOWN, /**< Key Down event */
136 ECORE_IMF_EVENT_KEY_UP /**< Key Up event */
137 } Ecore_IMF_Event_Type;
139 * @typedef Ecore_IMF_Keyboard_Modifiers
140 * Type for Ecore_IMF keyboard modifiers
144 ECORE_IMF_KEYBOARD_MODIFIER_NONE = 0, /**< No active modifiers */
145 ECORE_IMF_KEYBOARD_MODIFIER_CTRL = 1 << 0, /**< "Control" is pressed */
146 ECORE_IMF_KEYBOARD_MODIFIER_ALT = 1 << 1, /**< "Alt" is pressed */
147 ECORE_IMF_KEYBOARD_MODIFIER_SHIFT = 1 << 2, /**< "Shift" is pressed */
148 ECORE_IMF_KEYBOARD_MODIFIER_WIN = 1 << 3, /**< "Win" (between "Ctrl" and "Alt") is pressed */
149 ECORE_IMF_KEYBOARD_MODIFIER_ALTGR = 1 << 4 /**< "AltGr" is pressed @since 1.7 */
150 } Ecore_IMF_Keyboard_Modifiers;
153 * @typedef Ecore_IMF_Keyboard_Locks
154 * Type for Ecore_IMF keyboard locks
158 ECORE_IMF_KEYBOARD_LOCK_NONE = 0, /**< No locks are active */
159 ECORE_IMF_KEYBOARD_LOCK_NUM = 1 << 0, /**< "Num" lock is active */
160 ECORE_IMF_KEYBOARD_LOCK_CAPS = 1 << 1, /**< "Caps" lock is active */
161 ECORE_IMF_KEYBOARD_LOCK_SCROLL = 1 << 2 /**< "Scroll" lock is active */
162 } Ecore_IMF_Keyboard_Locks;
165 * @typedef Ecore_IMF_Mouse_Flags
166 * Type for Ecore_IMF mouse flags
170 ECORE_IMF_MOUSE_NONE = 0, /**< A single click */
171 ECORE_IMF_MOUSE_DOUBLE_CLICK = 1 << 0, /**< A double click */
172 ECORE_IMF_MOUSE_TRIPLE_CLICK = 1 << 1 /**< A triple click */
173 } Ecore_IMF_Mouse_Flags;
177 ECORE_IMF_INPUT_MODE_ALPHA = 1 << 0,
178 ECORE_IMF_INPUT_MODE_NUMERIC = 1 << 1,
179 ECORE_IMF_INPUT_MODE_SPECIAL = 1 << 2,
180 ECORE_IMF_INPUT_MODE_HEXA = 1 << 3,
181 ECORE_IMF_INPUT_MODE_TELE = 1 << 4,
182 ECORE_IMF_INPUT_MODE_FULL = (ECORE_IMF_INPUT_MODE_ALPHA | ECORE_IMF_INPUT_MODE_NUMERIC | ECORE_IMF_INPUT_MODE_SPECIAL),
183 ECORE_IMF_INPUT_MODE_INVISIBLE = 1 << 29,
184 ECORE_IMF_INPUT_MODE_AUTOCAP = 1 << 30
185 } Ecore_IMF_Input_Mode;
188 * @typedef Ecore_IMF_Preedit_Type
190 * Ecore IMF Preedit style types
192 * @see ecore_imf_context_preedit_string_with_attributes_get()
196 ECORE_IMF_PREEDIT_TYPE_NONE, /**< None style @since 1.1 */
197 ECORE_IMF_PREEDIT_TYPE_SUB1, /**< Substring style 1 @since 1.1 */
198 ECORE_IMF_PREEDIT_TYPE_SUB2, /**< Substring style 2 @since 1.1 */
199 ECORE_IMF_PREEDIT_TYPE_SUB3, /**< Substring style 3 @since 1.1 */
200 ECORE_IMF_PREEDIT_TYPE_SUB4, /**< Substring style 4 @since 1.8 */
201 ECORE_IMF_PREEDIT_TYPE_SUB5, /**< Substring style 5 @since 1.8 */
202 ECORE_IMF_PREEDIT_TYPE_SUB6, /**< Substring style 6 @since 1.8 */
203 ECORE_IMF_PREEDIT_TYPE_SUB7 /**< Substring style 7 @since 1.8 */
204 } Ecore_IMF_Preedit_Type;
207 * @typedef Ecore_IMF_Autocapital_Type
209 * Autocapitalization Types.
211 * @see ecore_imf_context_autocapital_type_set()
215 ECORE_IMF_AUTOCAPITAL_TYPE_NONE, /**< No auto-capitalization when typing @since 1.1 */
216 ECORE_IMF_AUTOCAPITAL_TYPE_WORD, /**< Autocapitalize each word typed @since 1.1 */
217 ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE, /**< Autocapitalize the start of each sentence @since 1.1 */
218 ECORE_IMF_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters @since 1.1 */
219 } Ecore_IMF_Autocapital_Type;
222 * @typedef Ecore_IMF_Input_Panel_Layout
224 * Input panel (virtual keyboard) layout types.
226 * @see ecore_imf_context_input_panel_layout_set()
230 ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL, /**< Default layout */
231 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBER, /**< Number layout */
232 ECORE_IMF_INPUT_PANEL_LAYOUT_EMAIL, /**< Email layout */
233 ECORE_IMF_INPUT_PANEL_LAYOUT_URL, /**< URL layout */
234 ECORE_IMF_INPUT_PANEL_LAYOUT_PHONENUMBER, /**< Phone Number layout */
235 ECORE_IMF_INPUT_PANEL_LAYOUT_IP, /**< IP layout */
236 ECORE_IMF_INPUT_PANEL_LAYOUT_MONTH, /**< Month layout */
237 ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY, /**< Number Only layout */
238 ECORE_IMF_INPUT_PANEL_LAYOUT_INVALID, /**< Never use this */
239 ECORE_IMF_INPUT_PANEL_LAYOUT_HEX, /**< Hexadecimal layout @since 1.2 */
240 ECORE_IMF_INPUT_PANEL_LAYOUT_TERMINAL, /**< Command-line terminal layout including esc, alt, ctrl key, so on (no auto-correct, no auto-capitalization) @since 1.2 */
241 ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD /**< Like normal, but no auto-correct, no auto-capitalization etc. @since 1.2 */
242 } Ecore_IMF_Input_Panel_Layout;
245 * @typedef Ecore_IMF_Input_Panel_Lang
247 * Input panel (virtual keyboard) language modes.
249 * @see ecore_imf_context_input_panel_language_set()
253 ECORE_IMF_INPUT_PANEL_LANG_AUTOMATIC, /**< Automatic @since 1.2 */
254 ECORE_IMF_INPUT_PANEL_LANG_ALPHABET /**< Alphabet @since 1.2 */
255 } Ecore_IMF_Input_Panel_Lang;
258 * @typedef Ecore_IMF_Input_Panel_Return_Key_Type
260 * "Return" Key types on the input panel (virtual keyboard).
262 * @see ecore_imf_context_input_panel_return_key_type_set()
266 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default @since 1.2 */
267 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DONE, /**< Done @since 1.2 */
268 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_GO, /**< Go @since 1.2 */
269 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_JOIN, /**< Join @since 1.2 */
270 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN, /**< Login @since 1.2 */
271 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_NEXT, /**< Next @since 1.2 */
272 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH, /**< Search or magnifier icon @since 1.2 */
273 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEND, /**< Send @since 1.2 */
274 ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SIGNIN /**< Sign-in @since 1.8 */
275 } Ecore_IMF_Input_Panel_Return_Key_Type;
277 struct _Ecore_IMF_Event_Preedit_Start
279 Ecore_IMF_Context *ctx;
282 struct _Ecore_IMF_Event_Preedit_End
284 Ecore_IMF_Context *ctx;
287 struct _Ecore_IMF_Event_Preedit_Changed
289 Ecore_IMF_Context *ctx;
292 struct _Ecore_IMF_Event_Commit
294 Ecore_IMF_Context *ctx;
298 struct _Ecore_IMF_Event_Delete_Surrounding
300 Ecore_IMF_Context *ctx;
305 struct _Ecore_IMF_Event_Mouse_Down
307 int button; /**< The button which has been pressed */
314 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
315 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
316 Ecore_IMF_Mouse_Flags flags; /**< The flags corresponding the mouse click (single, double or triple click) */
317 unsigned int timestamp; /**< The timestamp when the event occurred */
320 struct _Ecore_IMF_Event_Mouse_Up
322 int button; /**< The button which has been pressed */
329 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
330 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
331 Ecore_IMF_Mouse_Flags flags; /**< The flags corresponding the mouse click (single, double or triple click) */
332 unsigned int timestamp; /**< The timestamp when the event occurred */
335 struct _Ecore_IMF_Event_Mouse_In
344 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
345 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
346 unsigned int timestamp; /**< The timestamp when the event occurred */
349 struct _Ecore_IMF_Event_Mouse_Out
358 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
359 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
360 unsigned int timestamp; /**< The timestamp when the event occurred */
363 struct _Ecore_IMF_Event_Mouse_Move
374 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
375 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
376 unsigned int timestamp; /**< The timestamp when the event occurred */
379 struct _Ecore_IMF_Event_Mouse_Wheel
381 int direction; /* 0 = default up/down wheel */
382 int z; /* ...,-2,-1 = down, 1,2,... = up */
389 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
390 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
391 unsigned int timestamp; /**< The timestamp when the event occurred */
394 struct _Ecore_IMF_Event_Key_Down
396 const char *keyname; /**< The string name of the key pressed */
397 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
398 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
399 const char *key; /**< The logical key : (eg shift+1 == exclamation) */
400 const char *string; /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
401 const char *compose; /**< A UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one */
402 unsigned int timestamp; /**< The timestamp when the event occurred */
405 struct _Ecore_IMF_Event_Key_Up
407 const char *keyname; /**< The string name of the key pressed */
408 Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
409 Ecore_IMF_Keyboard_Locks locks; /**< The keyboard locks active when the event has been emitted */
410 const char *key; /**< The logical key : (eg shift+1 == exclamation) */
411 const char *string; /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
412 const char *compose; /**< A UTF8 string if this keystroke has modified a string in the middle of being composed - this string replaces the previous one */
413 unsigned int timestamp; /**< The timestamp when the event occurred */
416 union _Ecore_IMF_Event
418 Ecore_IMF_Event_Mouse_Down mouse_down;
419 Ecore_IMF_Event_Mouse_Up mouse_up;
420 Ecore_IMF_Event_Mouse_In mouse_in;
421 Ecore_IMF_Event_Mouse_Out mouse_out;
422 Ecore_IMF_Event_Mouse_Move mouse_move;
423 Ecore_IMF_Event_Mouse_Wheel mouse_wheel;
424 Ecore_IMF_Event_Key_Down key_down;
425 Ecore_IMF_Event_Key_Up key_up;
428 struct _Ecore_IMF_Preedit_Attr
430 Ecore_IMF_Preedit_Type preedit_type; /**< preedit style type */
431 unsigned int start_index; /**< start index of the range (in bytes) */
432 unsigned int end_index; /**< end index of the range (in bytes) */
435 struct _Ecore_IMF_Context_Class
437 void (*add) (Ecore_IMF_Context *ctx);
438 void (*del) (Ecore_IMF_Context *ctx);
439 void (*client_window_set) (Ecore_IMF_Context *ctx, void *window);
440 void (*client_canvas_set) (Ecore_IMF_Context *ctx, void *canvas);
441 void (*show) (Ecore_IMF_Context *ctx);
442 void (*hide) (Ecore_IMF_Context *ctx);
443 void (*preedit_string_get) (Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
444 void (*focus_in) (Ecore_IMF_Context *ctx);
445 void (*focus_out) (Ecore_IMF_Context *ctx);
446 void (*reset) (Ecore_IMF_Context *ctx);
447 void (*cursor_position_set) (Ecore_IMF_Context *ctx, int cursor_pos);
448 void (*use_preedit_set) (Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
449 void (*input_mode_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
450 Eina_Bool (*filter_event) (Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);
451 void (*preedit_string_with_attributes_get) (Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
452 void (*prediction_allow_set)(Ecore_IMF_Context *ctx, Eina_Bool prediction);
453 void (*autocapital_type_set)(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
454 void (*control_panel_show) (Ecore_IMF_Context *ctx);
455 void (*control_panel_hide) (Ecore_IMF_Context *ctx);
456 void (*input_panel_layout_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
457 Ecore_IMF_Input_Panel_Layout (*input_panel_layout_get) (Ecore_IMF_Context *ctx);
458 void (*input_panel_language_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
459 Ecore_IMF_Input_Panel_Lang (*input_panel_language_get) (Ecore_IMF_Context *ctx);
460 void (*cursor_location_set) (Ecore_IMF_Context *ctx, int x, int y, int w, int h);
461 void (*input_panel_imdata_set)(Ecore_IMF_Context *ctx, const void* data, int len);
462 void (*input_panel_imdata_get)(Ecore_IMF_Context *ctx, void* data, int *len);
463 void (*input_panel_return_key_type_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
464 void (*input_panel_return_key_disabled_set) (Ecore_IMF_Context *ctx, Eina_Bool disabled);
465 void (*input_panel_caps_lock_mode_set) (Ecore_IMF_Context *ctx, Eina_Bool mode);
466 void (*input_panel_geometry_get)(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
467 Ecore_IMF_Input_Panel_State (*input_panel_state_get) (Ecore_IMF_Context *ctx);
468 void (*input_panel_event_callback_add) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), void *data);
469 void (*input_panel_event_callback_del) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value));
470 void (*input_panel_language_locale_get) (Ecore_IMF_Context *ctx, char **lang);
471 void (*candidate_panel_geometry_get)(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
474 struct _Ecore_IMF_Context_Info
476 const char *id; /* ID */
477 const char *description; /* Human readable description */
478 const char *default_locales; /* Languages for which this context is the default, separated by : */
479 const char *canvas_type; /* The canvas type used by the input method. Eg.: evas */
480 int canvas_required; /* Whether the canvas usage is required for this input method */
487 EAPI int ecore_imf_init(void);
488 EAPI int ecore_imf_shutdown(void);
490 EAPI void ecore_imf_module_register(const Ecore_IMF_Context_Info *info, Ecore_IMF_Context *(*imf_module_create)(void), Ecore_IMF_Context *(*imf_module_exit)(void));
492 EAPI Eina_List *ecore_imf_context_available_ids_get(void);
493 EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type);
494 EAPI const char *ecore_imf_context_default_id_get(void);
495 EAPI const char *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type);
496 EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id);
498 EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id);
499 EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx);
500 EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx);
501 EAPI void ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window);
502 EAPI void *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx);
503 EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas);
504 EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx);
505 EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx);
506 EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx);
507 EAPI void ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
508 EAPI void ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
509 EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context *ctx);
510 EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context *ctx);
511 EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ctx);
512 EAPI void ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos);
513 EAPI void ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h);
514 EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
515 EAPI void ecore_imf_context_retrieve_surrounding_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text, int *cursor_pos), const void *data);
516 EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
517 EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx);
518 EAPI Eina_Bool ecore_imf_context_filter_event(Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);
520 /* plugin specific functions */
521 EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc);
522 EAPI void ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data);
523 EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx);
524 EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos);
525 EAPI void ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx);
526 EAPI void ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx);
527 EAPI void ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx);
528 EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str);
529 EAPI void ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars);
530 EAPI void ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data);
531 EAPI void *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func);
532 EAPI void ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info);
533 EAPI void ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction);
534 EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx);
535 EAPI void ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
536 EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx);
538 EAPI void ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx);
539 EAPI void ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx);
541 EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx);
542 EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx);
543 EAPI void ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
544 EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx);
545 EAPI void ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
546 EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);
547 EAPI void ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enable);
548 EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);
549 EAPI void ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);
550 EAPI void ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);
551 EAPI void ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
552 EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);
553 EAPI void ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);
554 EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);
555 EAPI void ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);
556 EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);
557 EAPI void ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
558 EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx);
559 EAPI void ecore_imf_context_input_panel_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value), const void *data);
560 EAPI void ecore_imf_context_input_panel_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, void (*func) (void *data, Ecore_IMF_Context *ctx, int value));
561 EAPI void ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang);
562 EAPI void ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
564 /* The following entry points must be exported by each input method module
568 * int imf_module_init (const Ecore_IMF_Context_Info **info);
569 * void imf_module_exit (void);
570 * Ecore_IMF_Context *imf_module_create (void);