<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>scim: scim::FrontEndBase Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00157.html">scim</a>::<a class="el" href="a00031.html">FrontEndBase</a>
</div>
</div>
<div class="contents">
<h1>scim::FrontEndBase Class Reference<br>
<small>
[<a class="el" href="a00162.html">FrontEnd</a>]</small>
</h1><!-- doxytag: class="scim::FrontEndBase" --><!-- doxytag: inherits="scim::ReferencedObject" -->The base class to implement the FrontEnd objects.
<a href="#_details">More...</a>
<p>
<code>#include <scim_frontend.h></code>
<p>
<p>
<a href="a00241.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#6783ddfd9eed090ac50e047b88748b92">FrontEndBase</a> (const <a class="el" href="a00070.html">BackEndPointer</a> &backend)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#6783ddfd9eed090ac50e047b88748b92"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#cab6061966688e8ea9864616c11bbd55">~FrontEndBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor. <a href="#cab6061966688e8ea9864616c11bbd55"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#23c667257ca98dd7ffb38ac2fa3350ad">init</a> (int argc, char **argv)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">init the frontend. <a href="#23c667257ca98dd7ffb38ac2fa3350ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#47a5c570b4dc44d06f9be4a24307fefc">run</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">run the frontend. <a href="#47a5c570b4dc44d06f9be4a24307fefc"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">functions can be used by derived classes.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#352a88a6f138d5876655583492bc8e9f">get_factory_list_for_encoding</a> (std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &uuids, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the IMEngine factories list for specific encoding. <a href="#352a88a6f138d5876655583492bc8e9f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#1c130b0cb2659fb4ce25a27fb74aa199">get_factory_list_for_language</a> (std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &uuids, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &language) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the IMEngine factories list for specific language. <a href="#1c130b0cb2659fb4ce25a27fb74aa199"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#98acaa9a67d9c3826bd1538e056dad8e">get_default_factory</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &language, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default IMEngineFactory UUID for a specific language and encoding. <a href="#98acaa9a67d9c3826bd1538e056dad8e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#b0cfca14d95005d1a25a1eb3a107a6d2">set_default_factory</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &language, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default IMEngineFactory for a specific language. <a href="#b0cfca14d95005d1a25a1eb3a107a6d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#40944f838ce2ddcfade5ec60146229b7">get_next_factory</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &language, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &cur_uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the next IMEngineFactory for a specific language and encoding. <a href="#40944f838ce2ddcfade5ec60146229b7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#3037af63749940e09dd8ee1c4d589715">get_previous_factory</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &language, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &cur_uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the previous IMEngineFactory for a specific language and encoding. <a href="#3037af63749940e09dd8ee1c4d589715"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#c4a853ce3906ca13695b983af66d8977">get_factory_name</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the name of an IMEngine factory. <a href="#c4a853ce3906ca13695b983af66d8977"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#7a049f826841880b3a71293631f8f2da">get_factory_authors</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the authors info of an IMEngine factory. <a href="#7a049f826841880b3a71293631f8f2da"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#0634b1ffdd43a1c0b1fbcb4fc041e159">get_factory_credits</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the credits info of an IMEngine factory. <a href="#0634b1ffdd43a1c0b1fbcb4fc041e159"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#9ce1dae0ac0395cea105bcc380196357">get_factory_help</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the help info of an IMEngine factory. <a href="#9ce1dae0ac0395cea105bcc380196357"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#2c11f9ca725014db54132cade41092af">get_factory_icon_file</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the icon file of an IMEngine factory. <a href="#2c11f9ca725014db54132cade41092af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#340d20e6e594847dce1ed821ee00cae0">get_factory_locales</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the supported locales of an IMEngine factory. <a href="#340d20e6e594847dce1ed821ee00cae0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#b0912444817a90fcad7bf763c6166131">get_factory_language</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the language of an IMEngine factory. <a href="#b0912444817a90fcad7bf763c6166131"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#42a018684425c6d832c5d0a5b5dc13f3">validate_factory</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &uuid, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding=<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>("")) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if an IMEngine factory is valid and the given encoding is supported by it. <a href="#42a018684425c6d832c5d0a5b5dc13f3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ae906626db02b64aad2cfccf6b56e529">get_all_locales</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get all locales supported by BackEnd. <a href="#ae906626db02b64aad2cfccf6b56e529"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#335dfd90e0f0145d53a33fd36d70f65d">new_instance</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &sf_uuid, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">create a new IMEngine instance for specific encoding. <a href="#335dfd90e0f0145d53a33fd36d70f65d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#c3491123bae81e02c106d0d49bd018b2">replace_instance</a> (int si_id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &sf_uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">replace an IMEngine instance by a new instance created by another factory. <a href="#c3491123bae81e02c106d0d49bd018b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#9b29258e5632d8d6827602978a57cb54">delete_instance</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">delete an IMEngine instance according to its id. <a href="#9b29258e5632d8d6827602978a57cb54"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#78f6a0030168d54369dc4d961e97517e">delete_all_instances</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">delete all IMEngine instances. <a href="#78f6a0030168d54369dc4d961e97517e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#17a37c79a94ab6e7a23b5eed3bd18fb6">get_instance_uuid</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the factory uuid of this instance. <a href="#17a37c79a94ab6e7a23b5eed3bd18fb6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#7f2e41305a4d59a81907bad66b76be5f">get_instance_encoding</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the working encoding of an IMEngine instance. <a href="#7f2e41305a4d59a81907bad66b76be5f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#a79ffa06fde67b64bbd224ae653028aa">get_instance_name</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the name of an IMEngine instance. <a href="#a79ffa06fde67b64bbd224ae653028aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ce99fffed3a155ee57d3059b3f43fbc4">get_instance_authors</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the authors info of an IMEngine instance. <a href="#ce99fffed3a155ee57d3059b3f43fbc4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#b2cf07926e41af44abe9b0cc5ae1d3fd">get_instance_credits</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the credits info of an IMEngine instance. <a href="#b2cf07926e41af44abe9b0cc5ae1d3fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#38781432750f4dcaa1dd5771e5c06d5e">get_instance_help</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the help of an IMEngine instance. <a href="#38781432750f4dcaa1dd5771e5c06d5e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#8b8721a3350894e8478a306e6c3297f6">get_instance_icon_file</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">get the icon file of an IMEngine instance. <a href="#8b8721a3350894e8478a306e6c3297f6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#c3052a4e273a7abb96e36d8c41425019">process_key_event</a> (int id, const <a class="el" href="a00054.html">KeyEvent</a> &key) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">process a key event using specific IMEngine instance. <a href="#c3052a4e273a7abb96e36d8c41425019"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#f27e649ec76e20b58900aa33e6753bda">move_preedit_caret</a> (int id, unsigned int pos) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">let a specific IMEngine instance move its preedit caret. <a href="#f27e649ec76e20b58900aa33e6753bda"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#5e03961dc73abf47d5bc530cd035c373">select_candidate</a> (int id, unsigned int index) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">let a specific IMEngine instance select a candidate in its current lookup table. <a href="#5e03961dc73abf47d5bc530cd035c373"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#8ce34eef567dffc60991f01a6598d530">update_lookup_table_page_size</a> (int id, unsigned int page_size) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the page size of a specific IMEngine instance's lookup table. <a href="#8ce34eef567dffc60991f01a6598d530"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#6a56e68fc8b788df0375416a8fba96e4">lookup_table_page_up</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Let a specific IMEngine instance flip its lookup table to the previous page. <a href="#6a56e68fc8b788df0375416a8fba96e4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#341d41296d921038faa907ee5d06ddd0">lookup_table_page_down</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Let a specific IMEngine instance flip its lookup table to the previous page. <a href="#341d41296d921038faa907ee5d06ddd0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#935de661fdb49af2ed8bae9571b5150d">reset</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">reset a specific IMEngine instance. <a href="#935de661fdb49af2ed8bae9571b5150d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#18107e808bd2f386d7363eab082504fd">focus_in</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">focus in a specific IMEngine instance. <a href="#18107e808bd2f386d7363eab082504fd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#4d6625e245abd97c324edc024941d8df">focus_out</a> (int id) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">focus out a specific IMEngine instance. <a href="#4d6625e245abd97c324edc024941d8df"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#90764ba82b2cf4f2055e2ef2b70f7c2f">trigger_property</a> (int id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &property) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">trigger a property of a specific IMEngine instance. <a href="#90764ba82b2cf4f2055e2ef2b70f7c2f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#b41503dd94c1726ff63af9d2957fc73a">process_helper_event</a> (int id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid, const <a class="el" href="a00109.html">Transaction</a> &trans) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">let a specific IMEngine instance to process the events sent from a Helper process. <a href="#b41503dd94c1726ff63af9d2957fc73a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#1eae6b6d000b0060fe3b0127089ab325">update_client_capabilities</a> (int id, unsigned int cap) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">let a specific IMEngine instance to update itself according to the capabilities of the client application. <a href="#1eae6b6d000b0060fe3b0127089ab325"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Virtual protected methods.</div></td></tr>
<tr><td colspan="2"><div class="groupText">The following methods should be implemented by derivation classes. these functions handle the real things. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#e32756a7e673c5aeca89535163ef5080">show_preedit_string</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">show preedit string area for an IMEngine instance. <a href="#e32756a7e673c5aeca89535163ef5080"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#80cd49d9d9ed0983d27a5fff728dfd89">show_aux_string</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">show aux string area for an IMEngine instance. <a href="#80cd49d9d9ed0983d27a5fff728dfd89"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#5b77442bc2edc76a6260bc0c2890f373">show_lookup_table</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">show lookup table area for an IMEngine instance. <a href="#5b77442bc2edc76a6260bc0c2890f373"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#1c7556c9304a1a16c61ec09b22f69665">hide_preedit_string</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">hide preedit string area for an IMEngine instance. <a href="#1c7556c9304a1a16c61ec09b22f69665"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#24c447383232be3cd2d29b33303e03ed">hide_aux_string</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">hide aux string area for an IMEngine instance. <a href="#24c447383232be3cd2d29b33303e03ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#5bb8e20318305d85966b04624ebaaae2">hide_lookup_table</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">hide lookup table area for an IMEngine instance. <a href="#5bb8e20318305d85966b04624ebaaae2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#1b223891d0b53a56ea28ae03ebc4fc25">update_preedit_caret</a> (int id, int caret)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the position of preedit caret for an IMEngine instance. <a href="#1b223891d0b53a56ea28ae03ebc4fc25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#e3ee6e4240c36fc21a72eda7ea27b01c">update_preedit_string</a> (int id, const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the content of preedit string for an IMEngine instance. <a href="#e3ee6e4240c36fc21a72eda7ea27b01c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#8f79274e43f37274a007bcdeb5909637">update_aux_string</a> (int id, const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the content of aux string for an IMEngine instance. <a href="#8f79274e43f37274a007bcdeb5909637"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#3dc686f04c57fa0b4febd18ef340dd44">update_lookup_table</a> (int id, const <a class="el" href="a00055.html">LookupTable</a> &table)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update the content of lookup table for an IMEngine instance. <a href="#3dc686f04c57fa0b4febd18ef340dd44"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#659130d24d88f7a6ec0faa7e6005e5c5">commit_string</a> (int id, const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">commit a string to client for an IMEngine instance. <a href="#659130d24d88f7a6ec0faa7e6005e5c5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#ba5c367eb5d97c6c2ac73b534d9757f2">forward_key_event</a> (int id, const <a class="el" href="a00054.html">KeyEvent</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">forward a keyevent to the client of an IMEngine instance. <a href="#ba5c367eb5d97c6c2ac73b534d9757f2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#4f7f90ce37c5cbdeeaaa4975489ef524">register_properties</a> (int id, const <a class="el" href="a00158.html#gc4099a109cec998bbfad588fcf4c8f79">PropertyList</a> &properties)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">register all the properties of an IMEngine instance into this FrontEnd. <a href="#4f7f90ce37c5cbdeeaaa4975489ef524"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#d5f92d1555fb5ae9ad6b18b7c39fdfc6">update_property</a> (int id, const <a class="el" href="a00071.html">Property</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">update a property of an IMEngine instance. <a href="#d5f92d1555fb5ae9ad6b18b7c39fdfc6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#fa7dca7ca69da450582d5c33037aa582">beep</a> (int id)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">generate a short beep. <a href="#fa7dca7ca69da450582d5c33037aa582"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#f7625d9de95b71d572438af27b2bc729">start_helper</a> (int id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">start a Client Helper process. <a href="#f7625d9de95b71d572438af27b2bc729"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#776d4b1d2dc32d5e5e876e61c79d1991">stop_helper</a> (int id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">stop a Client Helper process. <a href="#776d4b1d2dc32d5e5e876e61c79d1991"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#80083a4d5baf7427c3ec28149486dd67">send_helper_event</a> (int id, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid, const <a class="el" href="a00109.html">Transaction</a> &trans)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">send an events transaction to a Client Helper process. <a href="#80083a4d5baf7427c3ec28149486dd67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#0e96dc9e293b4257a0aca5012bf788d0">get_surrounding_text</a> (int id, <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &text, int &cursor, int maxlen_before, int maxlen_after)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Retrieves context around the insertion point. <a href="#0e96dc9e293b4257a0aca5012bf788d0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#3046540fc1635193a44179240432d34e">delete_surrounding_text</a> (int id, int offset, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Ask the client to delete characters around the cursor position. <a href="#3046540fc1635193a44179240432d34e"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html#2c94fac0705cba97d78b572636c34f2a">FrontEndBaseImpl</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base class to implement the FrontEnd objects.
<p>
FrontEnd is an interface between IMEngineFactory/IMEngineInstance objects and the user applications. It forward the user requests to IMEngineFactory/IMEngineInstance objects, and handle the requests sent back. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6783ddfd9eed090ac50e047b88748b92"></a><!-- doxytag: member="scim::FrontEndBase::FrontEndBase" ref="6783ddfd9eed090ac50e047b88748b92" args="(const BackEndPointer &backend)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FrontEndBase::FrontEndBase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">BackEndPointer</a> & </td>
<td class="paramname"> <em>backend</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>backend</em> </td><td>A BackEnd object which holds all IMEngineFactory objects. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="cab6061966688e8ea9864616c11bbd55"></a><!-- doxytag: member="scim::FrontEndBase::~FrontEndBase" ref="cab6061966688e8ea9864616c11bbd55" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::FrontEndBase::~FrontEndBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="352a88a6f138d5876655583492bc8e9f"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_list_for_encoding" ref="352a88a6f138d5876655583492bc8e9f" args="(std::vector< String > &uuids, const String &encoding) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> scim::FrontEndBase::get_factory_list_for_encoding </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>uuids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the IMEngine factories list for specific encoding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuids</em> </td><td>the vector to store the factories' uuids which support the encoding. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>the encoding to be queried. If empty, all IMEngine factories will be returned.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of IMEngine factories found. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1c130b0cb2659fb4ce25a27fb74aa199"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_list_for_language" ref="1c130b0cb2659fb4ce25a27fb74aa199" args="(std::vector< String > &uuids, const String &language) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> scim::FrontEndBase::get_factory_list_for_language </td>
<td>(</td>
<td class="paramtype">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>uuids</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>language</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the IMEngine factories list for specific language.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuids</em> </td><td>the vector to store the factories' uuids which support the encoding. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language to be queried. If empty, all IMEngine factories will be returned.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of IMEngine factories found. </dd></dl>
</div>
</div><p>
<a class="anchor" name="98acaa9a67d9c3826bd1538e056dad8e"></a><!-- doxytag: member="scim::FrontEndBase::get_default_factory" ref="98acaa9a67d9c3826bd1538e056dad8e" args="(const String &language, const String &encoding) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_default_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the default IMEngineFactory UUID for a specific language and encoding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language to be queried. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>the encoding to be queried, if empty then don't match encoding.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the UUID of the default IMEngineFactory for this language. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b0cfca14d95005d1a25a1eb3a107a6d2"></a><!-- doxytag: member="scim::FrontEndBase::set_default_factory" ref="b0cfca14d95005d1a25a1eb3a107a6d2" args="(const String &language, const String &uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::set_default_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default IMEngineFactory for a specific language.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the default IMEngineFactory for this language. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="40944f838ce2ddcfade5ec60146229b7"></a><!-- doxytag: member="scim::FrontEndBase::get_next_factory" ref="40944f838ce2ddcfade5ec60146229b7" args="(const String &language, const String &encoding, const String &cur_uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_next_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>cur_uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the next IMEngineFactory for a specific language and encoding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language to be queried, if empty then don't match language. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>the encoding to be queried, if empty then don't match encoding. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cur_uuid</em> </td><td>the UUID of current IMEngineFactory.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the UUID of the next IMEngineFactory for this language and encoding corresponding to the current IMEngineFactory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3037af63749940e09dd8ee1c4d589715"></a><!-- doxytag: member="scim::FrontEndBase::get_previous_factory" ref="3037af63749940e09dd8ee1c4d589715" args="(const String &language, const String &encoding, const String &cur_uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_previous_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>language</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>cur_uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the previous IMEngineFactory for a specific language and encoding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>language</em> </td><td>the language to be queried, if empty then don't match language. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>the encoding to be queried, if empty then don't match encoding. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cur_uuid</em> </td><td>the UUID of current IMEngineFactory.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the UUID of the previous IMEngineFactory for this language and encoding corresponding to the current IMEngineFactory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c4a853ce3906ca13695b983af66d8977"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_name" ref="c4a853ce3906ca13695b983af66d8977" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_factory_name </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the name of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the name of the IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7a049f826841880b3a71293631f8f2da"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_authors" ref="7a049f826841880b3a71293631f8f2da" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_factory_authors </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the authors info of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the authors info of the IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0634b1ffdd43a1c0b1fbcb4fc041e159"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_credits" ref="0634b1ffdd43a1c0b1fbcb4fc041e159" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_factory_credits </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the credits info of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the credits info of the IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9ce1dae0ac0395cea105bcc380196357"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_help" ref="9ce1dae0ac0395cea105bcc380196357" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_factory_help </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the help info of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the help info of the IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2c11f9ca725014db54132cade41092af"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_icon_file" ref="2c11f9ca725014db54132cade41092af" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_factory_icon_file </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the icon file of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the icon file name of the IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="340d20e6e594847dce1ed821ee00cae0"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_locales" ref="340d20e6e594847dce1ed821ee00cae0" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_factory_locales </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the supported locales of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a comma separated list of the supported locales. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b0912444817a90fcad7bf763c6166131"></a><!-- doxytag: member="scim::FrontEndBase::get_factory_language" ref="b0912444817a90fcad7bf763c6166131" args="(const String &uuid) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_factory_language </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the language of an IMEngine factory.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>the uuid of the IMEngine factory </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the language of this IMEngine factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="42a018684425c6d832c5d0a5b5dc13f3"></a><!-- doxytag: member="scim::FrontEndBase::validate_factory" ref="42a018684425c6d832c5d0a5b5dc13f3" args="(const String &uuid, const String &encoding=String("")) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndBase::validate_factory </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em> = <code><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>("")</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if an IMEngine factory is valid and the given encoding is supported by it.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uuid</em> </td><td>The uuid of the IMEngine factory to be checked. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>The encoding should be supported by the factory. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the factory is valid and the given encoding is supported. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ae906626db02b64aad2cfccf6b56e529"></a><!-- doxytag: member="scim::FrontEndBase::get_all_locales" ref="ae906626db02b64aad2cfccf6b56e529" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_all_locales </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get all locales supported by BackEnd.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a comman separated list of all supported locales. </dd></dl>
</div>
</div><p>
<a class="anchor" name="335dfd90e0f0145d53a33fd36d70f65d"></a><!-- doxytag: member="scim::FrontEndBase::new_instance" ref="335dfd90e0f0145d53a33fd36d70f65d" args="(const String &sf_uuid, const String &encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::FrontEndBase::new_instance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>sf_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
create a new IMEngine instance for specific encoding.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sf_uuid</em> </td><td>the IMEngineFactory UUID. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoding</em> </td><td>the encoding to be used.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the newly created IMEngine instance id, -1 means error occurred. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3491123bae81e02c106d0d49bd018b2"></a><!-- doxytag: member="scim::FrontEndBase::replace_instance" ref="c3491123bae81e02c106d0d49bd018b2" args="(int si_id, const String &sf_uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndBase::replace_instance </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>si_id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>sf_uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
replace an IMEngine instance by a new instance created by another factory.
<p>
This function is used to change the input method for an input context on the fly.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>si_id</em> </td><td>the IMEngine instance to be replaced. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>sf_uuid</em> </td><td>the new IMEngine factory to be used. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9b29258e5632d8d6827602978a57cb54"></a><!-- doxytag: member="scim::FrontEndBase::delete_instance" ref="9b29258e5632d8d6827602978a57cb54" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndBase::delete_instance </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
delete an IMEngine instance according to its id.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance to be deleted. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, false if there is no such instance. </dd></dl>
</div>
</div><p>
<a class="anchor" name="78f6a0030168d54369dc4d961e97517e"></a><!-- doxytag: member="scim::FrontEndBase::delete_all_instances" ref="78f6a0030168d54369dc4d961e97517e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::delete_all_instances </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
delete all IMEngine instances.
<p>
This function should be called just before quitting the FrontEnd.
</div>
</div><p>
<a class="anchor" name="17a37c79a94ab6e7a23b5eed3bd18fb6"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_uuid" ref="17a37c79a94ab6e7a23b5eed3bd18fb6" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_instance_uuid </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the factory uuid of this instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the factory uuid of this instance. </dd></dl>
</div>
</div><p>
<a class="anchor" name="7f2e41305a4d59a81907bad66b76be5f"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_encoding" ref="7f2e41305a4d59a81907bad66b76be5f" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_instance_encoding </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the working encoding of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the working encoding of this IMEngine instance. </dd></dl>
</div>
</div><p>
<a class="anchor" name="a79ffa06fde67b64bbd224ae653028aa"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_name" ref="a79ffa06fde67b64bbd224ae653028aa" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_instance_name </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the name of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the name of this IMEngine instance, aka. the name of its factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="ce99fffed3a155ee57d3059b3f43fbc4"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_authors" ref="ce99fffed3a155ee57d3059b3f43fbc4" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_instance_authors </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the authors info of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the authors info of this IMEngine instance, aka. the authors of its factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="b2cf07926e41af44abe9b0cc5ae1d3fd"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_credits" ref="b2cf07926e41af44abe9b0cc5ae1d3fd" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_instance_credits </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the credits info of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the credits info of this IMEngine instance, aka. the credits of its factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="38781432750f4dcaa1dd5771e5c06d5e"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_help" ref="38781432750f4dcaa1dd5771e5c06d5e" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FrontEndBase::get_instance_help </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the help of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the help of this IMEngine instance, aka. the help of its factory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="8b8721a3350894e8478a306e6c3297f6"></a><!-- doxytag: member="scim::FrontEndBase::get_instance_icon_file" ref="8b8721a3350894e8478a306e6c3297f6" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FrontEndBase::get_instance_icon_file </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
get the icon file of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the icon file name of this IMEngine instance. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c3052a4e273a7abb96e36d8c41425019"></a><!-- doxytag: member="scim::FrontEndBase::process_key_event" ref="c3052a4e273a7abb96e36d8c41425019" args="(int id, const KeyEvent &key) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndBase::process_key_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00054.html">KeyEvent</a> & </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
process a key event using specific IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the key event to be processed. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the event was processed successfully, false if the event was not processed and should be forward to the client application. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f27e649ec76e20b58900aa33e6753bda"></a><!-- doxytag: member="scim::FrontEndBase::move_preedit_caret" ref="f27e649ec76e20b58900aa33e6753bda" args="(int id, unsigned int pos) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::move_preedit_caret </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>pos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
let a specific IMEngine instance move its preedit caret.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>the new preedit caret position. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5e03961dc73abf47d5bc530cd035c373"></a><!-- doxytag: member="scim::FrontEndBase::select_candidate" ref="5e03961dc73abf47d5bc530cd035c373" args="(int id, unsigned int index) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::select_candidate </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
let a specific IMEngine instance select a candidate in its current lookup table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>index</em> </td><td>the candidate index in current lookup table page to be selected. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8ce34eef567dffc60991f01a6598d530"></a><!-- doxytag: member="scim::FrontEndBase::update_lookup_table_page_size" ref="8ce34eef567dffc60991f01a6598d530" args="(int id, unsigned int page_size) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::update_lookup_table_page_size </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>page_size</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the page size of a specific IMEngine instance's lookup table.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the IMEngine instance id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>page_size</em> </td><td>the new page size to be used. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6a56e68fc8b788df0375416a8fba96e4"></a><!-- doxytag: member="scim::FrontEndBase::lookup_table_page_up" ref="6a56e68fc8b788df0375416a8fba96e4" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::lookup_table_page_up </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Let a specific IMEngine instance flip its lookup table to the previous page.
<p>
</div>
</div><p>
<a class="anchor" name="341d41296d921038faa907ee5d06ddd0"></a><!-- doxytag: member="scim::FrontEndBase::lookup_table_page_down" ref="341d41296d921038faa907ee5d06ddd0" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::lookup_table_page_down </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Let a specific IMEngine instance flip its lookup table to the previous page.
<p>
</div>
</div><p>
<a class="anchor" name="935de661fdb49af2ed8bae9571b5150d"></a><!-- doxytag: member="scim::FrontEndBase::reset" ref="935de661fdb49af2ed8bae9571b5150d" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::reset </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
reset a specific IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance to be reset. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="18107e808bd2f386d7363eab082504fd"></a><!-- doxytag: member="scim::FrontEndBase::focus_in" ref="18107e808bd2f386d7363eab082504fd" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::focus_in </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
focus in a specific IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance to be focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4d6625e245abd97c324edc024941d8df"></a><!-- doxytag: member="scim::FrontEndBase::focus_out" ref="4d6625e245abd97c324edc024941d8df" args="(int id) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::focus_out </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
focus out a specific IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance to be focused out. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="90764ba82b2cf4f2055e2ef2b70f7c2f"></a><!-- doxytag: member="scim::FrontEndBase::trigger_property" ref="90764ba82b2cf4f2055e2ef2b70f7c2f" args="(int id, const String &property) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::trigger_property </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>property</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
trigger a property of a specific IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>property</em> </td><td>the key of the property to be triggered. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="b41503dd94c1726ff63af9d2957fc73a"></a><!-- doxytag: member="scim::FrontEndBase::process_helper_event" ref="b41503dd94c1726ff63af9d2957fc73a" args="(int id, const String &helper_uuid, const Transaction &trans) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::process_helper_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>helper_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00109.html">Transaction</a> & </td>
<td class="paramname"> <em>trans</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
let a specific IMEngine instance to process the events sent from a Helper process.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>helper_uuid</em> </td><td>the uuid of the Helper process. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transaction which contains the events. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1eae6b6d000b0060fe3b0127089ab325"></a><!-- doxytag: member="scim::FrontEndBase::update_client_capabilities" ref="1eae6b6d000b0060fe3b0127089ab325" args="(int id, unsigned int cap) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndBase::update_client_capabilities </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>cap</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
let a specific IMEngine instance to update itself according to the capabilities of the client application.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cap</em> </td><td>the bitset of the capabilities which are supported by client. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e32756a7e673c5aeca89535163ef5080"></a><!-- doxytag: member="scim::FrontEndBase::show_preedit_string" ref="e32756a7e673c5aeca89535163ef5080" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::show_preedit_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
show preedit string area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="80cd49d9d9ed0983d27a5fff728dfd89"></a><!-- doxytag: member="scim::FrontEndBase::show_aux_string" ref="80cd49d9d9ed0983d27a5fff728dfd89" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::show_aux_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
show aux string area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5b77442bc2edc76a6260bc0c2890f373"></a><!-- doxytag: member="scim::FrontEndBase::show_lookup_table" ref="5b77442bc2edc76a6260bc0c2890f373" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::show_lookup_table </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
show lookup table area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1c7556c9304a1a16c61ec09b22f69665"></a><!-- doxytag: member="scim::FrontEndBase::hide_preedit_string" ref="1c7556c9304a1a16c61ec09b22f69665" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::hide_preedit_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
hide preedit string area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="24c447383232be3cd2d29b33303e03ed"></a><!-- doxytag: member="scim::FrontEndBase::hide_aux_string" ref="24c447383232be3cd2d29b33303e03ed" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::hide_aux_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
hide aux string area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5bb8e20318305d85966b04624ebaaae2"></a><!-- doxytag: member="scim::FrontEndBase::hide_lookup_table" ref="5bb8e20318305d85966b04624ebaaae2" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::hide_lookup_table </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
hide lookup table area for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1b223891d0b53a56ea28ae03ebc4fc25"></a><!-- doxytag: member="scim::FrontEndBase::update_preedit_caret" ref="1b223891d0b53a56ea28ae03ebc4fc25" args="(int id, int caret)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::update_preedit_caret </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>caret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the position of preedit caret for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>caret</em> </td><td>the new caret position. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e3ee6e4240c36fc21a72eda7ea27b01c"></a><!-- doxytag: member="scim::FrontEndBase::update_preedit_string" ref="e3ee6e4240c36fc21a72eda7ea27b01c" args="(int id, const WideString &str, const AttributeList &attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::update_preedit_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> & </td>
<td class="paramname"> <em>attrs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the content of preedit string for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the new content of preedit string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attrs</em> </td><td>the string attributes. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8f79274e43f37274a007bcdeb5909637"></a><!-- doxytag: member="scim::FrontEndBase::update_aux_string" ref="8f79274e43f37274a007bcdeb5909637" args="(int id, const WideString &str, const AttributeList &attrs)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::update_aux_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>str</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> & </td>
<td class="paramname"> <em>attrs</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the content of aux string for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the new content of aux string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attrs</em> </td><td>the string attributes. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="3dc686f04c57fa0b4febd18ef340dd44"></a><!-- doxytag: member="scim::FrontEndBase::update_lookup_table" ref="3dc686f04c57fa0b4febd18ef340dd44" args="(int id, const LookupTable &table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::update_lookup_table </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00055.html">LookupTable</a> & </td>
<td class="paramname"> <em>table</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update the content of lookup table for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>table</em> </td><td>the new lookup table. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="659130d24d88f7a6ec0faa7e6005e5c5"></a><!-- doxytag: member="scim::FrontEndBase::commit_string" ref="659130d24d88f7a6ec0faa7e6005e5c5" args="(int id, const WideString &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::commit_string </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>str</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
commit a string to client for an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance to commit the string. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>str</em> </td><td>the string to be committed. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="ba5c367eb5d97c6c2ac73b534d9757f2"></a><!-- doxytag: member="scim::FrontEndBase::forward_key_event" ref="ba5c367eb5d97c6c2ac73b534d9757f2" args="(int id, const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::forward_key_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00054.html">KeyEvent</a> & </td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
forward a keyevent to the client of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>the key event to be forwarded. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4f7f90ce37c5cbdeeaaa4975489ef524"></a><!-- doxytag: member="scim::FrontEndBase::register_properties" ref="4f7f90ce37c5cbdeeaaa4975489ef524" args="(int id, const PropertyList &properties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::register_properties </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00158.html#gc4099a109cec998bbfad588fcf4c8f79">PropertyList</a> & </td>
<td class="paramname"> <em>properties</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
register all the properties of an IMEngine instance into this FrontEnd.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>properties</em> </td><td>the PropertyList contains all the properties of this IMEngine instance. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d5f92d1555fb5ae9ad6b18b7c39fdfc6"></a><!-- doxytag: member="scim::FrontEndBase::update_property" ref="d5f92d1555fb5ae9ad6b18b7c39fdfc6" args="(int id, const Property &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::update_property </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00071.html">Property</a> & </td>
<td class="paramname"> <em>property</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
update a property of an IMEngine instance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>property</em> </td><td>the <a class="el" href="a00071.html" title="Class to hold a property of a IMEngineInstance object or a Panel GUI client.">Property</a> to be updated. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="fa7dca7ca69da450582d5c33037aa582"></a><!-- doxytag: member="scim::FrontEndBase::beep" ref="fa7dca7ca69da450582d5c33037aa582" args="(int id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::beep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
generate a short beep.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="f7625d9de95b71d572438af27b2bc729"></a><!-- doxytag: member="scim::FrontEndBase::start_helper" ref="f7625d9de95b71d572438af27b2bc729" args="(int id, const String &helper_uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::start_helper </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>helper_uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
start a Client Helper process.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>helper_uuid</em> </td><td>The UUID of the Helper object. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="776d4b1d2dc32d5e5e876e61c79d1991"></a><!-- doxytag: member="scim::FrontEndBase::stop_helper" ref="776d4b1d2dc32d5e5e876e61c79d1991" args="(int id, const String &helper_uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::stop_helper </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>helper_uuid</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
stop a Client Helper process.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>helper_uuid</em> </td><td>The UUID of the Helper object. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="80083a4d5baf7427c3ec28149486dd67"></a><!-- doxytag: member="scim::FrontEndBase::send_helper_event" ref="80083a4d5baf7427c3ec28149486dd67" args="(int id, const String &helper_uuid, const Transaction &trans)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::send_helper_event </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>helper_uuid</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00109.html">Transaction</a> & </td>
<td class="paramname"> <em>trans</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
send an events transaction to a Client Helper process.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>helper_uuid</em> </td><td>The UUID of the Helper object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>trans</em> </td><td>the transaction which contains events. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="0e96dc9e293b4257a0aca5012bf788d0"></a><!-- doxytag: member="scim::FrontEndBase::get_surrounding_text" ref="0e96dc9e293b4257a0aca5012bf788d0" args="(int id, WideString &text, int &cursor, int maxlen_before, int maxlen_after)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FrontEndBase::get_surrounding_text </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </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</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>maxlen_before</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>maxlen_after</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieves context around the insertion point.
<p>
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.<p>
Unlike other signal activation actions, this action will return the result immediately.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>text</em> </td><td>location to store the context string around the insertion point. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cursor</em> </td><td>location to store index of the insertion cursor within . </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxlen_before</em> </td><td>the maxmium length of context string to be retrieved before the cursor; -1 means unlimited. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>maxlen_after</em> </td><td>the maxmium length of context string to be retrieved after the cursor; -1 means unlimited.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if surrounding text was provided. </dd></dl>
</div>
</div><p>
<a class="anchor" name="3046540fc1635193a44179240432d34e"></a><!-- doxytag: member="scim::FrontEndBase::delete_surrounding_text" ref="3046540fc1635193a44179240432d34e" args="(int id, int offset, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FrontEndBase::delete_surrounding_text </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</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>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Ask the client to delete characters around the cursor position.
<p>
In order to use this function, you should first call get_surrounding_text () to get the current context, and call this function immediately afterwards to make sure that you know what you are deleting. You should also account for the fact that even if the signal was handled, the input context might not have deleted all the characters that were requested to be deleted.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>the id of the IMEngine instance. It must have been focused in. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>offset from cursor position in chars; a negative value means start before the cursor. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>number of characters to delete.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the signal was handled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="23c667257ca98dd7ffb38ac2fa3350ad"></a><!-- doxytag: member="scim::FrontEndBase::init" ref="23c667257ca98dd7ffb38ac2fa3350ad" args="(int argc, char **argv)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::init </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>argc</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char ** </td>
<td class="paramname"> <em>argv</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
init the frontend.
<p>
This method must be implemented by derivation classes.
</div>
</div><p>
<a class="anchor" name="47a5c570b4dc44d06f9be4a24307fefc"></a><!-- doxytag: member="scim::FrontEndBase::run" ref="47a5c570b4dc44d06f9be4a24307fefc" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FrontEndBase::run </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
run the frontend.
<p>
This method must be implemented by derivation classes.
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="2c94fac0705cba97d78b572636c34f2a"></a><!-- doxytag: member="scim::FrontEndBase::FrontEndBaseImpl" ref="2c94fac0705cba97d78b572636c34f2a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class FrontEndBaseImpl<code> [friend]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00128.html">scim_frontend.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:40 2009 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
</body>
</html>
