summaryrefslogtreecommitdiff
path: root/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
diff options
context:
space:
mode:
authorJihoon Kim <imfine98@gmail.com>2012-03-28 02:23:57 +0000
committerJihoon Kim <imfine98@gmail.com>2012-03-28 02:23:57 +0000
commit98cf92c4f9c3df7d6fa9bd0814ebf8ed2ec70a7d (patch)
treead67415ce8d0c17c4b7454908a1cb6ba8894951d /legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
parent5d861aad45a045d546b360d7ab99928751168dff (diff)
ecore_imf: describe about Ecore IMF Context more detail
SVN revision: 69683
Diffstat (limited to '')
-rw-r--r--legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c19
1 files changed, 18 insertions, 1 deletions
diff --git a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
index 423c461bb3..9f065ba3f6 100644
--- a/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
+++ b/legacy/ecore/src/lib/ecore_imf/ecore_imf_context.c
@@ -16,6 +16,20 @@
16 * @defgroup Ecore_IMF_Context_Group Ecore Input Method Context Functions 16 * @defgroup Ecore_IMF_Context_Group Ecore Input Method Context Functions
17 * 17 *
18 * Functions that operate on Ecore Input Method Context objects. 18 * Functions that operate on Ecore Input Method Context objects.
19
20 * Ecore Input Method Context Function defines the interface for EFL input methods.
21 * An input method is used by EFL text input widgets like elm_entry
22 * (based on edje_entry) to map from key events to Unicode character strings.
23 *
24 * The default input method can be set through setting the ECORE_IMF_MODULE environment variable.
25 *
26 * An input method may consume multiple key events in sequence and finally output the composed result.
27 * This is called preediting, and an input method may provide feedback about
28 * this process by displaying the intermediate composition states as preedit text.
29 *
30 * Immodule is plugin to connect your application and input method framework such as SCIM, ibus, and so on.@n
31 * ecore_imf_init() should be called to initialize and load immodule.@n
32 * ecore_imf_shutdown() is used for shutdowning and unloading immodule.
19 */ 33 */
20 34
21/** 35/**
@@ -760,7 +774,7 @@ ecore_imf_context_autocapital_type_get(Ecore_IMF_Context *ctx)
760} 774}
761 775
762/** 776/**
763 * Set the callback to be used on get_surrounding request. 777 * Set the callback to be used on surrounding_get request.
764 * 778 *
765 * This callback will be called when the Input Method Context 779 * This callback will be called when the Input Method Context
766 * module requests the surrounding context. 780 * module requests the surrounding context.
@@ -957,6 +971,9 @@ EAPI void *ecore_imf_context_data_get(Ecore_IMF_Context *ctx)
957 971
958/** 972/**
959 * Retrieve context around insertion point. 973 * Retrieve context around insertion point.
974 * Input methods typically want context in order to constrain input text based on existing text;
975 * this is important for languages such as Thai where only some sequences of characters are allowed.
976 * In addition, the text around the insertion point can be used for supporting autocapital feature.
960 * 977 *
961 * This function is implemented by calling the 978 * This function is implemented by calling the
962 * Ecore_IMF_Context::retrieve_surrounding_func ( 979 * Ecore_IMF_Context::retrieve_surrounding_func (