From: raster Date: Thu, 10 Mar 2011 09:15:36 +0000 (+0000) Subject: From: Jihoon Kim X-Git-Tag: 2.0_alpha~194^2~178 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=592657aa6c489bc6a0e41cbd56502be7d296a0ea;p=framework%2Fuifw%2Fecore.git From: Jihoon Kim Subject: [E-devel] [PATCH] patch for describing ecore_imf APIs more detail This patch will supplement the documentation about ecore_imf_context_preedit_start_event_add, ecore_imf_context_preedit_end_event_add and ecore_imf_context_delete_surrounding_event_add API. git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/ecore@57659 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- diff --git a/src/lib/ecore_imf/ecore_imf_context.c b/src/lib/ecore_imf/ecore_imf_context.c index d99136a..0bb2354 100644 --- a/src/lib/ecore_imf/ecore_imf_context.c +++ b/src/lib/ecore_imf/ecore_imf_context.c @@ -740,6 +740,8 @@ _ecore_imf_event_free_preedit(void *data __UNUSED__, void *event) /** * Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue. * + * ECORE_IMF_EVENT_PREEDIT_START should be added when a new preedit sequence starts. + * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Module_Group */ @@ -764,6 +766,8 @@ ecore_imf_context_preedit_start_event_add(Ecore_IMF_Context *ctx) /** * Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue. * + * ECORE_IMF_EVENT_PREEDIT_END should be added when a new preedit sequence has been completed or canceled. + * * @param ctx An #Ecore_IMF_Context. * @ingroup Ecore_IMF_Context_Module_Group */ @@ -855,6 +859,10 @@ _ecore_imf_event_free_delete_surrounding(void *data __UNUSED__, void *event) /** * Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. * + * Asks the widget that the input context is attached to to delete characters around the cursor position + * by adding the ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. + * Note that offset and n_chars are in characters not in bytes. + * * @param ctx An #Ecore_IMF_Context. * @param offset The start offset of surrounding to be deleted. * @param n_chars The number of characters to be deleted.