<html>
<head>
<title>Ecore: Ecore Input Method Context Module Functions</title>
<meta http-equiv="content-type" content="text/html;charset=UTF-8">
<meta name="author" content="Andres Blanc" >
<link rel="icon" href="img/favicon.png" type="image/x-icon">
<link rel="shortcut icon" href="img/favicon.png" type="image/x-icon">
<link rel="icon" href="img/favicon.png" type="image/ico">
<link rel="shortcut icon" href="img/favicon.png" type="image/ico">
<link rel="stylesheet" type="text/css" href="e.css">
<link rel="stylesheet" type="text/css" href="edoxy.css">
</head>
<body>
<div id="container">
<div id="header">
<div class="layout">
<h1><span>Enlightenment</span></h1>
<h2><span>Beauty at your fingertips</span></h2>
<table cellspacing="0" cellpadding="0" width="100%"><tr>
<td id="header_logo">
<a href="http://www.enlightenment.org"></a>
</td>
<td id="header_menu">
<table cellspacing="0" cellpadding="0" align="right"><tr>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=home">Home</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=news">News</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=about">About</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=download">Download</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=support">Support</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contribute">Contribute</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=contact">Contact</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://trac.enlightenment.org/e">Tracker</a></td>
<td class="nav_passive"><a class="nav_passive" href="http://www.enlightenment.org/p.php?p=docs">Docs</a></td>
</tr></table>
</td>
<td id="header_last"></td>
</tr></table>
<div class="doxytitle">
Ecore Documentation <small>at 2 Jul 2010</small>
</div>
<div class="menu-container">
<div class="submenu">
<ul class="current">
<li><a href="files.html">Files</a></li>
<li><a href="annotated.html">Data Structures</a></li>
<li><a href="globals.html">Globals</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="pages.html">Related Pages</a></li>
<li class="current"><a href="index.html">Main Page</a></li>
</ul>
</div>
</div>
<div class="clear"></div>
</div>
</div>
<div id="content">
<div class="layout">
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="contents">
<h1>Ecore Input Method Context Module Functions</h1>
<p>Functions that should be used by Ecore Input Method Context modules.
<a href="#_details">More...</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI Ecore_IMF_Context * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga4b46b1cc69a0bd7cd624f3cd8b3a46c5">ecore_imf_context_new</a> (const Ecore_IMF_Context_Class *ctxc)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new Input Method Context with klass specified by <code>ctxc</code>. <a href="#ga4b46b1cc69a0bd7cd624f3cd8b3a46c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga95642efd0cdd77e50c91742781b8d425">ecore_imf_context_data_set</a> (Ecore_IMF_Context *ctx, void *data)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Input Method Context specific data. <a href="#ga95642efd0cdd77e50c91742781b8d425"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga3a38cfe133cdaf9f21ad86fd18cc28df">ecore_imf_context_data_get</a> (Ecore_IMF_Context *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Input Method Context specific data. <a href="#ga3a38cfe133cdaf9f21ad86fd18cc28df"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga1acb7370886c5fbd1a2e42356d455093">ecore_imf_context_surrounding_get</a> (Ecore_IMF_Context *ctx, char **text, int *cursor_pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieve context around insertion point. <a href="#ga1acb7370886c5fbd1a2e42356d455093"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga98b68c7499b34ebe646fbade6a86785e">ecore_imf_context_preedit_start_event_add</a> (Ecore_IMF_Context *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue. <a href="#ga98b68c7499b34ebe646fbade6a86785e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga5019c52ef13814f335fa6ce0420dc73b">ecore_imf_context_preedit_end_event_add</a> (Ecore_IMF_Context *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue. <a href="#ga5019c52ef13814f335fa6ce0420dc73b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#gad803c974e6244fcabd5d0267c63fb1ec">ecore_imf_context_preedit_changed_event_add</a> (Ecore_IMF_Context *ctx)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue. <a href="#gad803c974e6244fcabd5d0267c63fb1ec"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga034f987c1874719a0c6f5b3c43bdbb6a">ecore_imf_context_commit_event_add</a> (Ecore_IMF_Context *ctx, const char *str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds ECORE_IMF_EVENT_COMMIT to the event queue. <a href="#ga034f987c1874719a0c6f5b3c43bdbb6a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">EAPI void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Ecore__IMF__Context__Module__Group.html#gafbb709924fdc668fb74ffd986f959715">ecore_imf_context_delete_surrounding_event_add</a> (Ecore_IMF_Context *ctx, int offset, int n_chars)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. <a href="#gafbb709924fdc668fb74ffd986f959715"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Functions that should be used by Ecore Input Method Context modules. </p>
<hr/><h2>Function Documentation</h2>
<a class="anchor" id="ga034f987c1874719a0c6f5b3c43bdbb6a"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_commit_event_add" ref="ga034f987c1874719a0c6f5b3c43bdbb6a" args="(Ecore_IMF_Context *ctx, const char *str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_commit_event_add </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds ECORE_IMF_EVENT_COMMIT to the event queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>The committed string. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="ecore__events_8c_source.html#l00189">ecore_event_add()</a>.</p>
</div>
</div>
<a class="anchor" id="ga3a38cfe133cdaf9f21ad86fd18cc28df"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_data_get" ref="ga3a38cfe133cdaf9f21ad86fd18cc28df" args="(Ecore_IMF_Context *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void* ecore_imf_context_data_get </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the Input Method Context specific data. </p>
<p>See <a class="el" href="group__Ecore__IMF__Context__Module__Group.html#ga95642efd0cdd77e50c91742781b8d425">ecore_imf_context_data_set</a> for more details.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The Input Method Context specific data. </dd></dl>
</div>
</div>
<a class="anchor" id="ga95642efd0cdd77e50c91742781b8d425"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_data_set" ref="ga95642efd0cdd77e50c91742781b8d425" args="(Ecore_IMF_Context *ctx, void *data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_data_set </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>data</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Set the Input Method Context specific data. </p>
<p>Note that this method should be used by modules to set the Input Method Context specific data and it's not meant to be used by applications to store application specific data.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>The Input Method Context specific data. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new Ecore_IMF_Context; on failure it returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="gafbb709924fdc668fb74ffd986f959715"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_delete_surrounding_event_add" ref="gafbb709924fdc668fb74ffd986f959715" args="(Ecore_IMF_Context *ctx, int offset, int n_chars)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_delete_surrounding_event_add </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n_chars</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds ECORE_IMF_EVENT_DELETE_SURROUNDING to the event queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The start offset of surrounding to be deleted. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>n_chars</em> </td><td>The number of characters to be deleted. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="ecore__events_8c_source.html#l00189">ecore_event_add()</a>.</p>
</div>
</div>
<a class="anchor" id="ga4b46b1cc69a0bd7cd624f3cd8b3a46c5"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_new" ref="ga4b46b1cc69a0bd7cd624f3cd8b3a46c5" args="(const Ecore_IMF_Context_Class *ctxc)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI Ecore_IMF_Context* ecore_imf_context_new </td>
<td>(</td>
<td class="paramtype">const Ecore_IMF_Context_Class * </td>
<td class="paramname"> <em>ctxc</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new Input Method Context with klass specified by <code>ctxc</code>. </p>
<p>This method should be used by modules implementing the Input Method Context interface.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctxc</em> </td><td>An Ecore_IMF_Context_Class. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new Ecore_IMF_Context; on failure it returns NULL. </dd></dl>
</div>
</div>
<a class="anchor" id="gad803c974e6244fcabd5d0267c63fb1ec"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_preedit_changed_event_add" ref="gad803c974e6244fcabd5d0267c63fb1ec" args="(Ecore_IMF_Context *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_preedit_changed_event_add </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds ECORE_IMF_EVENT_PREEDIT_CHANGED to the event queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="ecore__events_8c_source.html#l00189">ecore_event_add()</a>.</p>
</div>
</div>
<a class="anchor" id="ga5019c52ef13814f335fa6ce0420dc73b"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_preedit_end_event_add" ref="ga5019c52ef13814f335fa6ce0420dc73b" args="(Ecore_IMF_Context *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_preedit_end_event_add </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds ECORE_IMF_EVENT_PREEDIT_END to the event queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="ecore__events_8c_source.html#l00189">ecore_event_add()</a>.</p>
</div>
</div>
<a class="anchor" id="ga98b68c7499b34ebe646fbade6a86785e"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_preedit_start_event_add" ref="ga98b68c7499b34ebe646fbade6a86785e" args="(Ecore_IMF_Context *ctx)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI void ecore_imf_context_preedit_start_event_add </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds ECORE_IMF_EVENT_PREEDIT_START to the event queue. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="ecore__events_8c_source.html#l00189">ecore_event_add()</a>.</p>
</div>
</div>
<a class="anchor" id="ga1acb7370886c5fbd1a2e42356d455093"></a><!-- doxytag: member="ecore_imf_context.c::ecore_imf_context_surrounding_get" ref="ga1acb7370886c5fbd1a2e42356d455093" args="(Ecore_IMF_Context *ctx, char **text, int *cursor_pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">EAPI int ecore_imf_context_surrounding_get </td>
<td>(</td>
<td class="paramtype">Ecore_IMF_Context * </td>
<td class="paramname"> <em>ctx</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>cursor_pos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Retrieve context around insertion point. </p>
<p>This function is implemented by calling the Ecore_IMF_Context::retrieve_surrounding_func ( set using <a class="el" href="group__Ecore__IMF__Context__Group.html#ga54a8ce0a62f2c02713bb64d8550256ab" title="Set the callback to be used on get_surrounding request.">ecore_imf_context_retrieve_surrounding_callback_set</a>).</p>
<p>There is no obligation for a widget to respond to the retrieve_surrounding_func, so input methods must be prepared to function without context.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>ctx</em> </td><td>An Ecore_IMF_Context. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>Location to store a UTF-8 encoded string of text holding context around the insertion point. If the function returns 1, then you must free the result stored in this location with free(). </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cursor_pos</em> </td><td>Location to store the position in characters of the insertion cursor within . </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>1 if surrounding text was provided; otherwise 0. </dd></dl>
</div>
</div>
</div>
<div id="push"></div>
</div> <!-- #content -->
</div> <!-- .layout -->
</div> <!-- #container -->
<div id="footer">
<table><tr>
<td class="copyright">Copyright ©2010 Enlightenment</td>
<td class="generated">Docs generated Fri Jul 2 12:11:49 2010</td>
</tr></table>
</div>
</body>
</html>
