<!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::DummyIMEngineFactory 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="a00022.html">DummyIMEngineFactory</a>
</div>
</div>
<div class="contents">
<h1>scim::DummyIMEngineFactory Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::DummyIMEngineFactory" --><!-- doxytag: inherits="scim::IMEngineFactoryBase" -->A trivial IMEngine that do nothing.
<a href="#_details">More...</a>
<p>
<code>#include <scim_imengine.h></code>
<p>
<p>
<a href="a00255.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="a00022.html#9bd77bfc09348ffbe9ed8f1f2a526eba">DummyIMEngineFactory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#276eb3c3f760e0e40b348d6a0c837e5f">~DummyIMEngineFactory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#4b1f0c4dca2afca32bf51e999ac8248b">get_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this input method engine. <a href="#4b1f0c4dca2afca32bf51e999ac8248b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#af015cfdac0fa23729c4adbdf9143bee">get_uuid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID of this input method engine. <a href="#af015cfdac0fa23729c4adbdf9143bee"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#604b020c0369c034d12f5f21401004f1">get_icon_file</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the icon file path of this input method engine. <a href="#604b020c0369c034d12f5f21401004f1"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#1b14bf683afb91d990c3f1dfe1af282f">get_authors</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the authors information of this input method engine. <a href="#1b14bf683afb91d990c3f1dfe1af282f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#46f4a39c5c52c5faaab439430cac2a04">get_credits</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the credits information of this input method engine. <a href="#46f4a39c5c52c5faaab439430cac2a04"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#7d1a720e5dd7a61cd7e49ea60abe5392">get_help</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the help information of this input method engine. <a href="#7d1a720e5dd7a61cd7e49ea60abe5392"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#74e85a453429e9f0d3b5409df3db046f">validate_encoding</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if an encoding is supported by this IMEngineFactory. <a href="#74e85a453429e9f0d3b5409df3db046f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#798b986e7006bb368b3252cf8855898e">validate_locale</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &locale) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if a locale is supported by this IMEngineFactory. <a href="#798b986e7006bb368b3252cf8855898e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00022.html#9aa887267c901bb8be1b29466a1ed47c">create_instance</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &encoding, int id=-1)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new IMEngineInstance object. <a href="#9aa887267c901bb8be1b29466a1ed47c"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A trivial IMEngine that do nothing. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="9bd77bfc09348ffbe9ed8f1f2a526eba"></a><!-- doxytag: member="scim::DummyIMEngineFactory::DummyIMEngineFactory" ref="9bd77bfc09348ffbe9ed8f1f2a526eba" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::DummyIMEngineFactory::DummyIMEngineFactory </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="276eb3c3f760e0e40b348d6a0c837e5f"></a><!-- doxytag: member="scim::DummyIMEngineFactory::~DummyIMEngineFactory" ref="276eb3c3f760e0e40b348d6a0c837e5f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::DummyIMEngineFactory::~DummyIMEngineFactory </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="4b1f0c4dca2afca32bf51e999ac8248b"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_name" ref="4b1f0c4dca2afca32bf51e999ac8248b" 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::DummyIMEngineFactory::get_name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the name of this input method engine.
<p>
This name should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the name. </dd></dl>
<p>Implements <a class="el" href="a00050.html#6921eee2666fee7ab3da416e53a7f2f6">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="af015cfdac0fa23729c4adbdf9143bee"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_uuid" ref="af015cfdac0fa23729c4adbdf9143bee" 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::DummyIMEngineFactory::get_uuid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the UUID of this input method engine.
<p>
Each input method engine has an unique UUID to distinguish itself from other engines.<p>
You may use uuidgen command shipped with e2fsprogs package to generate this UUID.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A String containing an unique UUID. </dd></dl>
<p>Implements <a class="el" href="a00050.html#7b3e039734251007df6947cf9d9b6c3a">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="604b020c0369c034d12f5f21401004f1"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_icon_file" ref="604b020c0369c034d12f5f21401004f1" 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::DummyIMEngineFactory::get_icon_file </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the icon file path of this input method engine.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A String containing the icon file path on the local filesystem. </dd></dl>
<p>Implements <a class="el" href="a00050.html#dc57c3a8c80ee4bcb830fd35a7111063">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="1b14bf683afb91d990c3f1dfe1af282f"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_authors" ref="1b14bf683afb91d990c3f1dfe1af282f" 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::DummyIMEngineFactory::get_authors </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the authors information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing a list of the authors' name. </dd></dl>
<p>Implements <a class="el" href="a00050.html#69dc66f38c39eabbade99f63467f1b6b">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="46f4a39c5c52c5faaab439430cac2a04"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_credits" ref="46f4a39c5c52c5faaab439430cac2a04" 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::DummyIMEngineFactory::get_credits </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the credits information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the credits information. </dd></dl>
<p>Implements <a class="el" href="a00050.html#c4b3d29d8b9d90dff700a795a3170db3">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="7d1a720e5dd7a61cd7e49ea60abe5392"></a><!-- doxytag: member="scim::DummyIMEngineFactory::get_help" ref="7d1a720e5dd7a61cd7e49ea60abe5392" 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::DummyIMEngineFactory::get_help </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the help information of this input method engine.
<p>
This string should be a localized string.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A WideString containing the help information. </dd></dl>
<p>Implements <a class="el" href="a00050.html#d077870f447a106341e252794d1709ec">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="74e85a453429e9f0d3b5409df3db046f"></a><!-- doxytag: member="scim::DummyIMEngineFactory::validate_encoding" ref="74e85a453429e9f0d3b5409df3db046f" args="(const String &encoding) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::DummyIMEngineFactory::validate_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> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if an encoding is supported by this IMEngineFactory.
<p>
The default implementation of this virtual function validates the encoding against the locale list set by method set_locales.<p>
It should be enough in most case.<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>encoding</em> </td><td>- the encoding name to be checked. </td></tr>
</table>
</dl>
<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="a00050.html#649b93485005351fcdd3d78113af6897">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="798b986e7006bb368b3252cf8855898e"></a><!-- doxytag: member="scim::DummyIMEngineFactory::validate_locale" ref="798b986e7006bb368b3252cf8855898e" args="(const String &locale) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::DummyIMEngineFactory::validate_locale </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>locale</em> </td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if a locale is supported by this IMEngineFactory.
<p>
The default implementation of this virtual function validates the locale against the locale list set by method set_locales.<p>
It should be enough in most case.<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>locale</em> </td><td>- the locale name to be checked. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the locale is supported, otherwise false. </dd></dl>
<p>Reimplemented from <a class="el" href="a00050.html#f9ca6ba3bcff44112df84cd98b02c88f">scim::IMEngineFactoryBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="9aa887267c901bb8be1b29466a1ed47c"></a><!-- doxytag: member="scim::DummyIMEngineFactory::create_instance" ref="9aa887267c901bb8be1b29466a1ed47c" args="(const String &encoding, int id=-1)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00070.html">IMEngineInstancePointer</a> scim::DummyIMEngineFactory::create_instance </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>encoding</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>id</em> = <code>-1</code></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>
Create a new IMEngineInstance object.
<p>
This method creates a new <a class="el" href="a00052.html" title="The base class of the real input methods' IMEngineInstance classes.">scim::IMEngineInstanceBase</a> object with the given encoding and id.<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>encoding</em> </td><td>- the encoding supported by the client. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>id</em> </td><td>- the instance id, should be unique. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A smart pointer points to this new IMEngineInstance object. </dd></dl>
<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="a00136.html">scim_imengine.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:42 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>
