summaryrefslogtreecommitdiff
path: root/src/lib/ecore_imf
diff options
context:
space:
mode:
authorMyoungwoon Roy, Kim <myoungwoon.kim@samsung.com>2017-02-27 19:35:52 +0900
committerJean-Philippe Andre <jp.andre@samsung.com>2017-02-27 19:37:43 +0900
commit8c19d9251d2d243922057363b738780d770b4de5 (patch)
tree70467aa795a5b07c22d386cb0e4010cb22c0cfa8 /src/lib/ecore_imf
parent726994d175fb758b0b904418dbce13efd7f0cef6 (diff)
docs: Fix typos and some wrong expressions
Covers: Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Summary: I had fixed some typos and wrong expressions, such as capital letters, singular Etc. in Ecore_Drm, Ecore_Evas, Ecore_File, Ecore_IMF, and Ecore_IMF_Evas API reference doxygen. Test Plan: Doxygen Revision Reviewers: stefan, cedric, raster, jpeg, Jaehyun_Cho Subscribers: conr2d Differential Revision: https://phab.enlightenment.org/D4680
Diffstat (limited to 'src/lib/ecore_imf')
-rw-r--r--src/lib/ecore_imf/Ecore_IMF.h344
1 files changed, 172 insertions, 172 deletions
diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h
index 80ab6ab6c6..6bca58f7ad 100644
--- a/src/lib/ecore_imf/Ecore_IMF.h
+++ b/src/lib/ecore_imf/Ecore_IMF.h
@@ -74,7 +74,7 @@ extern "C" {
74 74
75/** 75/**
76 * @example ecore_imf_example.c 76 * @example ecore_imf_example.c
77 * Show how to write simple editor using the Ecore_IMF library 77 * Shows how to write simple editor using the Ecore_IMF library.
78 */ 78 */
79 79
80/* ecore_imf_context_input_panel_event_callback_add() flag */ 80/* ecore_imf_context_input_panel_event_callback_add() flag */
@@ -203,7 +203,7 @@ typedef enum
203} Ecore_IMF_Event_Type; 203} Ecore_IMF_Event_Type;
204/** 204/**
205 * @typedef Ecore_IMF_Keyboard_Modifiers 205 * @typedef Ecore_IMF_Keyboard_Modifiers
206 * Type for Ecore_IMF keyboard modifiers 206 * Types for Ecore_IMF keyboard modifiers
207 */ 207 */
208typedef enum 208typedef enum
209{ 209{
@@ -217,7 +217,7 @@ typedef enum
217 217
218/** 218/**
219 * @typedef Ecore_IMF_Keyboard_Locks 219 * @typedef Ecore_IMF_Keyboard_Locks
220 * Type for Ecore_IMF keyboard locks 220 * Types for Ecore_IMF keyboard locks
221 */ 221 */
222typedef enum 222typedef enum
223{ 223{
@@ -229,7 +229,7 @@ typedef enum
229 229
230/** 230/**
231 * @typedef Ecore_IMF_Mouse_Flags 231 * @typedef Ecore_IMF_Mouse_Flags
232 * Type for Ecore_IMF mouse flags 232 * Types for Ecore_IMF mouse flags
233 */ 233 */
234typedef enum 234typedef enum
235{ 235{
@@ -240,7 +240,7 @@ typedef enum
240 240
241/** 241/**
242 * @typedef Ecore_IMF_Input_Mode 242 * @typedef Ecore_IMF_Input_Mode
243 * Type for Ecore_IMF input mode 243 * Types for Ecore_IMF input mode
244 */ 244 */
245typedef enum 245typedef enum
246{ 246{
@@ -349,7 +349,7 @@ typedef enum
349 349
350/** 350/**
351 * @typedef Ecore_IMF_Input_Hints 351 * @typedef Ecore_IMF_Input_Hints
352 * @brief Enumeration that defines the types of Ecore_IMF Input Hints. 352 * @brief Enumeration for defining the types of Ecore_IMF Input Hints.
353 * @since 1.12 353 * @since 1.12
354 */ 354 */
355typedef enum 355typedef enum
@@ -383,7 +383,7 @@ enum
383 383
384/** 384/**
385 * @typedef Ecore_IMF_BiDi_Direction 385 * @typedef Ecore_IMF_BiDi_Direction
386 * @brief Enumeration that defines the types of Ecore_IMF bidirectionality 386 * @brief Enumeration for defining the types of Ecore_IMF bidirectionality.
387 * @since 1.12 387 * @since 1.12
388 */ 388 */
389typedef enum 389typedef enum
@@ -720,55 +720,56 @@ struct _Ecore_IMF_Context_Info
720 */ 720 */
721 721
722/** 722/**
723 * Initialises the Ecore_IMF library. 723 * @ingroup Ecore_IMF_Lib_Group
724 * @brief Initialises the Ecore_IMF library.
724 * @return Number of times the library has been initialised without being 725 * @return Number of times the library has been initialised without being
725 * shut down. 726 * shut down.
726 * @ingroup Ecore_IMF_Lib_Group
727 */ 727 */
728EAPI int ecore_imf_init(void); 728EAPI int ecore_imf_init(void);
729 729
730/** 730/**
731 * Shuts down the Ecore_IMF library. 731 * @ingroup Ecore_IMF_Lib_Group
732 * @brief Shuts down the Ecore_IMF library.
732 * @return Number of times the library has been initialised without being 733 * @return Number of times the library has been initialised without being
733 * shut down. 734 * shut down.
734 * @ingroup Ecore_IMF_Lib_Group
735 */ 735 */
736EAPI int ecore_imf_shutdown(void); 736EAPI int ecore_imf_shutdown(void);
737 737
738/** 738/**
739 * Register an Ecore_IMF module. 739 * @ingroup Ecore_IMF_Lib_Group
740 * @brief Registers an Ecore_IMF module.
740 * 741 *
741 * @param info An Ecore_IMF_Context_Info structure 742 * @param info An Ecore_IMF_Context_Info structure
742 * @param imf_module_create A function to call at the creation 743 * @param imf_module_create A function to call at the creation
743 * @param imf_module_exit A function to call when exiting 744 * @param imf_module_exit A function to call when exiting
744 * 745 *
745 * @ingroup Ecore_IMF_Lib_Group
746 */ 746 */
747EAPI 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)); 747EAPI 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));
748 748
749/** 749/**
750 * Hide the input panel. 750 * @ingroup Ecore_IMF_Lib_Group
751 * @brief Hides the input panel.
751 * @return EINA_TRUE if the input panel will be hidden 752 * @return EINA_TRUE if the input panel will be hidden
752 EINA_FALSE if the input panel is already in hidden state 753 EINA_FALSE if the input panel is already in hidden state
753 * @ingroup Ecore_IMF_Lib_Group
754 * @since 1.8.0 754 * @since 1.8.0
755 */ 755 */
756EAPI Eina_Bool ecore_imf_input_panel_hide(void); 756EAPI Eina_Bool ecore_imf_input_panel_hide(void);
757 757
758/** 758/**
759 * Get the list of the available Input Method Context ids. 759 * @ingroup Ecore_IMF_Context_Group
760 * @brief Gets the list of the available Input Method Context ids.
760 * 761 *
761 * Note that the caller is responsible for freeing the Eina_List 762 * Note that the caller is responsible for freeing the Eina_List
762 * when finished with it. There is no need to finish the list strings. 763 * when finished with it. There is no need to finish the list strings.
763 * 764 *
764 * @return Return an Eina_List of strings; 765 * @return Return an Eina_List of strings;
765 * on failure it returns NULL. 766 * on failure it returns NULL.
766 * @ingroup Ecore_IMF_Context_Group
767 */ 767 */
768EAPI Eina_List *ecore_imf_context_available_ids_get(void); 768EAPI Eina_List *ecore_imf_context_available_ids_get(void);
769 769
770/** 770/**
771 * Get the list of the available Input Method Context ids by canvas type. 771 * @ingroup Ecore_IMF_Context_Group
772 * @brief Gets the list of the available Input Method Context ids by canvas type.
772 * 773 *
773 * Note that the caller is responsible for freeing the Eina_List 774 * Note that the caller is responsible for freeing the Eina_List
774 * when finished with it. There is no need to finish the list strings. 775 * when finished with it. There is no need to finish the list strings.
@@ -776,23 +777,23 @@ EAPI Eina_List *ecore_imf_context_available_ids_get(void);
776 * @param canvas_type A string containing the canvas type. 777 * @param canvas_type A string containing the canvas type.
777 * @return Return an Eina_List of strings; 778 * @return Return an Eina_List of strings;
778 * on failure it returns NULL. 779 * on failure it returns NULL.
779 * @ingroup Ecore_IMF_Context_Group
780 */ 780 */
781EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type); 781EAPI Eina_List *ecore_imf_context_available_ids_by_canvas_type_get(const char *canvas_type);
782 782
783/** 783/**
784 * Get the id of the default Input Method Context. 784 * @ingroup Ecore_IMF_Context_Group
785 * @brief Gets the id of the default Input Method Context.
785 * The id may to used to create a new instance of an Input Method 786 * The id may to used to create a new instance of an Input Method
786 * Context object. 787 * Context object.
787 * 788 *
788 * @return Return a string containing the id of the default Input 789 * @return Return a string containing the id of the default Input
789 * Method Context; on failure it returns NULL. 790 * Method Context; on failure it returns NULL.
790 * @ingroup Ecore_IMF_Context_Group
791 */ 791 */
792EAPI const char *ecore_imf_context_default_id_get(void); 792EAPI const char *ecore_imf_context_default_id_get(void);
793 793
794/** 794/**
795 * Get the id of the default Input Method Context corresponding to a canvas 795 * @ingroup Ecore_IMF_Context_Group
796 * @brief Gets the id of the default Input Method Context corresponding to a canvas
796 * type. 797 * type.
797 * The id may be used to create a new instance of an Input Method 798 * The id may be used to create a new instance of an Input Method
798 * Context object. 799 * Context object.
@@ -800,17 +801,16 @@ EAPI const char *ecore_imf_context_default_id_get(void);
800 * @param canvas_type A string containing the canvas type. 801 * @param canvas_type A string containing the canvas type.
801 * @return Return a string containing the id of the default Input 802 * @return Return a string containing the id of the default Input
802 * Method Context; on failure it returns NULL. 803 * Method Context; on failure it returns NULL.
803 * @ingroup Ecore_IMF_Context_Group
804 */ 804 */
805EAPI const char *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type); 805EAPI const char *ecore_imf_context_default_id_by_canvas_type_get(const char *canvas_type);
806 806
807/** 807/**
808 * Retrieve the info for the Input Method Context with @p id. 808 * @ingroup Ecore_IMF_Context_Group
809 * @brief Retrieves the info for the Input Method Context with @p id.
809 * 810 *
810 * @param id The Input Method Context id to query for. 811 * @param id The Input Method Context id to query for.
811 * @return Return a #Ecore_IMF_Context_Info for the Input Method Context with @p id; 812 * @return Return a #Ecore_IMF_Context_Info for the Input Method Context with @p id;
812 * on failure it returns NULL. 813 * on failure it returns NULL.
813 * @ingroup Ecore_IMF_Context_Group
814 * 814 *
815 * Example 815 * Example
816 * @code 816 * @code
@@ -841,35 +841,36 @@ EAPI const char *ecore_imf_context_default_id_by_canvas_type_g
841EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id); 841EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_by_id_get(const char *id);
842 842
843/** 843/**
844 * Create a new Input Method Context defined by the given id. 844 * @ingroup Ecore_IMF_Context_Group
845 * @brief Creates a new Input Method Context defined by the given id.
845 * 846 *
846 * @param id The Input Method Context id. 847 * @param id The Input Method Context id.
847 * @return A newly allocated Input Method Context; 848 * @return A newly allocated Input Method Context;
848 * on failure it returns NULL. 849 * on failure it returns NULL.
849 * @ingroup Ecore_IMF_Context_Group
850 */ 850 */
851EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id); 851EAPI Ecore_IMF_Context *ecore_imf_context_add(const char *id);
852 852
853/** 853/**
854 * Retrieve the info for the given Input Method Context. 854 * @ingroup Ecore_IMF_Context_Group
855 * @brief Retrieves the info for the given Input Method Context.
855 * 856 *
856 * @param ctx An #Ecore_IMF_Context. 857 * @param ctx An #Ecore_IMF_Context.
857 * @return Return a #Ecore_IMF_Context_Info for the given Input Method Context; 858 * @return Return a #Ecore_IMF_Context_Info for the given Input Method Context;
858 * on failure it returns NULL. 859 * on failure it returns NULL.
859 * @ingroup Ecore_IMF_Context_Group
860 */ 860 */
861EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx); 861EAPI const Ecore_IMF_Context_Info *ecore_imf_context_info_get(Ecore_IMF_Context *ctx);
862 862
863/** 863/**
864 * Delete the given Input Method Context and free its memory. 864 * @ingroup Ecore_IMF_Context_Group
865 * @brief Deletes the given Input Method Context and free its memory.
865 * 866 *
866 * @param ctx An #Ecore_IMF_Context. 867 * @param ctx An #Ecore_IMF_Context.
867 * @ingroup Ecore_IMF_Context_Group
868 */ 868 */
869EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx); 869EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx);
870 870
871/** 871/**
872 * Set the client window for the Input Method Context; this is the 872 * @ingroup Ecore_IMF_Context_Group
873 * @brief Sets the client window for the Input Method Context; this is the
873 * Ecore_X_Window when using X11, Ecore_Win32_Window when using Win32, etc. 874 * Ecore_X_Window when using X11, Ecore_Win32_Window when using Win32, etc.
874 * This window is used in order to correctly position status windows, and may 875 * This window is used in order to correctly position status windows, and may
875 * also be used for purposes internal to the Input Method Context. 876 * also be used for purposes internal to the Input Method Context.
@@ -877,24 +878,24 @@ EAPI void ecore_imf_context_del(Ecore_IMF_Context *ctx)
877 * @param ctx An #Ecore_IMF_Context. 878 * @param ctx An #Ecore_IMF_Context.
878 * @param window The client window. This may be @c NULL to indicate 879 * @param window The client window. This may be @c NULL to indicate
879 * that the previous client window no longer exists. 880 * that the previous client window no longer exists.
880 * @ingroup Ecore_IMF_Context_Group
881 */ 881 */
882EAPI void ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window); 882EAPI void ecore_imf_context_client_window_set(Ecore_IMF_Context *ctx, void *window);
883 883
884/** 884/**
885 * Get the client window of the Input Method Context 885 * @ingroup Ecore_IMF_Context_Group
886 * @brief Gets the client window of the Input Method Context.
886 * 887 *
887 * See @ref ecore_imf_context_client_window_set for more details. 888 * See @ref ecore_imf_context_client_window_set for more details.
888 * 889 *
889 * @param ctx An #Ecore_IMF_Context. 890 * @param ctx An #Ecore_IMF_Context.
890 * @return Return the client window. 891 * @return Return the client window.
891 * @ingroup Ecore_IMF_Context_Group
892 * @since 1.1.0 892 * @since 1.1.0
893 */ 893 */
894EAPI void *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx); 894EAPI void *ecore_imf_context_client_window_get(Ecore_IMF_Context *ctx);
895 895
896/** 896/**
897 * Set the client canvas for the Input Method Context; this is the 897 * @ingroup Ecore_IMF_Context_Group
898 * @brief Sets the client canvas for the Input Method Context; this is the
898 * canvas in which the input appears. 899 * canvas in which the input appears.
899 * The canvas type can be determined by using the context canvas type. 900 * The canvas type can be determined by using the context canvas type.
900 * Actually only canvas with type "evas" (Evas *) is supported. 901 * Actually only canvas with type "evas" (Evas *) is supported.
@@ -904,40 +905,40 @@ EAPI void *ecore_imf_context_client_window_get(Ecore_IMF
904 * @param ctx An #Ecore_IMF_Context. 905 * @param ctx An #Ecore_IMF_Context.
905 * @param canvas The client canvas. This may be @c NULL to indicate 906 * @param canvas The client canvas. This may be @c NULL to indicate
906 * that the previous client canvas no longer exists. 907 * that the previous client canvas no longer exists.
907 * @ingroup Ecore_IMF_Context_Group
908 */ 908 */
909EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas); 909EAPI void ecore_imf_context_client_canvas_set(Ecore_IMF_Context *ctx, void *canvas);
910 910
911/** 911/**
912 * Get the client canvas of the Input Method Context. 912 * @ingroup Ecore_IMF_Context_Group
913 * @brief Gets the client canvas of the Input Method Context.
913 * 914 *
914 * See @ref ecore_imf_context_client_canvas_set for more details. 915 * See @ref ecore_imf_context_client_canvas_set for more details.
915 * 916 *
916 * @param ctx An #Ecore_IMF_Context. 917 * @param ctx An #Ecore_IMF_Context.
917 * @return Return the client canvas. 918 * @return Return the client canvas.
918 * @ingroup Ecore_IMF_Context_Group
919 * @since 1.1.0 919 * @since 1.1.0
920 */ 920 */
921EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx); 921EAPI void *ecore_imf_context_client_canvas_get(Ecore_IMF_Context *ctx);
922 922
923/** 923/**
924 * Ask the Input Method Context to show itself. 924 * @ingroup Ecore_IMF_Context_Group
925 * @brief Asks the Input Method Context to show itself.
925 * 926 *
926 * @param ctx An #Ecore_IMF_Context. 927 * @param ctx An #Ecore_IMF_Context.
927 * @ingroup Ecore_IMF_Context_Group
928 */ 928 */
929EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx); 929EAPI void ecore_imf_context_show(Ecore_IMF_Context *ctx);
930 930
931/** 931/**
932 * Ask the Input Method Context to hide itself. 932 * @ingroup Ecore_IMF_Context_Group
933 * @brief Asks the Input Method Context to hide itself.
933 * 934 *
934 * @param ctx An #Ecore_IMF_Context. 935 * @param ctx An #Ecore_IMF_Context.
935 * @ingroup Ecore_IMF_Context_Group
936 */ 936 */
937EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx); 937EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx);
938 938
939/** 939/**
940 * Retrieve the current preedit string and cursor position 940 * @ingroup Ecore_IMF_Context_Group
941 * @brief Retrieves the current preedit string and cursor position
941 * for the Input Method Context. 942 * for the Input Method Context.
942 * 943 *
943 * @param ctx An #Ecore_IMF_Context. 944 * @param ctx An #Ecore_IMF_Context.
@@ -945,21 +946,20 @@ EAPI void ecore_imf_context_hide(Ecore_IMF_Context *ctx
945 * string retrieved must be freed with free(). 946 * string retrieved must be freed with free().
946 * @param cursor_pos Location to store position of cursor (in characters) 947 * @param cursor_pos Location to store position of cursor (in characters)
947 * within the preedit string. 948 * within the preedit string.
948 * @ingroup Ecore_IMF_Context_Group
949 */ 949 */
950EAPI void ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos); 950EAPI void ecore_imf_context_preedit_string_get(Ecore_IMF_Context *ctx, char **str, int *cursor_pos);
951 951
952/** 952/**
953 * Retrieve the current preedit string, attributes and 953 * @ingroup Ecore_IMF_Context_Group
954 * @brief Retrieves the current preedit string, attributes and
954 * cursor position for the Input Method Context. 955 * cursor position for the Input Method Context.
955 * 956 *
956 * @param ctx An #Ecore_IMF_Context. 957 * @param ctx An #Ecore_IMF_Context.
957 * @param str Location to store the retrieved string. The 958 * @param str Location to store the retrieved string. The
958 * string retrieved must be freed with free(). 959 * string retrieved must be freed with free().
959 * @param attrs an Eina_List of attributes 960 * @param attrs An Eina_List of attributes
960 * @param cursor_pos Location to store position of cursor (in characters) 961 * @param cursor_pos Location to store position of cursor (in characters)
961 * within the preedit string. 962 * within the preedit string.
962 * @ingroup Ecore_IMF_Context_Group
963 * 963 *
964 * Example 964 * Example
965 * @code 965 * @code
@@ -1005,11 +1005,11 @@ EAPI void ecore_imf_context_preedit_string_get(Ecore_IM
1005EAPI void ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos); 1005EAPI void ecore_imf_context_preedit_string_with_attributes_get(Ecore_IMF_Context *ctx, char **str, Eina_List **attrs, int *cursor_pos);
1006 1006
1007/** 1007/**
1008 * Notify the Input Method Context that the widget to which its 1008 * @ingroup Ecore_IMF_Context_Group
1009 * @brief Notifies the Input Method Context that the widget to which its
1009 * correspond has gained focus. 1010 * correspond has gained focus.
1010 * 1011 *
1011 * @param ctx An #Ecore_IMF_Context. 1012 * @param ctx An #Ecore_IMF_Context.
1012 * @ingroup Ecore_IMF_Context_Group
1013 * 1013 *
1014 * Example 1014 * Example
1015 * @code 1015 * @code
@@ -1026,11 +1026,11 @@ EAPI void ecore_imf_context_preedit_string_with_attribu
1026EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context *ctx); 1026EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context *ctx);
1027 1027
1028/** 1028/**
1029 * Notify the Input Method Context that the widget to which its 1029 * @ingroup Ecore_IMF_Context_Group
1030 * @brief Notifies the Input Method Context that the widget to which its
1030 * correspond has lost focus. 1031 * correspond has lost focus.
1031 * 1032 *
1032 * @param ctx An #Ecore_IMF_Context. 1033 * @param ctx An #Ecore_IMF_Context.
1033 * @ingroup Ecore_IMF_Context_Group
1034 * 1034 *
1035 * Example 1035 * Example
1036 * @code 1036 * @code
@@ -1048,7 +1048,8 @@ EAPI void ecore_imf_context_focus_in(Ecore_IMF_Context
1048EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context *ctx); 1048EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context *ctx);
1049 1049
1050/** 1050/**
1051 * Notify the Input Method Context that a change such as a 1051 * @ingroup Ecore_IMF_Context_Group
1052 * @brief Notifies the Input Method Context that a change such as a
1052 * change in cursor position has been made. This will typically 1053 * change in cursor position has been made. This will typically
1053 * cause the Input Method Context to clear the preedit state or commit the preedit string. 1054 * cause the Input Method Context to clear the preedit state or commit the preedit string.
1054 * 1055 *
@@ -1060,7 +1061,6 @@ EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context
1060 * In addition, it should be called before inserting some text. 1061 * In addition, it should be called before inserting some text.
1061 * 1062 *
1062 * @param ctx An #Ecore_IMF_Context. 1063 * @param ctx An #Ecore_IMF_Context.
1063 * @ingroup Ecore_IMF_Context_Group
1064 * 1064 *
1065 * Example 1065 * Example
1066 * @code 1066 * @code
@@ -1078,7 +1078,8 @@ EAPI void ecore_imf_context_focus_out(Ecore_IMF_Context
1078EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ctx); 1078EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ctx);
1079 1079
1080/** 1080/**
1081 * Notify the Input Method Context that a change in the cursor 1081 * @ingroup Ecore_IMF_Context_Group
1082 * @brief Notifies the Input Method Context that a change in the cursor
1082 * position has been made. 1083 * position has been made.
1083 * 1084 *
1084 * This function should be called when cursor position is changed or mouse up event is generated. 1085 * This function should be called when cursor position is changed or mouse up event is generated.
@@ -1088,12 +1089,12 @@ EAPI void ecore_imf_context_reset(Ecore_IMF_Context *ct
1088 * 1089 *
1089 * @param ctx An #Ecore_IMF_Context. 1090 * @param ctx An #Ecore_IMF_Context.
1090 * @param cursor_pos New cursor position in characters. 1091 * @param cursor_pos New cursor position in characters.
1091 * @ingroup Ecore_IMF_Context_Group
1092 */ 1092 */
1093EAPI void ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos); 1093EAPI void ecore_imf_context_cursor_position_set(Ecore_IMF_Context *ctx, int cursor_pos);
1094 1094
1095/** 1095/**
1096 * Notify the Input Method Context that a change in the cursor 1096 * @ingroup Ecore_IMF_Context_Group
1097 * @brief Notifies the Input Method Context that a change in the cursor
1097 * location has been made. The location is relative to the canvas. 1098 * location has been made. The location is relative to the canvas.
1098 * The cursor location can be used to determine the position of 1099 * The cursor location can be used to determine the position of
1099 * candidate word window in the immodule. 1100 * candidate word window in the immodule.
@@ -1103,25 +1104,25 @@ EAPI void ecore_imf_context_cursor_position_set(Ecore_I
1103 * @param y cursor y position. 1104 * @param y cursor y position.
1104 * @param w cursor width. 1105 * @param w cursor width.
1105 * @param h cursor height. 1106 * @param h cursor height.
1106 * @ingroup Ecore_IMF_Context_Group
1107 * @since 1.1.0 1107 * @since 1.1.0
1108 */ 1108 */
1109EAPI void ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h); 1109EAPI void ecore_imf_context_cursor_location_set(Ecore_IMF_Context *ctx, int x, int y, int w, int h);
1110 1110
1111/** 1111/**
1112 * Set whether the IM context should use the preedit string 1112 * @ingroup Ecore_IMF_Context_Group
1113 * @brief Sets whether the IM context should use the preedit string
1113 * to display feedback. If @c use_preedit is @c EINA_FALSE (default 1114 * to display feedback. If @c use_preedit is @c EINA_FALSE (default
1114 * is @c EINA_TRUE), then the IM context may use some other method to display 1115 * is @c EINA_TRUE), then the IM context may use some other method to display
1115 * feedback, such as displaying it in a child of the root window. 1116 * feedback, such as displaying it in a child of the root window.
1116 * 1117 *
1117 * @param ctx An #Ecore_IMF_Context. 1118 * @param ctx An #Ecore_IMF_Context.
1118 * @param use_preedit Whether the IM context should use the preedit string. 1119 * @param use_preedit Whether the IM context should use the preedit string.
1119 * @ingroup Ecore_IMF_Context_Group
1120 */ 1120 */
1121EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit); 1121EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_Context *ctx, Eina_Bool use_preedit);
1122 1122
1123/** 1123/**
1124 * Set the callback to be used on surrounding_get request. 1124 * @ingroup Ecore_IMF_Context_Group
1125 * @brief Sets the callback to be used on surrounding_get request.
1125 * 1126 *
1126 * This callback will be called when the Input Method Context 1127 * This callback will be called when the Input Method Context
1127 * module requests the surrounding context. 1128 * module requests the surrounding context.
@@ -1131,12 +1132,12 @@ EAPI void ecore_imf_context_use_preedit_set(Ecore_IMF_C
1131 * @param ctx An #Ecore_IMF_Context. 1132 * @param ctx An #Ecore_IMF_Context.
1132 * @param func The callback to be called. 1133 * @param func The callback to be called.
1133 * @param data The data pointer to be passed to @p func 1134 * @param data The data pointer to be passed to @p func
1134 * @ingroup Ecore_IMF_Context_Group
1135 */ 1135 */
1136EAPI 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); 1136EAPI 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);
1137 1137
1138/** 1138/**
1139 * Set the callback to be used on selection_get request. 1139 * @ingroup Ecore_IMF_Context_Group
1140 * @brief Sets the callback to be used on selection_get request.
1140 * 1141 *
1141 * This callback will be called when the Input Method Context 1142 * This callback will be called when the Input Method Context
1142 * module requests the selection context. 1143 * module requests the selection context.
@@ -1144,13 +1145,13 @@ EAPI void ecore_imf_context_retrieve_surrounding_callba
1144 * @param ctx An #Ecore_IMF_Context. 1145 * @param ctx An #Ecore_IMF_Context.
1145 * @param func The callback to be called. 1146 * @param func The callback to be called.
1146 * @param data The data pointer to be passed to @p func 1147 * @param data The data pointer to be passed to @p func
1147 * @ingroup Ecore_IMF_Context_Group
1148 * @since 1.9.0 1148 * @since 1.9.0
1149 */ 1149 */
1150EAPI void ecore_imf_context_retrieve_selection_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text), const void *data); 1150EAPI void ecore_imf_context_retrieve_selection_callback_set(Ecore_IMF_Context *ctx, Eina_Bool (*func)(void *data, Ecore_IMF_Context *ctx, char **text), const void *data);
1151 1151
1152/** 1152/**
1153 * Set the input mode used by the Ecore Input Context. 1153 * @ingroup Ecore_IMF_Context_Group
1154 * @brief Sets the input mode used by the Ecore Input Context.
1154 * 1155 *
1155 * The input mode can be one of the input modes defined in 1156 * The input mode can be one of the input modes defined in
1156 * Ecore_IMF_Input_Mode. The default input mode is 1157 * Ecore_IMF_Input_Mode. The default input mode is
@@ -1158,23 +1159,23 @@ EAPI void ecore_imf_context_retrieve_selection_callback
1158 * 1159 *
1159 * @param ctx An #Ecore_IMF_Context. 1160 * @param ctx An #Ecore_IMF_Context.
1160 * @param input_mode The input mode to be used by @p ctx. 1161 * @param input_mode The input mode to be used by @p ctx.
1161 * @ingroup Ecore_IMF_Context_Group
1162 */ 1162 */
1163EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode); 1163EAPI void ecore_imf_context_input_mode_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Mode input_mode);
1164 1164
1165/** 1165/**
1166 * Get the input mode being used by the Ecore Input Context. 1166 * @ingroup Ecore_IMF_Context_Group
1167 * @brief Gets the input mode being used by the Ecore Input Context.
1167 * 1168 *
1168 * See @ref ecore_imf_context_input_mode_set for more details. 1169 * See @ref ecore_imf_context_input_mode_set for more details.
1169 * 1170 *
1170 * @param ctx An #Ecore_IMF_Context. 1171 * @param ctx An #Ecore_IMF_Context.
1171 * @return The input mode being used by @p ctx. 1172 * @return The input mode being used by @p ctx.
1172 * @ingroup Ecore_IMF_Context_Group
1173 */ 1173 */
1174EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx); 1174EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Context *ctx);
1175 1175
1176/** 1176/**
1177 * Allow an Ecore Input Context to internally handle an event. 1177 * @ingroup Ecore_IMF_Context_Group
1178 * @brief Allows an Ecore Input Context to internally handle an event.
1178 * If this function returns @c EINA_TRUE, then no further processing 1179 * If this function returns @c EINA_TRUE, then no further processing
1179 * should be done for this event. 1180 * should be done for this event.
1180 * 1181 *
@@ -1186,7 +1187,6 @@ EAPI Ecore_IMF_Input_Mode ecore_imf_context_input_mode_get(Ecore_IMF_Co
1186 * @param type The type of event defined by #Ecore_IMF_Event_Type. 1187 * @param type The type of event defined by #Ecore_IMF_Event_Type.
1187 * @param event The event itself. 1188 * @param event The event itself.
1188 * @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE. 1189 * @return @c EINA_TRUE if the event was handled; otherwise @c EINA_FALSE.
1189 * @ingroup Ecore_IMF_Context_Group
1190 * 1190 *
1191 * Example 1191 * Example
1192 * @code 1192 * @code
@@ -1222,19 +1222,20 @@ EAPI Eina_Bool ecore_imf_context_filter_event(Ecore_IMF_Cont
1222 */ 1222 */
1223 1223
1224/** 1224/**
1225 * Creates a new Input Method Context with klass specified by @p ctxc. 1225 * @ingroup Ecore_IMF_Context_Module_Group
1226 * @brief Creates a new Input Method Context with klass specified by @p ctxc.
1226 * 1227 *
1227 * This method should be used by modules implementing the Input 1228 * This method should be used by modules implementing the Input
1228 * Method Context interface. 1229 * Method Context interface.
1229 * 1230 *
1230 * @param ctxc An #Ecore_IMF_Context_Class. 1231 * @param ctxc An #Ecore_IMF_Context_Class.
1231 * @return A new #Ecore_IMF_Context; on failure it returns NULL. 1232 * @return A new #Ecore_IMF_Context; on failure it returns NULL.
1232 * @ingroup Ecore_IMF_Context_Module_Group
1233 */ 1233 */
1234EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc); 1234EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context_Class *ctxc);
1235 1235
1236/** 1236/**
1237 * Set the Input Method Context specific data. 1237 * @ingroup Ecore_IMF_Context_Module_Group
1238 * Sets the Input Method Context specific data.
1238 * 1239 *
1239 * Note that this method should be used by modules to set 1240 * Note that this method should be used by modules to set
1240 * the Input Method Context specific data and it's not meant to 1241 * the Input Method Context specific data and it's not meant to
@@ -1243,23 +1244,23 @@ EAPI Ecore_IMF_Context *ecore_imf_context_new(const Ecore_IMF_Context
1243 * @param ctx An #Ecore_IMF_Context. 1244 * @param ctx An #Ecore_IMF_Context.
1244 * @param data The Input Method Context specific data. 1245 * @param data The Input Method Context specific data.
1245 * @return A new #Ecore_IMF_Context; on failure it returns NULL. 1246 * @return A new #Ecore_IMF_Context; on failure it returns NULL.
1246 * @ingroup Ecore_IMF_Context_Module_Group
1247 */ 1247 */
1248EAPI void ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data); 1248EAPI void ecore_imf_context_data_set(Ecore_IMF_Context *ctx, void *data);
1249 1249
1250/** 1250/**
1251 * Get the Input Method Context specific data. 1251 * @ingroup Ecore_IMF_Context_Module_Group
1252 * @brief Gets the Input Method Context specific data.
1252 * 1253 *
1253 * See @ref ecore_imf_context_data_set for more details. 1254 * See @ref ecore_imf_context_data_set for more details.
1254 * 1255 *
1255 * @param ctx An #Ecore_IMF_Context. 1256 * @param ctx An #Ecore_IMF_Context.
1256 * @return The Input Method Context specific data. 1257 * @return The Input Method Context specific data.
1257 * @ingroup Ecore_IMF_Context_Module_Group
1258 */ 1258 */
1259EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx); 1259EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx);
1260 1260
1261/** 1261/**
1262 * Retrieve context around insertion point. 1262 * @ingroup Ecore_IMF_Context_Module_Group
1263 * @brief Retrieves context around insertion point.
1263 * Input methods typically want context in order to constrain input text based on existing text; 1264 * Input methods typically want context in order to constrain input text based on existing text;
1264 * this is important for languages such as Thai where only some sequences of characters are allowed. 1265 * this is important for languages such as Thai where only some sequences of characters are allowed.
1265 * In addition, the text around the insertion point can be used for supporting autocapital feature. 1266 * In addition, the text around the insertion point can be used for supporting autocapital feature.
@@ -1281,12 +1282,12 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context
1281 * the insertion cursor within @p text. 1282 * the insertion cursor within @p text.
1282 * @return @c EINA_TRUE if surrounding text was provided; otherwise 1283 * @return @c EINA_TRUE if surrounding text was provided; otherwise
1283 * @c EINA_FALSE. 1284 * @c EINA_FALSE.
1284 * @ingroup Ecore_IMF_Context_Module_Group
1285 */ 1285 */
1286EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos); 1286EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_Context *ctx, char **text, int *cursor_pos);
1287 1287
1288/** 1288/**
1289 * Retrieve the selected text. 1289 * @ingroup Ecore_IMF_Context_Module_Group
1290 * @brief Retrieves the selected text.
1290 * 1291 *
1291 * This function is implemented by calling the 1292 * This function is implemented by calling the
1292 * Ecore_IMF_Context::retrieve_selection_func ( 1293 * Ecore_IMF_Context::retrieve_selection_func (
@@ -1302,60 +1303,60 @@ EAPI Eina_Bool ecore_imf_context_surrounding_get(Ecore_IMF_C
1302 * the result stored in this location with free(). 1303 * the result stored in this location with free().
1303 * @return @c EINA_TRUE if selected text was provided; otherwise 1304 * @return @c EINA_TRUE if selected text was provided; otherwise
1304 * @c EINA_FALSE. 1305 * @c EINA_FALSE.
1305 * @ingroup Ecore_IMF_Context_Module_Group
1306 * @since 1.9.0 1306 * @since 1.9.0
1307 */ 1307 */
1308EAPI Eina_Bool ecore_imf_context_selection_get(Ecore_IMF_Context *ctx, char **text); 1308EAPI Eina_Bool ecore_imf_context_selection_get(Ecore_IMF_Context *ctx, char **text);
1309 1309
1310/** 1310/**
1311 * Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue. 1311 * @ingroup Ecore_IMF_Context_Module_Group
1312 * @brief Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue.
1312 * 1313 *
1313 * ECORE_IMF_EVENT_PREEDIT_START should be added when a new preedit sequence starts. 1314 * ECORE_IMF_EVENT_PREEDIT_START should be added when a new preedit sequence starts.
1314 * It's asynchronous method to put event to the event queue. 1315 * It's asynchronous method to put event to the event queue.
1315 * ecore_imf_context_event_callback_call() can be used as synchronous method. 1316 * ecore_imf_context_event_callback_call() can be used as synchronous method.
1316 * 1317 *
1317 * @param ctx An #Ecore_IMF_Context. 1318 * @param ctx An #Ecore_IMF_Context.
1318 * @ingroup Ecore_IMF_Context_Module_Group
1319 */ 1319 */
1320EAPI void ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx); 1320EAPI void ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx);
1321 1321
1322/** 1322/**
1323 * Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue. 1323 * @ingroup Ecore_IMF_Context_Module_Group
1324 * @brief Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue.
1324 * 1325 *
1325 * ECORE_IMF_EVENT_PREEDIT_END should be added when a new preedit sequence has been completed or canceled. 1326 * ECORE_IMF_EVENT_PREEDIT_END should be added when a new preedit sequence has been completed or canceled.
1326 * It's asynchronous method to put event to the event queue. 1327 * It's asynchronous method to put event to the event queue.
1327 * ecore_imf_context_event_callback_call() can be used as synchronous method. 1328 * ecore_imf_context_event_callback_call() can be used as synchronous method.
1328 * 1329 *
1329 * @param ctx An #Ecore_IMF_Context. 1330 * @param ctx An #Ecore_IMF_Context.
1330 * @ingroup Ecore_IMF_Context_Module_Group
1331 */ 1331 */
1332EAPI void ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx); 1332EAPI void ecore_imf_context_preedit_end_event_add(Ecore_IMF_Context *ctx);
1333 1333
1334/** 1334/**
1335 * Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue. 1335 * @ingroup Ecore_IMF_Context_Module_Group
1336 * @brief Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue.
1336 * 1337 *
1337 * It's asynchronous method to put event to the event queue. 1338 * It's asynchronous method to put event to the event queue.
1338 * ecore_imf_context_event_callback_call() can be used as synchronous method. 1339 * ecore_imf_context_event_callback_call() can be used as synchronous method.
1339 * 1340 *
1340 * @param ctx An #Ecore_IMF_Context. 1341 * @param ctx An #Ecore_IMF_Context.
1341 * @ingroup Ecore_IMF_Context_Module_Group
1342 */ 1342 */
1343EAPI void ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx); 1343EAPI void ecore_imf_context_preedit_changed_event_add(Ecore_IMF_Context *ctx);
1344 1344
1345/** 1345/**
1346 * Adds ECORE_IMF_EVENT_COMMIT to the event queue. 1346 * @ingroup Ecore_IMF_Context_Module_Group
1347 * @brief Adds ECORE_IMF_EVENT_COMMIT to the event queue.
1347 * 1348 *
1348 * It's asynchronous method to put event to the event queue. 1349 * It's asynchronous method to put event to the event queue.
1349 * ecore_imf_context_event_callback_call() can be used as synchronous method. 1350 * ecore_imf_context_event_callback_call() can be used as synchronous method.
1350 * 1351 *
1351 * @param ctx An #Ecore_IMF_Context. 1352 * @param ctx An #Ecore_IMF_Context.
1352 * @param str The committed string. 1353 * @param str The committed string.
1353 * @ingroup Ecore_IMF_Context_Module_Group
1354 */ 1354 */
1355EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str); 1355EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_Context *ctx, const char *str);
1356 1356
1357/** 1357/**
1358 * Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. 1358 * @ingroup Ecore_IMF_Context_Module_Group
1359 * @brief Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
1359 * 1360 *
1360 * Asks the widget that the input context is attached to to delete characters around the cursor position 1361 * Asks the widget that the input context is attached to to delete characters around the cursor position
1361 * by adding the ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. 1362 * by adding the ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue.
@@ -1367,12 +1368,12 @@ EAPI void ecore_imf_context_commit_event_add(Ecore_IMF_
1367 * @param ctx An #Ecore_IMF_Context. 1368 * @param ctx An #Ecore_IMF_Context.
1368 * @param offset The start offset of surrounding to be deleted. 1369 * @param offset The start offset of surrounding to be deleted.
1369 * @param n_chars The number of characters to be deleted. 1370 * @param n_chars The number of characters to be deleted.
1370 * @ingroup Ecore_IMF_Context_Module_Group
1371 */ 1371 */
1372EAPI void ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars); 1372EAPI void ecore_imf_context_delete_surrounding_event_add(Ecore_IMF_Context *ctx, int offset, int n_chars);
1373 1373
1374/** 1374/**
1375 * Add (register) a callback function to a given context event. 1375 * @ingroup Ecore_IMF_Context_Group
1376 * @brief Adds (registers) a callback function to a given context event.
1376 * 1377 *
1377 * This function adds a function callback to the context @p ctx when the 1378 * This function adds a function callback to the context @p ctx when the
1378 * event of type @p type occurs on it. The function pointer is @p 1379 * event of type @p type occurs on it. The function pointer is @p
@@ -1388,7 +1389,6 @@ EAPI void ecore_imf_context_delete_surrounding_event_ad
1388 * @param func The (callback) function to be called when the event is 1389 * @param func The (callback) function to be called when the event is
1389 * triggered 1390 * triggered
1390 * @param data The data pointer to be passed to @p func 1391 * @param data The data pointer to be passed to @p func
1391 * @ingroup Ecore_IMF_Context_Group
1392 * @since 1.2.0 1392 * @since 1.2.0
1393 * 1393 *
1394 * Example 1394 * Example
@@ -1406,7 +1406,8 @@ EAPI void ecore_imf_context_delete_surrounding_event_ad
1406EAPI void ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data); 1406EAPI void ecore_imf_context_event_callback_add(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func, const void *data);
1407 1407
1408/** 1408/**
1409 * Delete (unregister) a callback function registered to a given 1409 * @ingroup Ecore_IMF_Context_Group
1410 * @brief Deletes (unregisters) a callback function registered to a given
1410 * context event. 1411 * context event.
1411 * 1412 *
1412 * This function removes a function callback from the context @p ctx when the 1413 * This function removes a function callback from the context @p ctx when the
@@ -1419,13 +1420,13 @@ EAPI void ecore_imf_context_event_callback_add(Ecore_IM
1419 * @param type The type of event that was triggering the callback 1420 * @param type The type of event that was triggering the callback
1420 * @param func The (callback) function that was to be called when the event was triggered 1421 * @param func The (callback) function that was to be called when the event was triggered
1421 * @return the data pointer 1422 * @return the data pointer
1422 * @ingroup Ecore_IMF_Context_Group
1423 * @since 1.2.0 1423 * @since 1.2.0
1424 */ 1424 */
1425EAPI void *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func); 1425EAPI void *ecore_imf_context_event_callback_del(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, Ecore_IMF_Event_Cb func);
1426 1426
1427/** 1427/**
1428 * Call a given callback on the context @p ctx. 1428 * @ingroup Ecore_IMF_Context_Module_Group
1429 * @brief Calls a given callback on the context @p ctx.
1429 * 1430 *
1430 * ecore_imf_context_preedit_start_event_add(), ecore_imf_context_preedit_end_event_add(), 1431 * ecore_imf_context_preedit_start_event_add(), ecore_imf_context_preedit_end_event_add(),
1431 * ecore_imf_context_preedit_changed_event_add(), ecore_imf_context_commit_event_add() and 1432 * ecore_imf_context_preedit_changed_event_add(), ecore_imf_context_commit_event_add() and
@@ -1438,201 +1439,201 @@ EAPI void *ecore_imf_context_event_callback_del(Ecore_IM
1438 * @param type The type of event that will trigger the callback 1439 * @param type The type of event that will trigger the callback
1439 * @param event_info The pointer to event specific struct or information to 1440 * @param event_info The pointer to event specific struct or information to
1440 * pass to the callback functions registered on this event 1441 * pass to the callback functions registered on this event
1441 * @ingroup Ecore_IMF_Context_Module_Group
1442 * @since 1.2.0 1442 * @since 1.2.0
1443 */ 1443 */
1444EAPI void ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info); 1444EAPI void ecore_imf_context_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Callback_Type type, void *event_info);
1445 1445
1446/** 1446/**
1447 * Set whether the IM context should allow to use the text prediction. 1447 * @ingroup Ecore_IMF_Context_Group
1448 * @brief Sets whether the IM context should allow to use the text prediction.
1448 * If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM 1449 * If @p prediction is @c EINA_FALSE (default is @c EINA_TRUE), then the IM
1449 * context will not display the text prediction window. 1450 * context will not display the text prediction window.
1450 * 1451 *
1451 * @param ctx An #Ecore_IMF_Context. 1452 * @param ctx An #Ecore_IMF_Context.
1452 * @param prediction Whether the IM context should allow to use the text prediction. 1453 * @param prediction Whether the IM context should allow to use the text prediction.
1453 * @note Default value is EINA_TRUE. 1454 * @note Default value is EINA_TRUE.
1454 * @ingroup Ecore_IMF_Context_Group
1455 * @since 1.1.0 1455 * @since 1.1.0
1456 */ 1456 */
1457EAPI void ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction); 1457EAPI void ecore_imf_context_prediction_allow_set(Ecore_IMF_Context *ctx, Eina_Bool prediction);
1458 1458
1459/** 1459/**
1460 * Get whether the IM context should allow to use the text prediction. 1460 * @ingroup Ecore_IMF_Context_Group
1461 * @brief Gets whether the IM context should allow to use the text prediction.
1461 * 1462 *
1462 * @param ctx An #Ecore_IMF_Context. 1463 * @param ctx An #Ecore_IMF_Context.
1463 * @return @c EINA_TRUE if it allows to use the text prediction, otherwise 1464 * @return @c EINA_TRUE if it allows to use the text prediction, otherwise
1464 * @c EINA_FALSE. 1465 * @c EINA_FALSE.
1465 * @ingroup Ecore_IMF_Context_Group
1466 * @since 1.1.0 1466 * @since 1.1.0
1467 */ 1467 */
1468EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx); 1468EAPI Eina_Bool ecore_imf_context_prediction_allow_get(Ecore_IMF_Context *ctx);
1469 1469
1470/** 1470/**
1471 * Set the autocapitalization type on the immodule. 1471 * @ingroup Ecore_IMF_Context_Group
1472 * @brief Sets the autocapitalization type on the immodule.
1472 * 1473 *
1473 * @param ctx An #Ecore_IMF_Context. 1474 * @param ctx An #Ecore_IMF_Context.
1474 * @param autocapital_type the autocapitalization type. 1475 * @param autocapital_type the autocapitalization type.
1475 * @note Default type is ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE. 1476 * @note Default type is ECORE_IMF_AUTOCAPITAL_TYPE_SENTENCE.
1476 * @ingroup Ecore_IMF_Context_Group
1477 * @since 1.1.0 1477 * @since 1.1.0
1478 */ 1478 */
1479EAPI void ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type); 1479EAPI void ecore_imf_context_autocapital_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Autocapital_Type autocapital_type);
1480 1480
1481/** 1481/**
1482 * Get the autocapitalization type. 1482 * @ingroup Ecore_IMF_Context_Group
1483 * @brief Gets the autocapitalization type.
1483 * 1484 *
1484 * @param ctx An #Ecore_IMF_Context. 1485 * @param ctx An #Ecore_IMF_Context.
1485 * @return The autocapital type being used by @p ctx. 1486 * @return The autocapital type being used by @p ctx.
1486 * @ingroup Ecore_IMF_Context_Group
1487 * @since 1.1.0 1487 * @since 1.1.0
1488 */ 1488 */
1489EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx); 1489EAPI Ecore_IMF_Autocapital_Type ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx);
1490 1490
1491/** 1491/**
1492 * @ingroup Ecore_IMF_Context_Group
1492 * @brief Sets the input hint which allows input methods to fine-tune their behavior. 1493 * @brief Sets the input hint which allows input methods to fine-tune their behavior.
1493 * 1494 *
1494 * @param ctx An #Ecore_IMF_Context 1495 * @param ctx An #Ecore_IMF_Context
1495 * @param hints input hint 1496 * @param hints Input hint
1496 * @note The default input hint is @c ECORE_IMF_INPUT_HINT_AUTO_COMPLETE. 1497 * @note The default input hint is @c ECORE_IMF_INPUT_HINT_AUTO_COMPLETE.
1497 * @ingroup Ecore_IMF_Context_Group
1498 * @since 1.12 1498 * @since 1.12
1499 */ 1499 */
1500EAPI void ecore_imf_context_input_hint_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints hints); 1500EAPI void ecore_imf_context_input_hint_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Hints hints);
1501 1501
1502/** 1502/**
1503 * @ingroup Ecore_IMF_Context_Group
1503 * @brief Gets the value of input hint. 1504 * @brief Gets the value of input hint.
1504 * 1505 *
1505 * @param ctx An #Ecore_IMF_Context 1506 * @param ctx An #Ecore_IMF_Context
1506 * @return The value of input hint 1507 * @return The value of input hint
1507 * @ingroup Ecore_IMF_Context_Group
1508 * @since 1.12 1508 * @since 1.12
1509 */ 1509 */
1510EAPI Ecore_IMF_Input_Hints ecore_imf_context_input_hint_get(Ecore_IMF_Context *ctx); 1510EAPI Ecore_IMF_Input_Hints ecore_imf_context_input_hint_get(Ecore_IMF_Context *ctx);
1511 1511
1512/** 1512/**
1513 * Ask the Input Method Context to show the control panel of using Input Method. 1513 * @ingroup Ecore_IMF_Context_Group
1514 * @brief Asks the Input Method Context to show the control panel of using Input Method.
1514 * 1515 *
1515 * @param ctx An #Ecore_IMF_Context. 1516 * @param ctx An #Ecore_IMF_Context.
1516 * @ingroup Ecore_IMF_Context_Group
1517 * @since 1.1.0 1517 * @since 1.1.0
1518 */ 1518 */
1519EAPI void ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx); 1519EAPI void ecore_imf_context_control_panel_show(Ecore_IMF_Context *ctx);
1520 1520
1521/** 1521/**
1522 * Ask the Input Method Context to hide the control panel of using Input Method. 1522 * @ingroup Ecore_IMF_Context_Group
1523 * @brief Asks the Input Method Context to hide the control panel of using Input Method.
1523 * 1524 *
1524 * @param ctx An #Ecore_IMF_Context. 1525 * @param ctx An #Ecore_IMF_Context.
1525 * @ingroup Ecore_IMF_Context_Group
1526 * @since 1.1.0 1526 * @since 1.1.0
1527 */ 1527 */
1528EAPI void ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx); 1528EAPI void ecore_imf_context_control_panel_hide(Ecore_IMF_Context *ctx);
1529 1529
1530/** 1530/**
1531 * Ask the Input Method Context to show the input panel (virtual keyboard). 1531 * @ingroup Ecore_IMF_Context_Group
1532 * @brief Asks the Input Method Context to show the input panel (virtual keyboard).
1532 * 1533 *
1533 * @param ctx An #Ecore_IMF_Context. 1534 * @param ctx An #Ecore_IMF_Context.
1534 * @ingroup Ecore_IMF_Context_Group
1535 * @since 1.1.0 1535 * @since 1.1.0
1536 */ 1536 */
1537EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx); 1537EAPI void ecore_imf_context_input_panel_show(Ecore_IMF_Context *ctx);
1538 1538
1539/** 1539/**
1540 * Ask the Input Method Context to hide the input panel. 1540 * @ingroup Ecore_IMF_Context_Group
1541 * @brief Asks the Input Method Context to hide the input panel.
1541 * 1542 *
1542 * @param ctx An #Ecore_IMF_Context. 1543 * @param ctx An #Ecore_IMF_Context.
1543 * @ingroup Ecore_IMF_Context_Group
1544 * @since 1.1.0 1544 * @since 1.1.0
1545 */ 1545 */
1546EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx); 1546EAPI void ecore_imf_context_input_panel_hide(Ecore_IMF_Context *ctx);
1547 1547
1548/** 1548/**
1549 * Set the layout of the input panel. 1549 * @ingroup Ecore_IMF_Context_Group
1550 * @brief Sets the layout of the input panel.
1550 * 1551 *
1551 * @param ctx An #Ecore_IMF_Context. 1552 * @param ctx An #Ecore_IMF_Context.
1552 * @param layout see #Ecore_IMF_Input_Panel_Layout 1553 * @param layout see #Ecore_IMF_Input_Panel_Layout
1553 * @note Default layout type is ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL. 1554 * @note Default layout type is ECORE_IMF_INPUT_PANEL_LAYOUT_NORMAL.
1554 * @ingroup Ecore_IMF_Context_Group
1555 * @since 1.1.0 1555 * @since 1.1.0
1556 */ 1556 */
1557EAPI void ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout); 1557EAPI void ecore_imf_context_input_panel_layout_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Layout layout);
1558 1558
1559/** 1559/**
1560 * Get the layout of the current active input panel. 1560 * @ingroup Ecore_IMF_Context_Group
1561 * @brief Gets the layout of the current active input panel.
1561 * 1562 *
1562 * @param ctx An #Ecore_IMF_Context. 1563 * @param ctx An #Ecore_IMF_Context.
1563 * @return layout see #Ecore_IMF_Input_Panel_Layout 1564 * @return layout see #Ecore_IMF_Input_Panel_Layout
1564 * @ingroup Ecore_IMF_Context_Group
1565 * @since 1.1.0 1565 * @since 1.1.0
1566 */ 1566 */
1567EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx); 1567EAPI Ecore_IMF_Input_Panel_Layout ecore_imf_context_input_panel_layout_get(Ecore_IMF_Context *ctx);
1568 1568
1569/** 1569/**
1570 * Set the layout variation of the current active input panel. 1570 * @ingroup Ecore_IMF_Context_Group
1571 * @brief Sets the layout variation of the current active input panel.
1571 * 1572 *
1572 * @param ctx An #Ecore_IMF_Context. 1573 * @param ctx An #Ecore_IMF_Context.
1573 * @param variation the layout variation 1574 * @param variation the layout variation
1574 * @note Default layout variation type is NORMAL. 1575 * @note Default layout variation type is NORMAL.
1575 * @ingroup Ecore_IMF_Context_Group
1576 * @since 1.8.0 1576 * @since 1.8.0
1577 */ 1577 */
1578EAPI void ecore_imf_context_input_panel_layout_variation_set(Ecore_IMF_Context *ctx, int variation); 1578EAPI void ecore_imf_context_input_panel_layout_variation_set(Ecore_IMF_Context *ctx, int variation);
1579 1579
1580/** 1580/**
1581 * Get the layout variation of the current active input panel. 1581 * @ingroup Ecore_IMF_Context_Group
1582 * @brief Gets the layout variation of the current active input panel.
1582 * 1583 *
1583 * @param ctx An #Ecore_IMF_Context. 1584 * @param ctx An #Ecore_IMF_Context.
1584 * @return the layout variation 1585 * @return the layout variation
1585 * @ingroup Ecore_IMF_Context_Group
1586 * @since 1.8.0 1586 * @since 1.8.0
1587 */ 1587 */
1588EAPI int ecore_imf_context_input_panel_layout_variation_get(Ecore_IMF_Context *ctx); 1588EAPI int ecore_imf_context_input_panel_layout_variation_get(Ecore_IMF_Context *ctx);
1589 1589
1590/** 1590/**
1591 * Set the language of the input panel. 1591 * @ingroup Ecore_IMF_Context_Group
1592 * @brief Sets the language of the input panel.
1592 * This API can be used when you want to show the English keyboard. 1593 * This API can be used when you want to show the English keyboard.
1593 * 1594 *
1594 * @param ctx An #Ecore_IMF_Context. 1595 * @param ctx An #Ecore_IMF_Context.
1595 * @param lang the language to be set to the input panel. 1596 * @param lang the language to be set to the input panel.
1596 * @ingroup Ecore_IMF_Context_Group
1597 * @since 1.1.0 1597 * @since 1.1.0
1598 */ 1598 */
1599EAPI void ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang); 1599EAPI void ecore_imf_context_input_panel_language_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Lang lang);
1600 1600
1601/** 1601/**
1602 * Get the language of the input panel. 1602 * @ingroup Ecore_IMF_Context_Group
1603 * @brief Gets the language of the input panel.
1603 * 1604 *
1604 * See @ref ecore_imf_context_input_panel_language_set for more details. 1605 * See @ref ecore_imf_context_input_panel_language_set for more details.
1605 * 1606 *
1606 * @param ctx An #Ecore_IMF_Context. 1607 * @param ctx An #Ecore_IMF_Context.
1607 * @return Ecore_IMF_Input_Panel_Lang 1608 * @return Ecore_IMF_Input_Panel_Lang
1608 * @ingroup Ecore_IMF_Context_Group
1609 * @since 1.1.0 1609 * @since 1.1.0
1610 */ 1610 */
1611EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx); 1611EAPI Ecore_IMF_Input_Panel_Lang ecore_imf_context_input_panel_language_get(Ecore_IMF_Context *ctx);
1612 1612
1613/** 1613/**
1614 * Set whether the Input Method Context should request to show the input panel automatically 1614 * @ingroup Ecore_IMF_Context_Group
1615 * @brief Sets whether the Input Method Context should request to show the input panel automatically
1615 * when the widget has focus. 1616 * when the widget has focus.
1616 * 1617 *
1617 * @param ctx An #Ecore_IMF_Context. 1618 * @param ctx An #Ecore_IMF_Context.
1618 * @param enabled If true, the input panel will be shown when the widget is clicked or has focus. 1619 * @param enabled If true, the input panel will be shown when the widget is clicked or has focus.
1619 * @ingroup Ecore_IMF_Context_Group
1620 * @since 1.1.0 1620 * @since 1.1.0
1621 */ 1621 */
1622EAPI void ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enabled); 1622EAPI void ecore_imf_context_input_panel_enabled_set(Ecore_IMF_Context *ctx, Eina_Bool enabled);
1623 1623
1624/** 1624/**
1625 * Get whether the Input Method Context requests to show the input panel automatically. 1625 * @ingroup Ecore_IMF_Context_Group
1626 * @brief Gets whether the Input Method Context requests to show the input panel automatically.
1626 * 1627 *
1627 * @param ctx An #Ecore_IMF_Context. 1628 * @param ctx An #Ecore_IMF_Context.
1628 * @return Return the attribute to show the input panel automatically 1629 * @return Return the attribute to show the input panel automatically
1629 * @ingroup Ecore_IMF_Context_Group
1630 * @since 1.1.0 1630 * @since 1.1.0
1631 */ 1631 */
1632EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx); 1632EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Ecore_IMF_Context *ctx);
1633 1633
1634/** 1634/**
1635 * Set the input panel-specific data to deliver to the input panel. 1635 * @ingroup Ecore_IMF_Context_Group
1636 * @brief Sets the input panel-specific data to deliver to the input panel.
1636 * This API is used by applications to deliver specific data to the input panel. 1637 * This API is used by applications to deliver specific data to the input panel.
1637 * The data format MUST be negotiated by both application and the input panel. 1638 * The data format MUST be negotiated by both application and the input panel.
1638 * The size and format of data are defined by the input panel. 1639 * The size and format of data are defined by the input panel.
@@ -1640,24 +1641,24 @@ EAPI Eina_Bool ecore_imf_context_input_panel_enabled_get(Eco
1640 * @param ctx An #Ecore_IMF_Context. 1641 * @param ctx An #Ecore_IMF_Context.
1641 * @param data The specific data to be set to the input panel. 1642 * @param data The specific data to be set to the input panel.
1642 * @param len the length of data, in bytes, to send to the input panel 1643 * @param len the length of data, in bytes, to send to the input panel
1643 * @ingroup Ecore_IMF_Context_Group
1644 * @since 1.2.0 1644 * @since 1.2.0
1645 */ 1645 */
1646EAPI void ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len); 1646EAPI void ecore_imf_context_input_panel_imdata_set(Ecore_IMF_Context *ctx, const void *data, int len);
1647 1647
1648/** 1648/**
1649 * Get the specific data of the current active input panel. 1649 * @ingroup Ecore_IMF_Context_Group
1650 * @brief Gets the specific data of the current active input panel.
1650 * 1651 *
1651 * @param ctx An #Ecore_IMF_Context. 1652 * @param ctx An #Ecore_IMF_Context.
1652 * @param data The specific data to be got from the input panel 1653 * @param data The specific data to be got from the input panel
1653 * @param len The length of data 1654 * @param len The length of data
1654 * @ingroup Ecore_IMF_Context_Group
1655 * @since 1.2.0 1655 * @since 1.2.0
1656 */ 1656 */
1657EAPI void ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len); 1657EAPI void ecore_imf_context_input_panel_imdata_get(Ecore_IMF_Context *ctx, void *data, int *len);
1658 1658
1659/** 1659/**
1660 * Set the "return" key type. This type is used to set string or icon on the "return" key of the input panel. 1660 * @ingroup Ecore_IMF_Context_Group
1661 * @brief Sets the "return" key type. This type is used to set string or icon on the "return" key of the input panel.
1661 * 1662 *
1662 * An input panel displays the string or icon associated with this type.@n 1663 * An input panel displays the string or icon associated with this type.@n
1663 * Regardless of return key type, return key event will be generated when pressing return key. 1664 * Regardless of return key type, return key event will be generated when pressing return key.
@@ -1665,88 +1666,88 @@ EAPI void ecore_imf_context_input_panel_imdata_get(Ecor
1665 * @param ctx An #Ecore_IMF_Context. 1666 * @param ctx An #Ecore_IMF_Context.
1666 * @param return_key_type The type of "return" key on the input panel 1667 * @param return_key_type The type of "return" key on the input panel
1667 * @note Default type is ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT. 1668 * @note Default type is ECORE_IMF_INPUT_PANEL_RETURN_KEY_TYPE_DEFAULT.
1668 * @ingroup Ecore_IMF_Context_Group
1669 * @since 1.2.0 1669 * @since 1.2.0
1670 */ 1670 */
1671EAPI void ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type); 1671EAPI void ecore_imf_context_input_panel_return_key_type_set(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Return_Key_Type return_key_type);
1672 1672
1673/** 1673/**
1674 * Get the "return" key type. 1674 * @ingroup Ecore_IMF_Context_Group
1675 * @brief Gets the "return" key type.
1675 * 1676 *
1676 * @see ecore_imf_context_input_panel_return_key_type_set() for more details 1677 * @see ecore_imf_context_input_panel_return_key_type_set() for more details
1677 * 1678 *
1678 * @param ctx An #Ecore_IMF_Context. 1679 * @param ctx An #Ecore_IMF_Context.
1679 * @return The type of "return" key on the input panel 1680 * @return The type of "return" key on the input panel
1680 * @ingroup Ecore_IMF_Context_Group
1681 * @since 1.2.0 1681 * @since 1.2.0
1682 */ 1682 */
1683EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx); 1683EAPI Ecore_IMF_Input_Panel_Return_Key_Type ecore_imf_context_input_panel_return_key_type_get(Ecore_IMF_Context *ctx);
1684 1684
1685/** 1685/**
1686 * Set the return key on the input panel to be disabled. 1686 * @ingroup Ecore_IMF_Context_Group
1687 * @brief Sets the return key on the input panel to be disabled.
1687 * 1688 *
1688 * @param ctx An #Ecore_IMF_Context. 1689 * @param ctx An #Ecore_IMF_Context.
1689 * @param disabled The state 1690 * @param disabled The state
1690 * @ingroup Ecore_IMF_Context_Group
1691 * @since 1.2.0 1691 * @since 1.2.0
1692 */ 1692 */
1693EAPI void ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled); 1693EAPI void ecore_imf_context_input_panel_return_key_disabled_set(Ecore_IMF_Context *ctx, Eina_Bool disabled);
1694 1694
1695/** 1695/**
1696 * Get whether the return key on the input panel should be disabled or not. 1696 * @ingroup Ecore_IMF_Context_Group
1697 * @brief Gets whether the return key on the input panel should be disabled or not.
1697 * 1698 *
1698 * @param ctx An #Ecore_IMF_Context. 1699 * @param ctx An #Ecore_IMF_Context.
1699 * @return @c EINA_TRUE if it should be disabled. 1700 * @return @c EINA_TRUE if it should be disabled.
1700 * @ingroup Ecore_IMF_Context_Group
1701 * @since 1.2.0 1701 * @since 1.2.0
1702 */ 1702 */
1703EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx); 1703EAPI Eina_Bool ecore_imf_context_input_panel_return_key_disabled_get(Ecore_IMF_Context *ctx);
1704 1704
1705/** 1705/**
1706 * Set the caps lock mode on the input panel. 1706 * @ingroup Ecore_IMF_Context_Group
1707 * @brief Sets the caps lock mode on the input panel.
1707 * 1708 *
1708 * @param ctx An #Ecore_IMF_Context. 1709 * @param ctx An #Ecore_IMF_Context.
1709 * @param mode Turn on caps lock on the input panel if @c EINA_TRUE. 1710 * @param mode Turn on caps lock on the input panel if @c EINA_TRUE.
1710 * @ingroup Ecore_IMF_Context_Group
1711 * @since 1.2.0 1711 * @since 1.2.0
1712 */ 1712 */
1713EAPI void ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode); 1713EAPI void ecore_imf_context_input_panel_caps_lock_mode_set(Ecore_IMF_Context *ctx, Eina_Bool mode);
1714 1714
1715/** 1715/**
1716 * Get the caps lock mode on the input panel. 1716 * @ingroup Ecore_IMF_Context_Group
1717 * @brief Gets the caps lock mode on the input panel.
1717 * 1718 *
1718 * @param ctx An #Ecore_IMF_Context. 1719 * @param ctx An #Ecore_IMF_Context.
1719 * @return @c EINA_TRUE if the caps lock is turned on. 1720 * @return @c EINA_TRUE if the caps lock is turned on.
1720 * @ingroup Ecore_IMF_Context_Group
1721 * @since 1.2.0 1721 * @since 1.2.0
1722 */ 1722 */
1723EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx); 1723EAPI Eina_Bool ecore_imf_context_input_panel_caps_lock_mode_get(Ecore_IMF_Context *ctx);
1724 1724
1725/** 1725/**
1726 * Get the position of the current active input panel. 1726 * @ingroup Ecore_IMF_Context_Group
1727 * @brief Gets the position of the current active input panel.
1727 * 1728 *
1728 * @param ctx An #Ecore_IMF_Context. 1729 * @param ctx An #Ecore_IMF_Context.
1729 * @param x top-left x co-ordinate of the input panel 1730 * @param x top-left x co-ordinate of the input panel
1730 * @param y top-left y co-ordinate of the input panel 1731 * @param y top-left y co-ordinate of the input panel
1731 * @param w width of the input panel 1732 * @param w width of the input panel
1732 * @param h height of the input panel 1733 * @param h height of the input panel
1733 * @ingroup Ecore_IMF_Context_Group
1734 * @since 1.3 1734 * @since 1.3
1735 */ 1735 */
1736EAPI void ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h); 1736EAPI void ecore_imf_context_input_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
1737 1737
1738/** 1738/**
1739 * Get state of current active input panel. 1739 * @ingroup Ecore_IMF_Context_Group
1740 * @brief Gets state of current active input panel.
1740 * 1741 *
1741 * @param ctx An #Ecore_IMF_Context. 1742 * @param ctx An #Ecore_IMF_Context.
1742 * @return The state of input panel. 1743 * @return The state of input panel.
1743 * @ingroup Ecore_IMF_Context_Group
1744 * @since 1.3 1744 * @since 1.3
1745 */ 1745 */
1746EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx); 1746EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore_IMF_Context *ctx);
1747 1747
1748/** 1748/**
1749 * Register a callback function which will be called if there is change in input panel state,language,mode etc. 1749 * @ingroup Ecore_IMF_Context_Group
1750 * @brief Registers a callback function which will be called if there is change in input panel state,language,mode etc.
1750 * In order to deregister the callback function 1751 * In order to deregister the callback function
1751 * Use @ref ecore_imf_context_input_panel_event_callback_del. 1752 * Use @ref ecore_imf_context_input_panel_event_callback_del.
1752 * 1753 *
@@ -1754,110 +1755,109 @@ EAPI Ecore_IMF_Input_Panel_State ecore_imf_context_input_panel_state_get(Ecore
1754 * @param type event type 1755 * @param type event type
1755 * @param func the callback function 1756 * @param func the callback function
1756 * @param data application-input panel specific data. 1757 * @param data application-input panel specific data.
1757 * @ingroup Ecore_IMF_Context_Group
1758 * @since 1.3 1758 * @since 1.3
1759 */ 1759 */
1760EAPI 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); 1760EAPI 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);
1761 1761
1762/** 1762/**
1763 * Unregister a callback function which will be called if there is change in input panel state, language, mode etc. 1763 * @ingroup Ecore_IMF_Context_Group
1764 * @brief Unregisters a callback function which will be called if there is change in input panel state, language, mode etc.
1764 * 1765 *
1765 * @param ctx An #Ecore_IMF_Context. 1766 * @param ctx An #Ecore_IMF_Context.
1766 * @param type An #Ecore_IMF_Input_Panel_Event. 1767 * @param type An #Ecore_IMF_Input_Panel_Event.
1767 * @param func the callback function 1768 * @param func the callback function
1768 * @ingroup Ecore_IMF_Context_Group
1769 * @since 1.3 1769 * @since 1.3
1770 */ 1770 */
1771EAPI 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)); 1771EAPI 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));
1772 1772
1773/** 1773/**
1774 * Call a given input panel callback on the context @p ctx. 1774 * @ingroup Ecore_IMF_Context_Group
1775 * @brief Calls a given input panel callback on the context @p ctx.
1775 * 1776 *
1776 * @param ctx Ecore_IMF_Context. 1777 * @param ctx Ecore_IMF_Context.
1777 * @param type The type of event that will trigger the callback 1778 * @param type The type of event that will trigger the callback
1778 * @param value the event value 1779 * @param value the event value
1779 * @ingroup Ecore_IMF_Context_Group
1780 * @since 1.8.0 1780 * @since 1.8.0
1781 */ 1781 */
1782EAPI void ecore_imf_context_input_panel_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, int value); 1782EAPI void ecore_imf_context_input_panel_event_callback_call(Ecore_IMF_Context *ctx, Ecore_IMF_Input_Panel_Event type, int value);
1783 1783
1784/** 1784/**
1785 * Delete all input panel callback on the context @p ctx. 1785 * @ingroup Ecore_IMF_Context_Group
1786 * @brief Deletes all input panel callback on the context @p ctx.
1786 * 1787 *
1787 * Delete all input panel callback to be registered by ecore_imf_context_input_panel_event_callback_add() 1788 * Deletes all input panel callback to be registered by ecore_imf_context_input_panel_event_callback_add()
1788 * 1789 *
1789 * @param ctx Ecore_IMF_Context. 1790 * @param ctx Ecore_IMF_Context.
1790 * @ingroup Ecore_IMF_Context_Group
1791 * @since 1.8.0 1791 * @since 1.8.0
1792 */ 1792 */
1793EAPI void ecore_imf_context_input_panel_event_callback_clear(Ecore_IMF_Context *ctx); 1793EAPI void ecore_imf_context_input_panel_event_callback_clear(Ecore_IMF_Context *ctx);
1794 1794
1795/** 1795/**
1796 * Get the current language locale of the input panel. 1796 * @ingroup Ecore_IMF_Context_Group
1797 * @brief Gets the current language locale of the input panel.
1797 * 1798 *
1798 * ex) fr_FR 1799 * ex) fr_FR
1799 * 1800 *
1800 * @param ctx An #Ecore_IMF_Context. 1801 * @param ctx An #Ecore_IMF_Context.
1801 * @param lang Location to store the retrieved language string. The 1802 * @param lang Location to store the retrieved language string. The
1802 * string retrieved must be freed with free(). 1803 * string retrieved must be freed with free().
1803 * @ingroup Ecore_IMF_Context_Group
1804 * @since 1.3 1804 * @since 1.3
1805 */ 1805 */
1806EAPI void ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang); 1806EAPI void ecore_imf_context_input_panel_language_locale_get(Ecore_IMF_Context *ctx, char **lang);
1807 1807
1808/** 1808/**
1809 * Get the geometry information of the candidate panel. 1809 * @ingroup Ecore_IMF_Context_Group
1810 * @brief Gets the geometry information of the candidate panel.
1810 * 1811 *
1811 * @param ctx An #Ecore_IMF_Context. 1812 * @param ctx An #Ecore_IMF_Context.
1812 * @param x top-left x co-ordinate of the candidate panel 1813 * @param x top-left x co-ordinate of the candidate panel
1813 * @param y top-left y co-ordinate of the candidate panel 1814 * @param y top-left y co-ordinate of the candidate panel
1814 * @param w width of the candidate panel 1815 * @param w width of the candidate panel
1815 * @param h height of the candidate panel 1816 * @param h height of the candidate panel
1816 * @ingroup Ecore_IMF_Context_Group
1817 * @since 1.3 1817 * @since 1.3
1818 */ 1818 */
1819EAPI void ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h); 1819EAPI void ecore_imf_context_candidate_panel_geometry_get(Ecore_IMF_Context *ctx, int *x, int *y, int *w, int *h);
1820 1820
1821/** 1821/**
1822 * Set whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event. 1822 * @ingroup Ecore_IMF_Context_Group
1823 * @brief Sets whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
1823 * It doesn't request to show the input panel even though the Input Method Context has focus. 1824 * It doesn't request to show the input panel even though the Input Method Context has focus.
1824 * 1825 *
1825 * @param ctx An #Ecore_IMF_Context. 1826 * @param ctx An #Ecore_IMF_Context.
1826 * @param ondemand If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.) 1827 * @param ondemand If true, the input panel will be shown in case of only Mouse up event. (Focus event will be ignored.)
1827 * @ingroup Ecore_IMF_Context_Group
1828 * @since 1.8.0 1828 * @since 1.8.0
1829 */ 1829 */
1830EAPI void ecore_imf_context_input_panel_show_on_demand_set(Ecore_IMF_Context *ctx, Eina_Bool ondemand); 1830EAPI void ecore_imf_context_input_panel_show_on_demand_set(Ecore_IMF_Context *ctx, Eina_Bool ondemand);
1831 1831
1832/** 1832/**
1833 * Get whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event. 1833 * @ingroup Ecore_IMF_Context_Group
1834 * @brief Gets whether the Input Method Context should request to show the input panel in case of only an user's explicit Mouse Up event.
1834 * 1835 *
1835 * @param ctx An #Ecore_IMF_Context. 1836 * @param ctx An #Ecore_IMF_Context.
1836 * @return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event. 1837 * @return @c EINA_TRUE if the input panel will be shown in case of only Mouse up event.
1837 * @ingroup Ecore_IMF_Context_Group
1838 * @since 1.8.0 1838 * @since 1.8.0
1839 */ 1839 */
1840EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_get(Ecore_IMF_Context *ctx); 1840EAPI Eina_Bool ecore_imf_context_input_panel_show_on_demand_get(Ecore_IMF_Context *ctx);
1841 1841
1842/** 1842/**
1843 * @ingroup Ecore_IMF_Context_Group
1843 * @brief Sets the bidirectionality at the current cursor position. 1844 * @brief Sets the bidirectionality at the current cursor position.
1844 * 1845 *
1845 * @ingroup Ecore_IMF_Context_Group
1846 * @since 1.12.0 1846 * @since 1.12.0
1847 * 1847 *
1848 * @param[in] ctx An #Ecore_IMF_Context 1848 * @param[in] ctx An #Ecore_IMF_Context
1849 * @param[in] direction the direction mode 1849 * @param[in] direction The direction mode
1850 */ 1850 */
1851EAPI void ecore_imf_context_bidi_direction_set(Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction); 1851EAPI void ecore_imf_context_bidi_direction_set(Ecore_IMF_Context *ctx, Ecore_IMF_BiDi_Direction direction);
1852 1852
1853/** 1853/**
1854 * @ingroup Ecore_IMF_Context_Group
1854 * @brief Gets the bidirectionality at the current cursor position. 1855 * @brief Gets the bidirectionality at the current cursor position.
1855 * 1856 *
1856 * @ingroup Ecore_IMF_Context_Group
1857 * @since 1.12.0 1857 * @since 1.12.0
1858 * 1858 *
1859 * @param[in] ctx An #Ecore_IMF_Context 1859 * @param[in] ctx An #Ecore_IMF_Context
1860 * @return the direction mode 1860 * @return The direction mode
1861 */ 1861 */
1862EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx); 1862EAPI Ecore_IMF_BiDi_Direction ecore_imf_context_bidi_direction_get(Ecore_IMF_Context *ctx);
1863 1863