<!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::FilterInstanceBase 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="a00028.html">FilterInstanceBase</a>
</div>
</div>
<div class="contents">
<h1>scim::FilterInstanceBase Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::FilterInstanceBase" --><!-- doxytag: inherits="scim::IMEngineInstanceBase" -->The base class to implement FilterInstance classes.
<a href="#_details">More...</a>
<p>
<code>#include <scim_filter.h></code>
<p>
<p>
<a href="a00237.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="a00028.html#0ba02d1c80c25998f7330ce5a5fd64e1">FilterInstanceBase</a> (<a class="el" href="a00026.html">FilterFactoryBase</a> *factory, const <a class="el" href="a00070.html">IMEngineInstancePointer</a> &orig_inst)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#0ba02d1c80c25998f7330ce5a5fd64e1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#88301864283ab1960ca7b70c35f625ea">~FilterInstanceBase</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#0930efd7e937b77dc135dabda5206e20">set_encoding</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the working encoding for this filter instance as well as the original instance which is currently filtered. <a href="#0930efd7e937b77dc135dabda5206e20"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Action functions.</div></td></tr>
<tr><td colspan="2"><div class="groupText">These functions will be called by FrontEnds to send events to this FilterInstance.<p>
These methods can be overrided, if the derived class wants to filter these events.<p>
The default implementation of these methods are just to call the corresponding methods of the original IMEngineInstance object which is filtered by this filter. <br><br></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#789b4e22528d7f311f6fe985eef5b311">process_key_event</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Process a key event. <a href="#789b4e22528d7f311f6fe985eef5b311"></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="a00028.html#3c2570975d8b99201226c2428c36aea4">move_preedit_caret</a> (unsigned int pos)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Move the preedit caret in the preedit string. <a href="#3c2570975d8b99201226c2428c36aea4"></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="a00028.html#cf7057362aa2a6aef2239cea90a1e2f6">select_candidate</a> (unsigned int index)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Select a candidate in current lookup table. <a href="#cf7057362aa2a6aef2239cea90a1e2f6"></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="a00028.html#c936bafb876747986e92c3f55c39cd45">update_lookup_table_page_size</a> (unsigned int page_size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the page size of current lookup table. <a href="#c936bafb876747986e92c3f55c39cd45"></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="a00028.html#ffb38cd5ff9bf5ebac0d4cfaa2fc59f8">lookup_table_page_up</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the lookup table to the previous page. <a href="#ffb38cd5ff9bf5ebac0d4cfaa2fc59f8"></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="a00028.html#4df1003b5579d6326dc53b0ee2cb7b06">lookup_table_page_down</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Flip the lookup table to the next page. <a href="#4df1003b5579d6326dc53b0ee2cb7b06"></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="a00028.html#f1ed6e10244d1ab9d479ca3f4b8fa6f2">reset</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset this engine instance. <a href="#f1ed6e10244d1ab9d479ca3f4b8fa6f2"></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="a00028.html#0b3e4ce3853ece7ce2ab037bb8cd8aea">focus_in</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Focus in this engine instance. <a href="#0b3e4ce3853ece7ce2ab037bb8cd8aea"></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="a00028.html#8e3f8ec98f51a983e7f9a261bde25124">focus_out</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Focus out this engine instance. <a href="#8e3f8ec98f51a983e7f9a261bde25124"></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="a00028.html#21d6efc2c3fe743bd507a80bbea9a204">trigger_property</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &property)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Trigger a property. <a href="#21d6efc2c3fe743bd507a80bbea9a204"></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="a00028.html#069d409be7160e466fccbd71a7deb5df">process_helper_event</a> (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">Process the events sent from a Client Helper process. <a href="#069d409be7160e466fccbd71a7deb5df"></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="a00028.html#dc3e228ef4a00e345e2f5d6b0827b47a">update_client_capabilities</a> (unsigned int cap)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Update the capabilities of current client application which is attached to this IMEngineInstance. <a href="#dc3e228ef4a00e345e2f5d6b0827b47a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td colspan="2"><div class="groupHeader">Signal activation functions.</div></td></tr>
<tr><td colspan="2"><div class="groupText">@<p>
These methods will be called by <a class="el" href="a00028.html" title="The base class to implement FilterInstance classes.">FilterInstanceBase</a> class when the corresponding signals are emitted by the original IMEngineInstance object which is filtered by this filter.<p>
These methods can be overrided, if the derived class wants to filter these signals. The default implementation of these methods are just to deliver the signals to FrontEnd directly. <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="a00028.html#c9735734a70d7066824df36fb46e99db">filter_show_preedit_string</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#5a3eeda4ba0dc438e9092a94e3466e8e">filter_show_aux_string</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#117b9829a131c90e787c2b9b75b9664c">filter_show_lookup_table</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#9e2e1fad87b587349371d814da9e5702">filter_hide_preedit_string</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#2271d3268b564e29f3cd279cb729c388">filter_hide_aux_string</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#2a85ca23a57b1339a63e8365caf90a70">filter_hide_lookup_table</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#187f154ecc935de980bd0258249eb157">filter_update_preedit_caret</a> (int caret)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#738495df16f4bc8ff3f78c0827a5fbef">filter_update_preedit_string</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs=<a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#fd700d51c20dfdc15cb69c20d71806de">filter_update_aux_string</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs=<a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#d5d5198d3ff18c999361703a69f4db96">filter_update_lookup_table</a> (const <a class="el" href="a00055.html">LookupTable</a> &table)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#230a5beb7e8decd5b8cb076d2fe00425">filter_commit_string</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &str)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#0ea49f61c139ac69645e76713fa7e75f">filter_forward_key_event</a> (const <a class="el" href="a00054.html">KeyEvent</a> &key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#523a2048b3e2d238054fe062b66fb427">filter_register_properties</a> (const <a class="el" href="a00158.html#gc4099a109cec998bbfad588fcf4c8f79">PropertyList</a> &properties)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#6c1a2c209a3c93d59976ee46869ec1f0">filter_update_property</a> (const <a class="el" href="a00071.html">Property</a> &property)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#b9452aa3613ec8569817bf5b3b64f441">filter_beep</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#e243b4c8061e8d632f1d8c1029a2039a">filter_start_helper</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#63fef6d1f794dafe2cb1210243147333">filter_stop_helper</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &helper_uuid)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#e7a9f35e8b60a32b9065c1f9ba6dc551">filter_send_helper_event</a> (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="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#b77a86a93695f50764ad7091b7cc0ae5">filter_get_surrounding_text</a> (<a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &text, int &cursor, int maxlen_before=-1, int maxlen_after=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00028.html#e3963027ee2f5d2d7953d470ce6bae43">filter_delete_surrounding_text</a> (int offset, int len)</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="a00028.html#cce6ee30b6f3b9066af03c35678a4234">FilterInstanceBaseImpl</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base class to implement FilterInstance classes.
<p>
All FilterInstance classes should derive from this base class, and some base methods should be override in the derived classes. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0ba02d1c80c25998f7330ce5a5fd64e1"></a><!-- doxytag: member="scim::FilterInstanceBase::FilterInstanceBase" ref="0ba02d1c80c25998f7330ce5a5fd64e1" args="(FilterFactoryBase *factory, const IMEngineInstancePointer &orig_inst)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterInstanceBase::FilterInstanceBase </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00026.html">FilterFactoryBase</a> * </td>
<td class="paramname"> <em>factory</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00070.html">IMEngineInstancePointer</a> & </td>
<td class="paramname"> <em>orig_inst</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Constructor.
<p>
The Constructor of derived class should call this Contructor with the following two parameters.<p>
The orig_inst should be created by invoking <a class="el" href="a00026.html#cbd863c653e886faa3891be6cb722052" title="Create an IMEngineInstance object of the original IMEngineFactory object specified...">FilterFactoryBase::create_instance()</a> within the same method of derived FilterFactory classes.<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>factory</em> </td><td>the FilterFactory which creates this instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>orig_inst</em> </td><td>the original IMEngineInstance to be filtered. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="88301864283ab1960ca7b70c35f625ea"></a><!-- doxytag: member="scim::FilterInstanceBase::~FilterInstanceBase" ref="88301864283ab1960ca7b70c35f625ea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::FilterInstanceBase::~FilterInstanceBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0930efd7e937b77dc135dabda5206e20"></a><!-- doxytag: member="scim::FilterInstanceBase::set_encoding" ref="0930efd7e937b77dc135dabda5206e20" args="(const String &encoding)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterInstanceBase::set_encoding </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>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the working encoding for this filter instance as well as the original instance which is currently filtered.
<p>
This method could be overrided in derived class to do some extra job. But the method of this base class must be invoked within the new method.<p>
After invoking this method, <a class="el" href="a00028.html#f1ed6e10244d1ab9d479ca3f4b8fa6f2" title="Reset this engine instance.">reset()</a> should be invoked to let the new encoding take effect.<p>
If you want to use different encodings in this filter instance and the original instance which is currently filtered, this method should be overrided in the derived class and two different encodings should be set respectively by calling <a class="el" href="a00028.html#0930efd7e937b77dc135dabda5206e20" title="Set the working encoding for this filter instance as well as the original instance...">FilterInstanceBase::set_encoding()</a> and <a class="el" href="a00052.html#21d752cf678f9533d7c3baa6cfc2efb7" title="Set the working encoding for this instance.">IMEngineInstanceBase::set_encoding</a> (); The code may look like:<p>
bool XXXFilterInstance::set_encoding (const String &encoding) { <a class="el" href="a00028.html#0930efd7e937b77dc135dabda5206e20" title="Set the working encoding for this filter instance as well as the original instance...">FilterInstanceBase::set_encoding</a> ("Other Encoding"); // Set the encoding of the original instance to another one. return <a class="el" href="a00052.html#21d752cf678f9533d7c3baa6cfc2efb7" title="Set the working encoding for this instance.">IMEngineInstanceBase::set_encoding</a> (encoding); // Set the encoding of this filter instance to the desired one. }<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the encoding is supported, otherwise false. </dd></dl>
<p>Reimplemented from <a class="el" href="a00052.html#21d752cf678f9533d7c3baa6cfc2efb7">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="789b4e22528d7f311f6fe985eef5b311"></a><!-- doxytag: member="scim::FilterInstanceBase::process_key_event" ref="789b4e22528d7f311f6fe985eef5b311" args="(const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterInstanceBase::process_key_event </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>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process a key event.
<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>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 is processed, otherwise the event is not processed and should be forward to client application. </dd></dl>
<p>Implements <a class="el" href="a00052.html#a2da7c8755e6af90cc8dfe2a5d47bcec">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="3c2570975d8b99201226c2428c36aea4"></a><!-- doxytag: member="scim::FilterInstanceBase::move_preedit_caret" ref="3c2570975d8b99201226c2428c36aea4" args="(unsigned int pos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::move_preedit_caret </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>pos</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Move the preedit caret in the preedit string.
<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>pos</em> </td><td>- the new position that user requested. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="a00052.html#84bd207c8d6959c8fcc61a630ab61b59">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="cf7057362aa2a6aef2239cea90a1e2f6"></a><!-- doxytag: member="scim::FilterInstanceBase::select_candidate" ref="cf7057362aa2a6aef2239cea90a1e2f6" args="(unsigned int index)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::select_candidate </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Select a candidate in current lookup table.
<p>
When user click a candidate directly, this method will be invoked by 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>index</em> </td><td>- the index in current page of the selected candidate. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="a00052.html#f8af093dae67b196416bf0099298dfc3">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="c936bafb876747986e92c3f55c39cd45"></a><!-- doxytag: member="scim::FilterInstanceBase::update_lookup_table_page_size" ref="c936bafb876747986e92c3f55c39cd45" args="(unsigned int page_size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::update_lookup_table_page_size </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>page_size</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the page size of current lookup table.
<p>
In the next time, the lookup table should page down by this size.<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>page_size</em> </td><td>- the new size of current page. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="a00052.html#a62ab13f71a146cdaaee1e33c671b3c7">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="ffb38cd5ff9bf5ebac0d4cfaa2fc59f8"></a><!-- doxytag: member="scim::FilterInstanceBase::lookup_table_page_up" ref="ffb38cd5ff9bf5ebac0d4cfaa2fc59f8" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::lookup_table_page_up </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flip the lookup table to the previous page.
<p>
The method will be invoked by FrontEnd when user click the lookup table page up button.
<p>Reimplemented from <a class="el" href="a00052.html#244f2132661b86d5b7232e3fee20ce74">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="4df1003b5579d6326dc53b0ee2cb7b06"></a><!-- doxytag: member="scim::FilterInstanceBase::lookup_table_page_down" ref="4df1003b5579d6326dc53b0ee2cb7b06" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::lookup_table_page_down </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Flip the lookup table to the next page.
<p>
The method will be invoked by FrontEnd when user click the lookup table page down button.
<p>Reimplemented from <a class="el" href="a00052.html#4b460876bc485b2a636ff4a6c1ef951b">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="f1ed6e10244d1ab9d479ca3f4b8fa6f2"></a><!-- doxytag: member="scim::FilterInstanceBase::reset" ref="f1ed6e10244d1ab9d479ca3f4b8fa6f2" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset this engine instance.
<p>
All status of this engine instance should be reset, including the working encoding.<p>
The client encoding may have been changed before calling this method, so if the IMEngine makes use of the client's encoding information, it should check whether the encoding has been changed. IMEngineInstance could call the get_encoding () method of base class to get the client encoding.
<p>Reimplemented from <a class="el" href="a00052.html#cdc4f433def9d043eecb879061a8eb70">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="0b3e4ce3853ece7ce2ab037bb8cd8aea"></a><!-- doxytag: member="scim::FilterInstanceBase::focus_in" ref="0b3e4ce3853ece7ce2ab037bb8cd8aea" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::focus_in </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Focus in this engine instance.
<p>
This function should update/show/hide the status area, preedit area and lookup table, and update the full width punctuation/letter state.
<p>Reimplemented from <a class="el" href="a00052.html#44db147dc9892194c190efb6958a523d">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="8e3f8ec98f51a983e7f9a261bde25124"></a><!-- doxytag: member="scim::FilterInstanceBase::focus_out" ref="8e3f8ec98f51a983e7f9a261bde25124" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::focus_out </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Focus out this engine instance.
<p>
<p>Reimplemented from <a class="el" href="a00052.html#e4488970b00d61456035ed59edab9037">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="21d6efc2c3fe743bd507a80bbea9a204"></a><!-- doxytag: member="scim::FilterInstanceBase::trigger_property" ref="21d6efc2c3fe743bd507a80bbea9a204" args="(const String &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::trigger_property </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>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Trigger a property.
<p>
This function should do some action according to the triggered property. For example toggle the input mode, etc.<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>property</em> </td><td>the key of the triggered property. </td></tr>
</table>
</dl>
<p>Reimplemented from <a class="el" href="a00052.html#07356c4e5fc2b563aae2a927ee284512">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="069d409be7160e466fccbd71a7deb5df"></a><!-- doxytag: member="scim::FilterInstanceBase::process_helper_event" ref="069d409be7160e466fccbd71a7deb5df" args="(const String &helper_uuid, const Transaction &trans)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::process_helper_event </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> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Process the events sent from 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>helper_uuid</em> </td><td>The UUID of the Helper process which sent the events. </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>
<p>Reimplemented from <a class="el" href="a00052.html#4556d6e7b3a2bb3f9cf0e38724f6cf88">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="dc3e228ef4a00e345e2f5d6b0827b47a"></a><!-- doxytag: member="scim::FilterInstanceBase::update_client_capabilities" ref="dc3e228ef4a00e345e2f5d6b0827b47a" args="(unsigned int cap)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::update_client_capabilities </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>cap</em> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Update the capabilities of current client application which is attached to this IMEngineInstance.
<p>
Some client may not support all capabilities provided by the IMEngine API. For example:<p>
<ul>
<li>OnTheSpot preedit string display (Embedded into client window).</li><li><a class="el" href="a00071.html" title="Class to hold a property of a IMEngineInstance object or a Panel GUI client.">Property</a> display</li><li>Helper module</li><li>etc.</li></ul>
<p>
This method will be called to inform this IMEngineInstance object which capabilities are supported by the client application. It may be called multiple times, if the capabilities was changed.<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>cap</em> </td><td>A bitmask to indicate which client capabilities are supported by the client application.</td></tr>
</table>
</dl>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="a00160.html#g4f5e9e0461fb6a3dff0c2942429de97a" title="Enum values of all Client Capabilities bitmask.">scim::ClientCapability</a> </dd></dl>
<p>Reimplemented from <a class="el" href="a00052.html#114d906ab61980b1c38c55946c0674f3">scim::IMEngineInstanceBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="c9735734a70d7066824df36fb46e99db"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_show_preedit_string" ref="c9735734a70d7066824df36fb46e99db" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_show_preedit_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5a3eeda4ba0dc438e9092a94e3466e8e"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_show_aux_string" ref="5a3eeda4ba0dc438e9092a94e3466e8e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_show_aux_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="117b9829a131c90e787c2b9b75b9664c"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_show_lookup_table" ref="117b9829a131c90e787c2b9b75b9664c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_show_lookup_table </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="9e2e1fad87b587349371d814da9e5702"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_hide_preedit_string" ref="9e2e1fad87b587349371d814da9e5702" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_hide_preedit_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2271d3268b564e29f3cd279cb729c388"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_hide_aux_string" ref="2271d3268b564e29f3cd279cb729c388" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_hide_aux_string </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2a85ca23a57b1339a63e8365caf90a70"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_hide_lookup_table" ref="2a85ca23a57b1339a63e8365caf90a70" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_hide_lookup_table </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="187f154ecc935de980bd0258249eb157"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_update_preedit_caret" ref="187f154ecc935de980bd0258249eb157" args="(int caret)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_update_preedit_caret </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>caret</em> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="738495df16f4bc8ff3f78c0827a5fbef"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_update_preedit_string" ref="738495df16f4bc8ff3f78c0827a5fbef" args="(const WideString &str, const AttributeList &attrs=AttributeList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_update_preedit_string </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> = <code><a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>()</code></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>
</div>
</div><p>
<a class="anchor" name="fd700d51c20dfdc15cb69c20d71806de"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_update_aux_string" ref="fd700d51c20dfdc15cb69c20d71806de" args="(const WideString &str, const AttributeList &attrs=AttributeList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_update_aux_string </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> = <code><a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>()</code></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>
</div>
</div><p>
<a class="anchor" name="d5d5198d3ff18c999361703a69f4db96"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_update_lookup_table" ref="d5d5198d3ff18c999361703a69f4db96" args="(const LookupTable &table)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_update_lookup_table </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="230a5beb7e8decd5b8cb076d2fe00425"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_commit_string" ref="230a5beb7e8decd5b8cb076d2fe00425" args="(const WideString &str)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_commit_string </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="0ea49f61c139ac69645e76713fa7e75f"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_forward_key_event" ref="0ea49f61c139ac69645e76713fa7e75f" args="(const KeyEvent &key)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_forward_key_event </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="523a2048b3e2d238054fe062b66fb427"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_register_properties" ref="523a2048b3e2d238054fe062b66fb427" args="(const PropertyList &properties)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_register_properties </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="6c1a2c209a3c93d59976ee46869ec1f0"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_update_property" ref="6c1a2c209a3c93d59976ee46869ec1f0" args="(const Property &property)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_update_property </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="b9452aa3613ec8569817bf5b3b64f441"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_beep" ref="b9452aa3613ec8569817bf5b3b64f441" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_beep </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e243b4c8061e8d632f1d8c1029a2039a"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_start_helper" ref="e243b4c8061e8d632f1d8c1029a2039a" args="(const String &helper_uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_start_helper </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="63fef6d1f794dafe2cb1210243147333"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_stop_helper" ref="63fef6d1f794dafe2cb1210243147333" args="(const String &helper_uuid)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_stop_helper </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>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="e7a9f35e8b60a32b9065c1f9ba6dc551"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_send_helper_event" ref="e7a9f35e8b60a32b9065c1f9ba6dc551" args="(const String &helper_uuid, const Transaction &trans)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::FilterInstanceBase::filter_send_helper_event </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>
</div>
</div><p>
<a class="anchor" name="b77a86a93695f50764ad7091b7cc0ae5"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_get_surrounding_text" ref="b77a86a93695f50764ad7091b7cc0ae5" args="(WideString &text, int &cursor, int maxlen_before=-1, int maxlen_after=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterInstanceBase::filter_get_surrounding_text </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> = <code>-1</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>maxlen_after</em> = <code>-1</code></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>
</div>
</div><p>
<a class="anchor" name="e3963027ee2f5d2d7953d470ce6bae43"></a><!-- doxytag: member="scim::FilterInstanceBase::filter_delete_surrounding_text" ref="e3963027ee2f5d2d7953d470ce6bae43" args="(int offset, int len)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::FilterInstanceBase::filter_delete_surrounding_text </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>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="cce6ee30b6f3b9066af03c35678a4234"></a><!-- doxytag: member="scim::FilterInstanceBase::FilterInstanceBaseImpl" ref="cce6ee30b6f3b9066af03c35678a4234" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">friend class FilterInstanceBaseImpl<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="a00125.html">scim_filter.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>
