1 files changed, 117 insertions, 26 deletions

diff --git a/libraries/ecore/src/lib/ecore_imf/Ecore_IMF.h b/libraries/ecore/src/lib/ecore_imf/Ecore_IMF.h
index adea35d..1757d79 100644
--- a/libraries/ecore/src/lib/ecore_imf/Ecore_IMF.h
+++ b/libraries/ecore/src/lib/ecore_imf/Ecore_IMF.h
@@ -33,6 +33,12 @@
 extern "C" {
 #endif
 
+/**
+ * @addtogroup Ecore_IMF_Context_Group
+ *
+ * @{
+ */
+
 /* Events sent by the Input Method */
 typedef struct _Ecore_IMF_Event_Preedit_Start      Ecore_IMF_Event_Preedit_Start;
 typedef struct _Ecore_IMF_Event_Preedit_End        Ecore_IMF_Event_Preedit_End;
@@ -66,25 +72,41 @@ EAPI extern int ECORE_IMF_EVENT_DELETE_SURROUNDING;
 
 typedef void (*Ecore_IMF_Event_Cb) (void *data, Ecore_IMF_Context *ctx, void *event_info);
 
+/**
+ * @enum _Ecore_IMF_Callback_Type
+ * @typedef Ecore_IMF_Callback_Type
+ *
+ * Ecore IMF Event callback types.
+ *
+ * @see ecore_imf_context_event_callback_add()
+ */
 typedef enum
 {
-    ECORE_IMF_CALLBACK_PREEDIT_START,
-    ECORE_IMF_CALLBACK_PREEDIT_END,
-    ECORE_IMF_CALLBACK_PREEDIT_CHANGED,
-    ECORE_IMF_CALLBACK_COMMIT,
-    ECORE_IMF_CALLBACK_DELETE_SURROUNDING
+   ECORE_IMF_CALLBACK_PREEDIT_START,      /**< "PREEDIT_START" is called when a new preediting sequence starts. */
+   ECORE_IMF_CALLBACK_PREEDIT_END,        /**< "PREEDIT_END" is called when a preediting sequence has been completed or canceled. */
+   ECORE_IMF_CALLBACK_PREEDIT_CHANGED,    /**< "PREEDIT_CHANGED" is called whenever the preedit sequence currently being entered has changed. */
+   ECORE_IMF_CALLBACK_COMMIT,             /**< "COMMIT" is called when a complete input sequence has been entered by the user */
+   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 */
 } Ecore_IMF_Callback_Type;
 
+/**
+ * @enum _Ecore_IMF_Event_Type
+ * @typedef Ecore_IMF_Event_Type
+ *
+ * Ecore IMF event types.
+ *
+ * @see ecore_imf_context_filter_event()
+ */
 typedef enum
 {
-   ECORE_IMF_EVENT_MOUSE_DOWN,
-   ECORE_IMF_EVENT_MOUSE_UP,
-   ECORE_IMF_EVENT_MOUSE_IN,
-   ECORE_IMF_EVENT_MOUSE_OUT,
-   ECORE_IMF_EVENT_MOUSE_MOVE,
-   ECORE_IMF_EVENT_MOUSE_WHEEL,
-   ECORE_IMF_EVENT_KEY_DOWN,
-   ECORE_IMF_EVENT_KEY_UP
+   ECORE_IMF_EVENT_MOUSE_DOWN,  /**< Mouse Down event */
+   ECORE_IMF_EVENT_MOUSE_UP,    /**< Mouse Up event */
+   ECORE_IMF_EVENT_MOUSE_IN,    /**< Mouse In event */
+   ECORE_IMF_EVENT_MOUSE_OUT,   /**< Mouse Out event */
+   ECORE_IMF_EVENT_MOUSE_MOVE,  /**< Mouse Move event */
+   ECORE_IMF_EVENT_MOUSE_WHEEL, /**< Mouse Wheel event */
+   ECORE_IMF_EVENT_KEY_DOWN,    /**< Key Down event */
+   ECORE_IMF_EVENT_KEY_UP       /**< Key Up event */
 } Ecore_IMF_Event_Type;
 
 typedef enum
@@ -123,22 +145,46 @@ typedef enum
    ECORE_IMF_INPUT_MODE_AUTOCAP      = 1 << 30
 } Ecore_IMF_Input_Mode;
 
+/**
+ * @enum _Ecore_IMF_Preedit_Type
+ * @typedef Ecore_IMF_Preedit_Type
+ *
+ * Ecore IMF Preedit style types
+ *
+ * @see ecore_imf_context_preedit_string_with_attributes_get()
+ */
 typedef enum
 {
-   ECORE_IMF_PREEDIT_TYPE_NONE,
-   ECORE_IMF_PREEDIT_TYPE_SUB1,
-   ECORE_IMF_PREEDIT_TYPE_SUB2,
-   ECORE_IMF_PREEDIT_TYPE_SUB3
+   ECORE_IMF_PREEDIT_TYPE_NONE, /**< None style */
+   ECORE_IMF_PREEDIT_TYPE_SUB1, /**< Substring style 1 */
+   ECORE_IMF_PREEDIT_TYPE_SUB2, /**< Substring style 2 */
+   ECORE_IMF_PREEDIT_TYPE_SUB3  /**< Substring style 3 */
 } Ecore_IMF_Preedit_Type;
 
+/**
+ * @enum _Ecore_IMF_Autocapital_Type
+ * @typedef Ecore_IMF_Autocapital_Type
+ *
+ * Autocapitalization Types.
+ *
+ * @see ecore_imf_context_autocapital_type_set()
+ */
 typedef enum
 {
-   ECORE_IMF_AUTOCAPITAL_TYPE_NONE,
-   ECORE_IMF_AUTOCAPITAL_TYPE_WORD,
-   ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE,
-   ECORE_IMF_AUTOCAPITAL_TYPE_ALLCHARACTER
+   ECORE_IMF_AUTOCAPITAL_TYPE_NONE,         /**< No auto-capitalization when typing */
+   ECORE_IMF_AUTOCAPITAL_TYPE_WORD,         /**< Autocapitalize each word typed */
+   ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE,     /**< Autocapitalize the start of each sentence */
+   ECORE_IMF_AUTOCAPITAL_TYPE_ALLCHARACTER, /**< Autocapitalize all letters */
 } Ecore_IMF_Autocapital_Type;
 
+/**
+ * @enum _Ecore_IMF_Input_Panel_Layout
+ * @typedef Ecore_IMF_Input_Panel_Layout
+ *
+ * Input panel (virtual keyboard) layout types.
+ *
+ * @see ecore_imf_context_input_panel_layout_set()
+ */
 typedef enum
 {
    ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
@@ -155,12 +201,40 @@ typedef enum
    ECORE_IMF_INPUT_PANEL_LAYOUT_PASSWORD         /**< Like normal, but no auto-correct, no auto-capitalization etc. @since 1.2 */
 } Ecore_IMF_Input_Panel_Layout;
 
+/**
+ * @enum _Ecore_IMF_Input_Panel_Lang
+ * @typedef Ecore_IMF_Input_Panel_Lang
+ *
+ * Input panel (virtual keyboard) language modes.
+ *
+ * @see ecore_imf_context_input_panel_language_set()
+ */
 typedef enum
 {
-   ECORE_IMF_INPUT_PANEL_LANG_AUTOMATIC,    /**< Automatic */
-   ECORE_IMF_INPUT_PANEL_LANG_ALPHABET      /**< Alphabet */
+   ECORE_IMF_INPUT_PANEL_LANG_AUTOMATIC,    /**< Automatic @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_LANG_ALPHABET      /**< Alphabet @since 1.2 */
 } Ecore_IMF_Input_Panel_Lang;
 
+/**
+ * @enum _Ecore_IMF_Input_Panel_Return_Key_Type
+ * @typedef Ecore_IMF_Input_Panel_Return_Key_Type
+ *
+ * "Return" Key types on the input panel (virtual keyboard).
+ *
+ * @see ecore_imf_context_input_panel_return_key_type_set()
+ */
+typedef enum
+{
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT, /**< Default @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DONE,    /**< Done @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_GO,      /**< Go @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_JOIN,    /**< Join @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_LOGIN,   /**< Login @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_NEXT,    /**< Next @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEARCH,  /**< Search or magnifier icon @since 1.2 */
+   ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_SEND     /**< Send @since 1.2 */
+} Ecore_IMF_Input_Panel_Return_Key_Type;
+
 struct _Ecore_IMF_Event_Preedit_Start
 {
    Ecore_IMF_Context *ctx;
@@ -314,9 +388,9 @@ union _Ecore_IMF_Event
 
 struct _Ecore_IMF_Preedit_Attr
 {
-   Ecore_IMF_Preedit_Type preedit_type;
-   unsigned int start_index;
-   unsigned int end_index;
+   Ecore_IMF_Preedit_Type preedit_type; /**< preedit style type */
+   unsigned int start_index;            /**< start index of the range (in bytes) */
+   unsigned int end_index;              /**< end index of the range (in bytes) */
 };
 
 struct _Ecore_IMF_Context_Class
@@ -345,6 +419,11 @@ struct _Ecore_IMF_Context_Class
    void (*input_panel_language_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
    Ecore_IMF_Input_Panel_Lang (*input_panel_language_get) (Ecore_IMF_Context *ctx);
    void (*cursor_location_set) (Ecore_IMF_Context *ctx, int x, int y, int w, int h);
+   void (*input_panel_imdata_set)(Ecore_IMF_Context *ctx, const void* data, int len);
+   void (*input_panel_imdata_get)(Ecore_IMF_Context *ctx, void* data, int *len);
+   void (*input_panel_return_key_type_set) (Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
+   void (*input_panel_return_key_disabled_set) (Ecore_IMF_Context *ctx, Eina_Bool disabled);
+   void (*input_panel_caps_lock_mode_set) (Ecore_IMF_Context *ctx, Eina_Bool mode);
 };
 
 struct _Ecore_IMF_Context_Info
@@ -418,6 +497,14 @@ EAPI void                          ecore_imf_context_input_panel_language_set(Ec
 EAPI Ecore_IMF_Input_Panel_Lang    ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);
 EAPI void                          ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enable);
 EAPI Eina_Bool                     ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);
+EAPI void                          ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);
+EAPI void                          ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);
+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);
+EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);
+EAPI void                          ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);
+EAPI Eina_Bool                     ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);
+EAPI void                          ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);
+EAPI Eina_Bool                     ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);
 
 /* The following entry points must be exported by each input method module
  */
@@ -433,3 +520,7 @@ EAPI Eina_Bool                     ecore_imf_context_input_panel_enabled_get(Eco
 #endif
 
 #endif
+
+/**
+ * @}
+ */