Add explanation about ecore_imf_context_retrieve_surrounding_callback_set

ecore_imf_context_retrieve_surrounding_callback_set () is very important to input languages such as Thai.

diff --git a/src/lib/ecore_imf/Ecore_IMF.h b/src/lib/ecore_imf/Ecore_IMF.h
index c1a255c21d7f842c876961bdde3c53eab7fc6d18..6d0719e667c931d7f7ffa0bba9831d753fd96f7e 100644 (file)
--- a/src/lib/ecore_imf/Ecore_IMF.h
+++ b/src/lib/ecore_imf/Ecore_IMF.h
@@ -923,6 +923,8 @@ EAPI void                          ecore_imf_context_use_preedit_set(Ecore_IMF_C
  *
  * This callback will be called when the Input Method Context
  * module requests the surrounding context.
+ * Input methods typically want context in order to constrain input text based on existing text;
+ * this is important for languages such as Thai where only some sequences of characters are allowed.
  *
  * @param ctx An #Ecore_IMF_Context.
  * @param func The callback to be called.