Sophie

Sophie

distrib > * > 2010.0 > * > by-pkgid > e30a327878e3ba1e4fc6c751cb1f95c0 > files > 86

libscim-devel-1.4.9-2mdv2010.0.i586.rpm

<!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::FilterFactoryBase 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&nbsp;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&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="a00157.html">scim</a>::<a class="el" href="a00026.html">FilterFactoryBase</a>
  </div>
</div>
<div class="contents">
<h1>scim::FilterFactoryBase Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::FilterFactoryBase" --><!-- doxytag: inherits="scim::IMEngineFactoryBase" -->The base class to implement FilterFactory classes.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;scim_filter.h&gt;</code>
<p>

<p>
<a href="a00236.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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#012dd475468844e38bf701ce6a244dbe">FilterFactoryBase</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default Constructor.  <a href="#012dd475468844e38bf701ce6a244dbe"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#d043c68ca6985d8362fbea621c7e0068">~FilterFactoryBase</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0">attach_imengine_factory</a> (const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> &amp;orig)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Attach an IMEngineFactory object to this filter.  <a href="#596f3b5027bdc9e808a954f6390ce5f0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#930689a9a94bb0bc50e32868ed048204">get_name</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the name of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#930689a9a94bb0bc50e32868ed048204"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#3f2c6f8acd3ae7fc30f318910a599332">get_uuid</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the uuid of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#3f2c6f8acd3ae7fc30f318910a599332"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#c8f3cc13159decd1e12f50958d294dcf">get_icon_file</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the icon file path of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#c8f3cc13159decd1e12f50958d294dcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#c83514fbca70a716fe106d641e7c3fa3">get_authors</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the authors information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#c83514fbca70a716fe106d641e7c3fa3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#10870e1d8ce9385a6d863656fd43400a">get_credits</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the credits information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#10870e1d8ce9385a6d863656fd43400a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#4e1139cbaa51a76b87024b19e1d5ca9c">get_help</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the help information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#4e1139cbaa51a76b87024b19e1d5ca9c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#70a35bd64ddcfb161738283b9997f960">get_language</a> () const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Return the supported language of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#70a35bd64ddcfb161738283b9997f960"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#0664b674ca07178632f0bdc2d07725ea">validate_encoding</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;encoding) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if an encoding is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#0664b674ca07178632f0bdc2d07725ea"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#48d668ce1300b27ce30eb582127c3730">validate_locale</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;locale) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Check if an locale is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#48d668ce1300b27ce30eb582127c3730"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#f0556243a1a02638f6b57c1fb5c81716">inverse_query</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &amp;str)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the original key string of a composed string by calling the same method of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#f0556243a1a02638f6b57c1fb5c81716"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#cbd863c653e886faa3891be6cb722052">create_instance</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;encoding, int id=-1)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an IMEngineInstance object of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method.  <a href="#cbd863c653e886faa3891be6cb722052"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base class to implement FilterFactory classes. 
<p>
All FilterFactory classes should derive from this class and some base methods should be overrided in the derived classes.<p>
If a FilterFactory object need large amount of data (eg. mapping table etc.), it'd better to share these data among all other objects of the same class. Because multiple objects of one FilterFactory class maybe used at the same time to filter several real IMEngineFactory objects. <hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="012dd475468844e38bf701ce6a244dbe"></a><!-- doxytag: member="scim::FilterFactoryBase::FilterFactoryBase" ref="012dd475468844e38bf701ce6a244dbe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">scim::FilterFactoryBase::FilterFactoryBase           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Default Constructor. 
<p>

</div>
</div><p>
<a class="anchor" name="d043c68ca6985d8362fbea621c7e0068"></a><!-- doxytag: member="scim::FilterFactoryBase::~FilterFactoryBase" ref="d043c68ca6985d8362fbea621c7e0068" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual scim::FilterFactoryBase::~FilterFactoryBase           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</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="596f3b5027bdc9e808a954f6390ce5f0"></a><!-- doxytag: member="scim::FilterFactoryBase::attach_imengine_factory" ref="596f3b5027bdc9e808a954f6390ce5f0" args="(const IMEngineFactoryPointer &amp;orig)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void scim::FilterFactoryBase::attach_imengine_factory           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00070.html">IMEngineFactoryPointer</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>orig</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Attach an IMEngineFactory object to this filter. 
<p>
The attached object could also be a filter.<p>
This method will set the supported locales of this filter factory to the locales supported by the original IMEngineFactory object.<p>
This method could be overrided in derived class, in which some special tasks could be done, for example, set additional supported locales. But this method of base class must be invoked to attach the factory correctly.<p>
The IMEngineFactoryPointer orig may not be kept and used by derived class directly. All tasks related to the original IMEngineFactory object should be done by calling the corresponding methods of <a class="el" href="a00026.html" title="The base class to implement FilterFactory classes.">FilterFactoryBase</a> class.<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>orig</em>&nbsp;</td><td>The original IMEngineFactory object to be filtered. </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="930689a9a94bb0bc50e32868ed048204"></a><!-- doxytag: member="scim::FilterFactoryBase::get_name" ref="930689a9a94bb0bc50e32868ed048204" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::get_name           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the name of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the name of the filter itself when it returns an empty string.<p>
The derived method should look like:<p>
<pre>
 WideString
 XXXFilterFactory::get_name ()
 {
     WideString name = <a class="el" href="a00026.html#930689a9a94bb0bc50e32868ed048204" title="Return the name of the original IMEngineFactory object specified in contructor or...">FilterFactoryBase::get_name</a> ();
     return name.length () ? name : _("XXX");
 }
 </pre> 
<p>Implements <a class="el" href="a00050.html#6921eee2666fee7ab3da416e53a7f2f6">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="3f2c6f8acd3ae7fc30f318910a599332"></a><!-- doxytag: member="scim::FilterFactoryBase::get_uuid" ref="3f2c6f8acd3ae7fc30f318910a599332" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FilterFactoryBase::get_uuid           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the uuid of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the uuid of the filter itself when it returns an empty string. 
<p>Implements <a class="el" href="a00050.html#7b3e039734251007df6947cf9d9b6c3a">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="c8f3cc13159decd1e12f50958d294dcf"></a><!-- doxytag: member="scim::FilterFactoryBase::get_icon_file" ref="c8f3cc13159decd1e12f50958d294dcf" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FilterFactoryBase::get_icon_file           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the icon file path of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the icon file path of the filter itself when it returns an empty string. 
<p>Implements <a class="el" href="a00050.html#dc57c3a8c80ee4bcb830fd35a7111063">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="c83514fbca70a716fe106d641e7c3fa3"></a><!-- doxytag: member="scim::FilterFactoryBase::get_authors" ref="c83514fbca70a716fe106d641e7c3fa3" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::get_authors           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the authors information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the authors information of the filter itself when it returns an empty string. 
<p>Implements <a class="el" href="a00050.html#69dc66f38c39eabbade99f63467f1b6b">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="10870e1d8ce9385a6d863656fd43400a"></a><!-- doxytag: member="scim::FilterFactoryBase::get_credits" ref="10870e1d8ce9385a6d863656fd43400a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::get_credits           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the credits information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the credits information of the filter itself when it returns an empty string. 
<p>Implements <a class="el" href="a00050.html#c4b3d29d8b9d90dff700a795a3170db3">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="4e1139cbaa51a76b87024b19e1d5ca9c"></a><!-- doxytag: member="scim::FilterFactoryBase::get_help" ref="4e1139cbaa51a76b87024b19e1d5ca9c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::get_help           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the help information of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class should override this method to return the combined help information of the filter itself and the original IMEngineFactory to be filtered. 
<p>Implements <a class="el" href="a00050.html#d077870f447a106341e252794d1709ec">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="70a35bd64ddcfb161738283b9997f960"></a><!-- doxytag: member="scim::FilterFactoryBase::get_language" ref="70a35bd64ddcfb161738283b9997f960" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::FilterFactoryBase::get_language           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Return the supported language of the original IMEngineFactory object specified in contructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned.<p>
The derived class may override this method to return a different language which is supported by the filter itself. 
<p>Reimplemented from <a class="el" href="a00050.html#cbc15b70af002f557ccd3e41496ab983">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="0664b674ca07178632f0bdc2d07725ea"></a><!-- doxytag: member="scim::FilterFactoryBase::validate_encoding" ref="0664b674ca07178632f0bdc2d07725ea" args="(const String &amp;encoding) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool scim::FilterFactoryBase::validate_encoding           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>encoding</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if an encoding is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then false would be returned.<p>
The derived class may override this method to provide its own validate routing. 
<p>Reimplemented from <a class="el" href="a00050.html#649b93485005351fcdd3d78113af6897">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="48d668ce1300b27ce30eb582127c3730"></a><!-- doxytag: member="scim::FilterFactoryBase::validate_locale" ref="48d668ce1300b27ce30eb582127c3730" args="(const String &amp;locale) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool scim::FilterFactoryBase::validate_locale           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>locale</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Check if an locale is supported by the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then false would be returned.<p>
The derived class may override this method to provide its own validate routing. 
<p>Reimplemented from <a class="el" href="a00050.html#f9ca6ba3bcff44112df84cd98b02c88f">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="f0556243a1a02638f6b57c1fb5c81716"></a><!-- doxytag: member="scim::FilterFactoryBase::inverse_query" ref="f0556243a1a02638f6b57c1fb5c81716" args="(const WideString &amp;str)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> scim::FilterFactoryBase::inverse_query           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>str</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the original key string of a composed string by calling the same method of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
If there is no IMEngineFactory attached yet, then an empty string would be returned. 
<p>Reimplemented from <a class="el" href="a00050.html#8e0f6c3450532bb3b4fa84de3a97c8fe">scim::IMEngineFactoryBase</a>.</p>

</div>
</div><p>
<a class="anchor" name="cbd863c653e886faa3891be6cb722052"></a><!-- doxytag: member="scim::FilterFactoryBase::create_instance" ref="cbd863c653e886faa3891be6cb722052" args="(const String &amp;encoding, int id=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a> scim::FilterFactoryBase::create_instance           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>encoding</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>id</em> = <code>-1</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Create an IMEngineInstance object of the original IMEngineFactory object specified in constructor or by <a class="el" href="a00026.html#596f3b5027bdc9e808a954f6390ce5f0" title="Attach an IMEngineFactory object to this filter.">attach_imengine_factory()</a> method. 
<p>
The derived class should override this method and create its own instance object from the result of this base method.<p>
The code may look like:<p>
<pre>
 IMEngineInstancePointer
 XXXFilterFactory::create_instance (const String&amp; encoding, int id)
 {
     return new XXXFilterInstance (this, <a class="el" href="a00026.html#cbd863c653e886faa3891be6cb722052" title="Create an IMEngineInstance object of the original IMEngineFactory object specified...">FilterFactoryBase::create_instance</a> (encoding, id));
 }
 </pre> 
<p>Implements <a class="el" href="a00050.html#a7e2ee7629f23b4079ba1dd1e23f7dea">scim::IMEngineFactoryBase</a>.</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&nbsp;
<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>