<!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: FrontEnd</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><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>FrontEnd</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00032.html">scim::FrontEndError</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An exception class to hold FrontEnd related errors. <a href="a00032.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00031.html">scim::FrontEndBase</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The base class to implement the FrontEnd objects. <a href="a00031.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00034.html">scim::FrontEndModule</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The class to manipulate the frontend modules. <a href="a00034.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Pointer< FrontEndBase > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#g0c6a34624ff51f12378c46f27a6d0801">scim::FrontEndPointer</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#gc08c47868282d03fc4c114ce91ad991b">scim::FrontEndModuleInitFunc</a> )(const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize a FrontEnd <a class="el" href="a00063.html">Module</a>. <a href="#gc08c47868282d03fc4c114ce91ad991b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#gb593b517cc68c9e8de8313a12f886b99">scim::FrontEndModuleRunFunc</a> )(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Run a FrontEnd <a class="el" href="a00063.html">Module</a>. <a href="#gb593b517cc68c9e8de8313a12f886b99"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00162.html#gf2e20b33321ec57afcc20bca767d13b2">scim::scim_get_frontend_module_list</a> (std::vector< String > &mod_list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a name list of currently available frontend modules. <a href="#gf2e20b33321ec57afcc20bca767d13b2"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base classes for FrontEnd modules. <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g0c6a34624ff51f12378c46f27a6d0801"></a><!-- doxytag: member="scim::FrontEndPointer" ref="g0c6a34624ff51f12378c46f27a6d0801" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef Pointer< FrontEndBase > <a class="el" href="a00070.html">scim::FrontEndPointer</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A smart pointer for <a class="el" href="a00031.html" title="The base class to implement the FrontEnd objects.">scim::FrontEndBase</a> and its derived classes.
</div>
</div><p>
<a class="anchor" name="gc08c47868282d03fc4c114ce91ad991b"></a><!-- doxytag: member="scim::FrontEndModuleInitFunc" ref="gc08c47868282d03fc4c114ce91ad991b" args=")(const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="a00162.html#gc08c47868282d03fc4c114ce91ad991b">scim::FrontEndModuleInitFunc</a>)(const BackEndPointer &backend, const ConfigPointer &config, int argc, char **argv) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize a FrontEnd <a class="el" href="a00063.html">Module</a>.
<p>
There must be a function called "scim_frontend_module_init" in each frontend module which complies with this prototype. This function name can have a prefix like x11_LTX_, in which "x11" is the module's name.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>backend</em> </td><td>- a BackEnd instance which hold all IMEngineFactory instances. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>- a <a class="el" href="a00014.html" title="The interface class to access the configuration data.">ConfigBase</a> instance to maintain the configuration. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gb593b517cc68c9e8de8313a12f886b99"></a><!-- doxytag: member="scim::FrontEndModuleRunFunc" ref="gb593b517cc68c9e8de8313a12f886b99" args=")(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* <a class="el" href="a00162.html#gb593b517cc68c9e8de8313a12f886b99">scim::FrontEndModuleRunFunc</a>)(void) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Run a FrontEnd <a class="el" href="a00063.html">Module</a>.
<p>
There must be a function called "scim_frontend_module_run" in each frontend module which complies with this prototype. This function name can have a prefix like x11_LTX_, in which "x11" is the module's name.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gf2e20b33321ec57afcc20bca767d13b2"></a><!-- doxytag: member="scim::scim_get_frontend_module_list" ref="gf2e20b33321ec57afcc20bca767d13b2" args="(std::vector< String > &mod_list)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::scim_get_frontend_module_list </td>
<td>(</td>
<td class="paramtype">std::vector< String > & </td>
<td class="paramname"> <em>mod_list</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a name list of currently available frontend modules.
<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>mod_list</em> </td><td>- the result list will be stored here. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of the modules, equal to mod_list.size (). </dd></dl>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:37 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>
