<!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::FrontEndModule 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="a00034.html">FrontEndModule</a>
</div>
</div>
<div class="contents">
<h1>scim::FrontEndModule Class Reference<br>
<small>
[<a class="el" href="a00162.html">FrontEnd</a>]</small>
</h1><!-- doxytag: class="scim::FrontEndModule" -->The class to manipulate the frontend modules.
<a href="#_details">More...</a>
<p>
<code>#include <scim_frontend_module.h></code>
<p>
<p>
<a href="a00242.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="a00034.html#d3d51b42e32b87530b7ee28c25db4709">FrontEndModule</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#d3d51b42e32b87530b7ee28c25db4709"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#73331df08a13e6fda3343d388c3679fb">FrontEndModule</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name, const <a class="el" href="a00070.html">BackEndPointer</a> &backend, const <a class="el" href="a00070.html">ConfigPointer</a> &config, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#73331df08a13e6fda3343d388c3679fb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#51d6bf56801cb04413e4e6a7de15eb1b">load</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &name, const <a class="el" href="a00070.html">BackEndPointer</a> &backend, const <a class="el" href="a00070.html">ConfigPointer</a> &config, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Load a FrontEnd module by its name. <a href="#51d6bf56801cb04413e4e6a7de15eb1b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#9ccafd8ec9e9a172f9fedcb13716ee72">valid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a module is loaded and initialized successfully. <a href="#9ccafd8ec9e9a172f9fedcb13716ee72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html#c830eaa84ebadb796cfd8d913a6f85f9">run</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">run this FrontEnd module. <a href="#c830eaa84ebadb796cfd8d913a6f85f9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The class to manipulate the frontend modules.
<p>
This is a wrapper of <a class="el" href="a00063.html">scim::Module</a> class, which is specially for manipulating the frontend modules. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="d3d51b42e32b87530b7ee28c25db4709"></a><!-- doxytag: member="scim::FrontEndModule::FrontEndModule" ref="d3d51b42e32b87530b7ee28c25db4709" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FrontEndModule::FrontEndModule </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Default constructor.
<p>
</div>
</div><p>
<a class="anchor" name="73331df08a13e6fda3343d388c3679fb"></a><!-- doxytag: member="scim::FrontEndModule::FrontEndModule" ref="73331df08a13e6fda3343d388c3679fb" args="(const String &name, const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::FrontEndModule::FrontEndModule </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">BackEndPointer</a> & </td>
<td class="paramname"> <em>backend</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>
</tr>
<tr>
<td class="paramkey"></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></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. "rawcode". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backend</em> </td><td>- a BackEnd instance which holds all IMEngineFactory instances. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>- a smart pointer points to a <a class="el" href="a00014.html" title="The interface class to access the configuration data.">ConfigBase</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>- the number of (fake) command line arguments </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>- the (fake) command line argument vector </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="51d6bf56801cb04413e4e6a7de15eb1b"></a><!-- doxytag: member="scim::FrontEndModule::load" ref="51d6bf56801cb04413e4e6a7de15eb1b" args="(const String &name, const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndModule::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">BackEndPointer</a> & </td>
<td class="paramname"> <em>backend</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>
</tr>
<tr>
<td class="paramkey"></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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Load a FrontEnd module 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 module's name, eg. "rawcode". </td></tr>
<tr><td valign="top"></td><td valign="top"><em>backend</em> </td><td>- a BackEnd instance which holds all IMEngineFactory instances. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>- a smart pointer points to a <a class="el" href="a00014.html" title="The interface class to access the configuration data.">ConfigBase</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argc</em> </td><td>- the number of (fake) command line arguments </td></tr>
<tr><td valign="top"></td><td valign="top"><em>argv</em> </td><td>- the (fake) command line argument vector </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="9ccafd8ec9e9a172f9fedcb13716ee72"></a><!-- doxytag: member="scim::FrontEndModule::valid" ref="9ccafd8ec9e9a172f9fedcb13716ee72" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::FrontEndModule::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> 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="c830eaa84ebadb796cfd8d913a6f85f9"></a><!-- doxytag: member="scim::FrontEndModule::run" ref="c830eaa84ebadb796cfd8d913a6f85f9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void scim::FrontEndModule::run </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
run this FrontEnd module.
<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00129.html">scim_frontend_module.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:41 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>
