src/lib/ecore_imf/Ecore_IMF.h

   1 #ifndef _ECORE_IMF_H
   2 #define _ECORE_IMF_H
   3
   4 #include <Eina.h>
   5
   6 #ifdef EAPI
   7 # undef EAPI
   8 #endif
   9
  10 #ifdef _WIN32
  11 # ifdef EFL_ECORE_IMF_BUILD
  12 #  ifdef DLL_EXPORT
  13 #   define EAPI __declspec(dllexport)
  14 #  else
  15 #   define EAPI
  16 #  endif /* ! DLL_EXPORT */
  17 # else
  18 #  define EAPI __declspec(dllimport)
  19 # endif /* ! EFL_ECORE_IMF_BUILD */
  20 #else
  21 # ifdef __GNUC__
  22 #  if __GNUC__ >= 4
  23 #   define EAPI __attribute__ ((visibility("default")))
  24 #  else
  25 #   define EAPI
  26 #  endif
  27 # else
  28 #  define EAPI
  29 # endif
  30 #endif /* ! _WIN32 */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /**
  37  * @addtogroup Ecore_IMF_Context_Group
  38  *
  39  * @{
  40  */
  41
  42 /* Events sent by the Input Method */
  43 typedef struct _Ecore_IMF_Event_Preedit_Start      Ecore_IMF_Event_Preedit_Start;
  44 typedef struct _Ecore_IMF_Event_Preedit_End        Ecore_IMF_Event_Preedit_End;
  45 typedef struct _Ecore_IMF_Event_Preedit_Changed    Ecore_IMF_Event_Preedit_Changed;
  46 typedef struct _Ecore_IMF_Event_Commit             Ecore_IMF_Event_Commit;
  47 typedef struct _Ecore_IMF_Event_Delete_Surrounding Ecore_IMF_Event_Delete_Surrounding;
  48
  49 /* Events to filter */
  50 typedef struct _Ecore_IMF_Event_Mouse_Down         Ecore_IMF_Event_Mouse_Down;
  51 typedef struct _Ecore_IMF_Event_Mouse_Up           Ecore_IMF_Event_Mouse_Up;
  52 typedef struct _Ecore_IMF_Event_Mouse_In           Ecore_IMF_Event_Mouse_In;
  53 typedef struct _Ecore_IMF_Event_Mouse_Out          Ecore_IMF_Event_Mouse_Out;
  54 typedef struct _Ecore_IMF_Event_Mouse_Move         Ecore_IMF_Event_Mouse_Move;
  55 typedef struct _Ecore_IMF_Event_Mouse_Wheel        Ecore_IMF_Event_Mouse_Wheel;
  56 typedef struct _Ecore_IMF_Event_Key_Down           Ecore_IMF_Event_Key_Down;
  57 typedef struct _Ecore_IMF_Event_Key_Up             Ecore_IMF_Event_Key_Up;
  58 typedef union  _Ecore_IMF_Event                    Ecore_IMF_Event;
  59
  60 typedef struct _Ecore_IMF_Context                  Ecore_IMF_Context;                  /**< An Input Method Context */
  61 typedef struct _Ecore_IMF_Context_Class            Ecore_IMF_Context_Class;            /**< An Input Method Context class */
  62 typedef struct _Ecore_IMF_Context_Info             Ecore_IMF_Context_Info;             /**< An Input Method Context info */
  63
  64 /* Preedit attribute info */
  65 typedef struct _Ecore_IMF_Preedit_Attr             Ecore_IMF_Preedit_Attr;
  66
  67 EAPI extern int ECORE_IMF_EVENT_PREEDIT_START;
  68 EAPI extern int ECORE_IMF_EVENT_PREEDIT_END;
  69 EAPI extern int ECORE_IMF_EVENT_PREEDIT_CHANGED;
  70 EAPI extern int ECORE_IMF_EVENT_COMMIT;
  71 EAPI extern int ECORE_IMF_EVENT_DELETE_SURROUNDING;
  72
  73 typedef void (*Ecore_IMF_Event_Cb) (void *data, Ecore_IMF_Context *ctx, void *event_info);
  74
  75 /**
  76  * @typedef Ecore_IMF_Callback_Type
  77  *
  78  * Ecore IMF Event callback types.
  79  *
  80  * @see ecore_imf_context_event_callback_add()
  81  */
  82 typedef enum
  83 {
  84    ECORE_IMF_CALLBACK_PREEDIT_START,      /**< "PREEDIT_START" is called when a new preediting sequence starts. */
  85    ECORE_IMF_CALLBACK_PREEDIT_END,        /**< "PREEDIT_END" is called when a preediting sequence has been completed or canceled. */
  86    ECORE_IMF_CALLBACK_PREEDIT_CHANGED,    /**< "PREEDIT_CHANGED" is called whenever the preedit sequence currently being entered has changed. */
  87    ECORE_IMF_CALLBACK_COMMIT,             /**< "COMMIT" is called when a complete input sequence has been entered by the user */
  88    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 */
  89 } Ecore_IMF_Callback_Type;
  90
  91 /**
  92  * @typedef Ecore_IMF_Event_Type
  93  *
  94  * Ecore IMF event types.
  95  *
  96  * @see ecore_imf_context_filter_event()
  97  */
  98 typedef enum
  99 {
 100    ECORE_IMF_EVENT_MOUSE_DOWN,  /**< Mouse Down event */
 101    ECORE_IMF_EVENT_MOUSE_UP,    /**< Mouse Up event */
 102    ECORE_IMF_EVENT_MOUSE_IN,    /**< Mouse In event */
 103    ECORE_IMF_EVENT_MOUSE_OUT,   /**< Mouse Out event */
 104    ECORE_IMF_EVENT_MOUSE_MOVE,  /**< Mouse Move event */
 105    ECORE_IMF_EVENT_MOUSE_WHEEL, /**< Mouse Wheel event */
 106    ECORE_IMF_EVENT_KEY_DOWN,    /**< Key Down event */
 107    ECORE_IMF_EVENT_KEY_UP       /**< Key Up event */
 108 } Ecore_IMF_Event_Type;
 109 /**
 110  * @typedef Ecore_IMF_Keyboard_Modifiers
 111  * Type for Ecore_IMF keyboard modifiers
 112  */
 113 typedef enum
 114 {
 115    ECORE_IMF_KEYBOARD_MODIFIER_NONE  = 0,      /**< No active modifiers */
 116    ECORE_IMF_KEYBOARD_MODIFIER_CTRL  = 1 << 0, /**< "Control" is pressed */
 117    ECORE_IMF_KEYBOARD_MODIFIER_ALT   = 1 << 1, /**< "Alt" is pressed */
 118    ECORE_IMF_KEYBOARD_MODIFIER_SHIFT = 1 << 2, /**< "Shift" is pressed */
 119    ECORE_IMF_KEYBOARD_MODIFIER_WIN   = 1 << 3, /**< "Win" (between "Ctrl" and "Alt") is pressed */
 120    ECORE_IMF_KEYBOARD_MODIFIER_MODE  = 1 << 4  /**< "AltGr" is pressed @since 1.3 */
 121 } Ecore_IMF_Keyboard_Modifiers;
 122
 123 /**
 124  * @typedef Ecore_IMF_Keyboard_Locks
 125  * Type for Ecore_IMF keyboard locks
 126  */
 127 typedef enum
 128 {
 129    ECORE_IMF_KEYBOARD_LOCK_NONE      = 0,      /**< No locks are active */
 130    ECORE_IMF_KEYBOARD_LOCK_NUM       = 1 << 0, /**< "Num" lock is active */
 131    ECORE_IMF_KEYBOARD_LOCK_CAPS      = 1 << 1, /**< "Caps" lock is active */
 132    ECORE_IMF_KEYBOARD_LOCK_SCROLL    = 1 << 2  /**< "Scroll" lock is active */
 133 } Ecore_IMF_Keyboard_Locks;
 134 /**
 135  * @typedef Ecore_IMF_Mouse_Flags
 136  * Type for Ecore_IMF mouse flags
 137  */
 138 typedef enum
 139 {
 140    ECORE_IMF_MOUSE_NONE              = 0,      /**< A single click */
 141    ECORE_IMF_MOUSE_DOUBLE_CLICK      = 1 << 0, /**< A double click */
 142    ECORE_IMF_MOUSE_TRIPLE_CLICK      = 1 << 1  /**< A triple click */
 143 } Ecore_IMF_Mouse_Flags;
 144
 145 typedef enum
 146 {
 147    ECORE_IMF_INPUT_MODE_ALPHA        = 1 << 0,
 148    ECORE_IMF_INPUT_MODE_NUMERIC      = 1 << 1,
 149    ECORE_IMF_INPUT_MODE_SPECIAL      = 1 << 2,
 150    ECORE_IMF_INPUT_MODE_HEXA         = 1 << 3,
 151    ECORE_IMF_INPUT_MODE_TELE         = 1 << 4,
 152    ECORE_IMF_INPUT_MODE_FULL         = (ECORE_IMF_INPUT_MODE_ALPHA | ECORE_IMF_INPUT_MODE_NUMERIC | ECORE_IMF_INPUT_MODE_SPECIAL),
 153    ECORE_IMF_INPUT_MODE_INVISIBLE    = 1 << 29,
 154    ECORE_IMF_INPUT_MODE_AUTOCAP      = 1 << 30
 155 } Ecore_IMF_Input_Mode;
 156
 157 /**
 158  * @typedef Ecore_IMF_Preedit_Type
 159  *
 160  * Ecore IMF Preedit style types
 161  *
 162  * @see ecore_imf_context_preedit_string_with_attributes_get()
 163  */
 164 typedef enum
 165 {
 166    ECORE_IMF_PREEDIT_TYPE_NONE, /**< None style */
 167    ECORE_IMF_PREEDIT_TYPE_SUB1, /**< Substring style 1 */
 168    ECORE_IMF_PREEDIT_TYPE_SUB2, /**< Substring style 2 */
 169    ECORE_IMF_PREEDIT_TYPE_SUB3  /**< Substring style 3 */
 170 } Ecore_IMF_Preedit_Type;
 171
 172 /**
 173  * @typedef Ecore_IMF_Autocapital_Type
 174  *
 175  * Autocapitalization Types.
 176  *
 177  * @see ecore_imf_context_autocapital_type_set()
 178  */
 179 typedef enum
 180 {
 181    ECORE_IMF_AUTOCAPITAL_TYPE_NONE,         /**< No auto-capitalization when typing */
 182    ECORE_IMF_AUTOCAPITAL_TYPE_WORD,         /**< Autocapitalize each word typed */
 183    ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE,     /**< Autocapitalize the start of each sentence */
 184    ECORE_IMF_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
 185 } Ecore_IMF_Autocapital_Type;
 186
 187 /**
 188  * @typedef Ecore_IMF_Input_Panel_Layout
 189  *
 190  * Input panel (virtual keyboard) layout types.
 191  *
 192  * @see ecore_imf_context_input_panel_layout_set()
 193  */
 194 typedef enum
 195 {
 196    ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
 197    ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
 198    ECORE_IMF_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
 199    ECORE_IMF_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
 200    ECORE_IMF_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
 201    ECORE_IMF_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
 202    ECORE_IMF_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
 203    ECORE_IMF_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
 204    ECORE_IMF_INPUT_PANEL_LAYOUT_INVALID,         /**< Never use this */
 205    ECORE_IMF_INPUT_PANEL_LAYOUT_HEX,             /**< Hexadecimal layout @since 1.2 */
 206    ECORE_IMF_INPUT_PANEL_LAYOUT_TERMINAL,        /**< Command-line terminal layout @since 1.2 */
 207    ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD         /**< Like normal, but no auto-correct, no auto-capitalization etc. @since 1.2 */
 208 } Ecore_IMF_Input_Panel_Layout;
 209
 210 /**
 211  * @typedef Ecore_IMF_Input_Panel_Lang
 212  *
 213  * Input panel (virtual keyboard) language modes.
 214  *
 215  * @see ecore_imf_context_input_panel_language_set()
 216  */
 217 typedef enum
 218 {
 219    ECORE_IMF_INPUT_PANEL_LANG_AUTOMATIC,    /**< Automatic @since 1.2 */
 220    ECORE_IMF_INPUT_PANEL_LANG_ALPHABET      /**< Alphabet @since 1.2 */
 221 } Ecore_IMF_Input_Panel_Lang;
 222
 223 /**
 224  * @typedef Ecore_IMF_Input_Panel_Return_Key_Type
 225  *
 226  * "Return" Key types on the input panel (virtual keyboard).
 227  *
 228  * @see ecore_imf_context_input_panel_return_key_type_set()
 229  */
 230 typedef enum
 231 {
 232    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default @since 1.2 */
 233    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DONE,    /**< Done @since 1.2 */
 234    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_GO,      /**< Go @since 1.2 */
 235    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_JOIN,    /**< Join @since 1.2 */
 236    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN,   /**< Login @since 1.2 */
 237    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_NEXT,    /**< Next @since 1.2 */
 238    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH,  /**< Search or magnifier icon @since 1.2 */
 239    ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEND     /**< Send @since 1.2 */
 240 } Ecore_IMF_Input_Panel_Return_Key_Type;
 241
 242 struct _Ecore_IMF_Event_Preedit_Start
 243 {
 244    Ecore_IMF_Context *ctx;
 245 };
 246
 247 struct _Ecore_IMF_Event_Preedit_End
 248 {
 249    Ecore_IMF_Context *ctx;
 250 };
 251
 252 struct _Ecore_IMF_Event_Preedit_Changed
 253 {
 254    Ecore_IMF_Context *ctx;
 255 };
 256
 257 struct _Ecore_IMF_Event_Commit
 258 {
 259    Ecore_IMF_Context *ctx;
 260    char              *str;
 261 };
 262
 263 struct _Ecore_IMF_Event_Delete_Surrounding
 264 {
 265    Ecore_IMF_Context *ctx;
 266    int                offset;
 267    int                n_chars;
 268 };
 269
 270 struct _Ecore_IMF_Event_Mouse_Down
 271 {
 272    int button;                             /**< The button which has been pressed */
 273    struct {
 274       int x, y;
 275    } output;
 276    struct {
 277       int x, y;
 278    } canvas;
 279    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 280    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 281    Ecore_IMF_Mouse_Flags        flags;     /**< The flags corresponding the mouse click (single, double or triple click) */
 282    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 283 };
 284
 285 struct _Ecore_IMF_Event_Mouse_Up
 286 {
 287    int button;                             /**< The button which has been pressed */
 288    struct {
 289       int x, y;
 290    } output;
 291    struct {
 292       int x, y;
 293    } canvas;
 294    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 295    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 296    Ecore_IMF_Mouse_Flags        flags;     /**< The flags corresponding the mouse click (single, double or triple click) */
 297    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 298 };
 299
 300 struct _Ecore_IMF_Event_Mouse_In
 301 {
 302    int buttons;
 303    struct {
 304       int x, y;
 305    } output;
 306    struct {
 307       int x, y;
 308    } canvas;
 309    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 310    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 311    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 312 };
 313
 314 struct _Ecore_IMF_Event_Mouse_Out
 315 {
 316    int buttons;
 317    struct {
 318       int x, y;
 319    } output;
 320    struct {
 321       int x, y;
 322    } canvas;
 323    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 324    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 325    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 326 };
 327
 328 struct _Ecore_IMF_Event_Mouse_Move
 329 {
 330    int buttons;
 331    struct {
 332       struct {
 333          int x, y;
 334       } output;
 335       struct {
 336          int x, y;
 337       } canvas;
 338    } cur, prev;
 339    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 340    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 341    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 342 };
 343
 344 struct _Ecore_IMF_Event_Mouse_Wheel
 345 {
 346    int direction;                         /* 0 = default up/down wheel */
 347    int z;                                 /* ...,-2,-1 = down, 1,2,... = up */
 348    struct {
 349       int x, y;
 350    } output;
 351    struct {
 352       int x, y;
 353    } canvas;
 354    Ecore_IMF_Keyboard_Modifiers modifiers; /**< The keyboard modifiers active when the event has been emitted */
 355    Ecore_IMF_Keyboard_Locks     locks;     /**< The keyboard locks active when the event has been emitted */
 356    unsigned int                 timestamp; /**< The timestamp when the event occurred */
 357 };
 358
 359 struct _Ecore_IMF_Event_Key_Down
 360 {
 361    const char                   *keyname;   /**< The string name of the key pressed */
 362    Ecore_IMF_Keyboard_Modifiers  modifiers; /**< The keyboard modifiers active when the event has been emitted */
 363    Ecore_IMF_Keyboard_Locks      locks;     /**< The keyboard locks active when the event has been emitted */
 364    const char                   *key;       /**< The logical key : (eg shift+1 == exclamation) */
 365    const char                   *string;    /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
 366    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 */
 367    unsigned int                  timestamp; /**< The timestamp when the event occurred */
 368 };
 369
 370 struct _Ecore_IMF_Event_Key_Up
 371 {
 372    const char                   *keyname;   /**< The string name of the key pressed */
 373    Ecore_IMF_Keyboard_Modifiers  modifiers; /**< The keyboard modifiers active when the event has been emitted */
 374    Ecore_IMF_Keyboard_Locks      locks;     /**< The keyboard locks active when the event has been emitted */
 375    const char                   *key;       /**< The logical key : (eg shift+1 == exclamation) */
 376    const char                   *string;    /**< A UTF8 string if this keystroke has produced a visible string to be ADDED */
 377    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 */
 378    unsigned int                  timestamp; /**< The timestamp when the event occurred */
 379 };
 380
 381 union _Ecore_IMF_Event
 382 {
 383    Ecore_IMF_Event_Mouse_Down  mouse_down;
 384    Ecore_IMF_Event_Mouse_Up    mouse_up;
 385    Ecore_IMF_Event_Mouse_In    mouse_in;
 386    Ecore_IMF_Event_Mouse_Out   mouse_out;
 387    Ecore_IMF_Event_Mouse_Move  mouse_move;
 388    Ecore_IMF_Event_Mouse_Wheel mouse_wheel;
 389    Ecore_IMF_Event_Key_Down    key_down;
 390    Ecore_IMF_Event_Key_Up      key_up;
 391 };
 392
 393 struct _Ecore_IMF_Preedit_Attr
 394 {
 395    Ecore_IMF_Preedit_Type preedit_type; /**< preedit style type */
 396    unsigned int start_index;            /**< start index of the range (in bytes) */
 397    unsigned int end_index;              /**< end index of the range (in bytes) */
 398 };
 399
 400 struct _Ecore_IMF_Context_Class
 401 {
 402    void (*add)                 (Ecore_IMF_Context *ctx);
 403    void (*del)                 (Ecore_IMF_Context *ctx);
 404    void (*client_window_set)   (Ecore_IMF_Context *ctx, void *window);
 405    void (*client_canvas_set)   (Ecore_IMF_Context *ctx, void *canvas);
 406    void (*show)                (Ecore_IMF_Context *ctx);
 407    void (*hide)                (Ecore_IMF_Context *ctx);
 408    void (*preedit_string_get)  (Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
 409    void (*focus_in)            (Ecore_IMF_Context *ctx);
 410    void (*focus_out)           (Ecore_IMF_Context *ctx);
 411    void (*reset)               (Ecore_IMF_Context *ctx);
 412    void (*cursor_position_set) (Ecore_IMF_Context *ctx, int cursor_pos);
 413    void (*use_preedit_set)     (Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
 414    void (*input_mode_set)      (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
 415    Eina_Bool (*filter_event)   (Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);
 416    void (*preedit_string_with_attributes_get) (Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
 417    void (*prediction_allow_set)(Ecore_IMF_Context *ctx, Eina_Bool prediction);
 418    void (*autocapital_type_set)(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
 419    void (*control_panel_show)   (Ecore_IMF_Context *ctx);
 420    void (*control_panel_hide)   (Ecore_IMF_Context *ctx);
 421    void (*input_panel_layout_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
 422    Ecore_IMF_Input_Panel_Layout (*input_panel_layout_get) (Ecore_IMF_Context *ctx);
 423    void (*input_panel_language_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
 424    Ecore_IMF_Input_Panel_Lang (*input_panel_language_get) (Ecore_IMF_Context *ctx);
 425    void (*cursor_location_set) (Ecore_IMF_Context *ctx, int x, int y, int w, int h);
 426    void (*input_panel_imdata_set)(Ecore_IMF_Context *ctx, const void* data, int len);
 427    void (*input_panel_imdata_get)(Ecore_IMF_Context *ctx, void* data, int *len);
 428    void (*input_panel_return_key_type_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
 429    void (*input_panel_return_key_disabled_set) (Ecore_IMF_Context *ctx, Eina_Bool disabled);
 430    void (*input_panel_caps_lock_mode_set) (Ecore_IMF_Context *ctx, Eina_Bool mode);
 431 };
 432
 433 struct _Ecore_IMF_Context_Info
 434 {
 435    const char *id;              /* ID */
 436    const char *description;     /* Human readable description */
 437    const char *default_locales; /* Languages for which this context is the default, separated by : */
 438    const char *canvas_type;     /* The canvas type used by the input method. Eg.: evas */
 439    int         canvas_required; /* Whether the canvas usage is required for this input method */
 440 };
 441
 442 /**
 443  * @}
 444  */
 445
 446 EAPI int                           ecore_imf_init(void);
 447 EAPI int                           ecore_imf_shutdown(void);
 448
 449 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));
 450
 451 EAPI Eina_List                    *ecore_imf_context_available_ids_get(void);
 452 EAPI Eina_List                    *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type);
 453 EAPI const char                   *ecore_imf_context_default_id_get(void);
 454 EAPI const char                   *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type);
 455 EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id);
 456
 457 EAPI Ecore_IMF_Context            *ecore_imf_context_add(const char *id);
 458 EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx);
 459 EAPI void                          ecore_imf_context_del(Ecore_IMF_Context *ctx);
 460 EAPI void                          ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window);
 461 EAPI void                         *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx);
 462 EAPI void                          ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas);
 463 EAPI void                         *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx);
 464 EAPI void                          ecore_imf_context_show(Ecore_IMF_Context *ctx);
 465 EAPI void                          ecore_imf_context_hide(Ecore_IMF_Context *ctx);
 466 EAPI void                          ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
 467 EAPI void                          ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
 468 EAPI void                          ecore_imf_context_focus_in(Ecore_IMF_Context *ctx);
 469 EAPI void                          ecore_imf_context_focus_out(Ecore_IMF_Context *ctx);
 470 EAPI void                          ecore_imf_context_reset(Ecore_IMF_Context *ctx);
 471 EAPI void                          ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos);
 472 EAPI void                          ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h);
 473 EAPI void                          ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
 474 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);
 475 EAPI void                          ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
 476 EAPI Ecore_IMF_Input_Mode          ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx);
 477 EAPI Eina_Bool                     ecore_imf_context_filter_event(Ecore_IMF_Context *ctx, Ecore_IMF_Event_Type type, Ecore_IMF_Event *event);
 478
 479 /* plugin specific functions */
 480 EAPI Ecore_IMF_Context            *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc);
 481 EAPI void                          ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data);
 482 EAPI void                         *ecore_imf_context_data_get(Ecore_IMF_Context *ctx);
 483 EAPI Eina_Bool                     ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos);
 484 EAPI void                          ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx);
 485 EAPI void                          ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx);
 486 EAPI void                          ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx);
 487 EAPI void                          ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str);
 488 EAPI void                          ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars);
 489 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);
 490 EAPI void                         *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func);
 491 EAPI void                          ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info);
 492 EAPI void                          ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction);
 493 EAPI Eina_Bool                     ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx);
 494 EAPI void                          ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
 495 EAPI Ecore_IMF_Autocapital_Type    ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx);
 496
 497 EAPI void                          ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx);
 498 EAPI void                          ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx);
 499
 500 EAPI void                          ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx);
 501 EAPI void                          ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx);
 502 EAPI void                          ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
 503 EAPI Ecore_IMF_Input_Panel_Layout  ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx);
 504 EAPI void                          ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
 505 EAPI Ecore_IMF_Input_Panel_Lang    ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);
 506 EAPI void                          ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enable);
 507 EAPI Eina_Bool                     ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);
 508 EAPI void                          ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);
 509 EAPI void                          ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);
 510 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);
 511 EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);
 512 EAPI void                          ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);
 513 EAPI Eina_Bool                     ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);
 514 EAPI void                          ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);
 515 EAPI Eina_Bool                     ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);
 516
 517 /* The following entry points must be exported by each input method module
 518  */
 519
 520 /*
 521  * int                imf_module_init   (const Ecore_IMF_Context_Info **info);
 522  * void               imf_module_exit   (void);
 523  * Ecore_IMF_Context *imf_module_create (void);
 524  */
 525
 526 #ifdef __cplusplus
 527 }
 528 #endif
 529
 530 #endif