<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>scim: scim::FilterModule 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.0 -->
<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 id="current"><a href="classes.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="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</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="nav">
<a class="el" href="a00157.html">scim</a>::<a class="el" href="a00030.html">FilterModule</a></div>
<h1>scim::FilterModule Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::FilterModule" -->The class to manipulate the Filter modules.
<a href="#_details">More...</a>
<p>
<code>#include <scim_filter_module.h></code>
<p>
Collaboration diagram for scim::FilterModule:<p><center><img src="a00338.png" border="0" usemap="#a00339" alt="Collaboration graph"></center>
<map name="a00339">
<area href="a00063.html" shape="rect" coords="27,8,128,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00340.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="a00030.html#0e4a3aa4909b79d3fe8e0e2a7823e3db">FilterModule</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#0e4a3aa4909b79d3fe8e0e2a7823e3db"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#d49694d3b352620aeb267d01db4e6909">FilterModule</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name, const <a class="el" href="a00070.html">ConfigPointer</a> &config)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#d49694d3b352620aeb267d01db4e6909"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#dfd2d47b073a6b3e72be40feecd741d8">load</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name, const <a class="el" href="a00070.html">ConfigPointer</a> &config)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a Filter <a class="el" href="a00063.html">Module</a> by its name. <a href="#dfd2d47b073a6b3e72be40feecd741d8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#cb3a30ca5dda90164a7a7539c7630a58">unload</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unload the Filter <a class="el" href="a00063.html">Module</a>. <a href="#cb3a30ca5dda90164a7a7539c7630a58"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#520e2897747e5bc36e7e9becb3fad71a">valid</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a module is loaded and initialized successfully. <a href="#520e2897747e5bc36e7e9becb3fad71a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#9c2e16c148ec83bd2ba9e0efb99f8fcf">number_of_filters</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get how many Filter factories supported by this module. <a href="#9c2e16c148ec83bd2ba9e0efb99f8fcf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00070.html">FilterFactoryPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#620f417f9f5a4e7f4bc89d98b59782cd">create_filter</a> (unsigned int index) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an object for a Filter factory. <a href="#620f417f9f5a4e7f4bc89d98b59782cd"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00030.html#f65087520d06b0c52dffda19842516a4">get_filter_info</a> (unsigned int index, <a class="el" href="a00027.html">FilterInfo</a> &info) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get basic information of the FilterFactory class provided by this module. <a href="#f65087520d06b0c52dffda19842516a4"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class to manipulate the Filter modules.
<p>
This is a wrapper of <a class="el" href="a00063.html">scim::Module</a> class, which is specially for manipulating the Filter modules.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="0e4a3aa4909b79d3fe8e0e2a7823e3db"></a><!-- doxytag: member="scim::FilterModule::FilterModule" ref="0e4a3aa4909b79d3fe8e0e2a7823e3db" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterModule::FilterModule </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="d49694d3b352620aeb267d01db4e6909"></a><!-- doxytag: member="scim::FilterModule::FilterModule" ref="d49694d3b352620aeb267d01db4e6909" args="(const String &name, const ConfigPointer &config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FilterModule::FilterModule </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>config</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></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>name</em> </td><td>the module's name, eg. "sctc". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>a <a class="el" href="a00014.html">ConfigBase</a> instance to maintain the configuration. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dfd2d47b073a6b3e72be40feecd741d8"></a><!-- doxytag: member="scim::FilterModule::load" ref="dfd2d47b073a6b3e72be40feecd741d8" args="(const String &name, const ConfigPointer &config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterModule::load </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>config</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a Filter <a class="el" href="a00063.html">Module</a> by its name.
<p>
Load a module into memory. If another module has been loaded into this object, then the old module will be unloaded first. If the old module is resident, false will be returned, and the old module will be untouched.<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>name</em> </td><td>- the name of the Filter <a class="el" href="a00063.html">Module</a>. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>a <a class="el" href="a00014.html">ConfigBase</a> instance to maintain the configuration.</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="cb3a30ca5dda90164a7a7539c7630a58"></a><!-- doxytag: member="scim::FilterModule::unload" ref="cb3a30ca5dda90164a7a7539c7630a58" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterModule::unload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Unload the Filter <a class="el" href="a00063.html">Module</a>.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if sucessfully unloaded. </dd></dl>
</div>
</div><p>
<a class="anchor" name="520e2897747e5bc36e7e9becb3fad71a"></a><!-- doxytag: member="scim::FilterModule::valid" ref="520e2897747e5bc36e7e9becb3fad71a" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterModule::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a module is loaded and initialized successfully.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if a module is already loaded and initialized successfully. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9c2e16c148ec83bd2ba9e0efb99f8fcf"></a><!-- doxytag: member="scim::FilterModule::number_of_filters" ref="9c2e16c148ec83bd2ba9e0efb99f8fcf" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int scim::FilterModule::number_of_filters </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get how many Filter factories supported by this module.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of Filter factories. </dd></dl>
</div>
</div><p>
<a class="anchor" name="620f417f9f5a4e7f4bc89d98b59782cd"></a><!-- doxytag: member="scim::FilterModule::create_filter" ref="620f417f9f5a4e7f4bc89d98b59782cd" args="(unsigned int index) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00070.html">FilterFactoryPointer</a> scim::FilterModule::create_filter </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create an object for a Filter 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>index</em> </td><td>The index of the Filter factory, must be less than the result of number_of_factories method and greater than or equal to zero. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A smart pointer to the factory object, NULL if failed. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f65087520d06b0c52dffda19842516a4"></a><!-- doxytag: member="scim::FilterModule::get_filter_info" ref="f65087520d06b0c52dffda19842516a4" args="(unsigned int index, FilterInfo &info) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FilterModule::get_filter_info </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>index</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00027.html">FilterInfo</a> & </td>
<td class="paramname"> <em>info</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get basic information of the FilterFactory class provided by this module.
<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 of the Filter factory to be queried. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>info</em> </td><td>The result will be stored in this parameter.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>whether the info is successfully retrieved </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00127.html">scim_filter_module.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:38 2007 for scim by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
</body>
</html>
