<!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::ComposeKeyFactory 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="a00012.html">ComposeKeyFactory</a>
</div>
</div>
<div class="contents">
<h1>scim::ComposeKeyFactory Class Reference<br>
<small>
[<a class="el" href="a00160.html">IMEngine</a>]</small>
</h1><!-- doxytag: class="scim::ComposeKeyFactory" --><!-- doxytag: inherits="scim::IMEngineFactoryBase" -->A simple IMEngine to deal with the Compose keys.
<a href="#_details">More...</a>
<p>
<code>#include <scim_compose_key.h></code>
<p>
<p>
<a href="a00223.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="a00012.html#4972638b61ed2ecd3432f106002cb4e4">ComposeKeyFactory</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00012.html#16e8fd9d08bd5225a223708192602126">~ComposeKeyFactory</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="a00012.html#6a00b436255e3e5dda3fd940467569a2">get_name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the name of this input method engine. <a href="#6a00b436255e3e5dda3fd940467569a2"></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="a00012.html#4229ae829bfb9ce79df99d339dbcb818">get_uuid</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the UUID of this input method engine. <a href="#4229ae829bfb9ce79df99d339dbcb818"></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="a00012.html#b4cec54624d68f0d012a46087ae66b2d">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="#b4cec54624d68f0d012a46087ae66b2d"></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="a00012.html#16a7a4d1735ff89c37e78d65fc97031b">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="#16a7a4d1735ff89c37e78d65fc97031b"></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="a00012.html#f26de9ffee1ebfbdca5161fece8c7d49">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="#f26de9ffee1ebfbdca5161fece8c7d49"></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="a00012.html#2fbb13b1b84952c87b743043e85d3914">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="#2fbb13b1b84952c87b743043e85d3914"></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="a00012.html#a0a2c89274d9b8e920002b4a3998c336">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="#a0a2c89274d9b8e920002b4a3998c336"></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="a00012.html#960cfdd285370bafd13cf313bedd0663">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="#960cfdd285370bafd13cf313bedd0663"></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="a00012.html#3994313c8151a390834e7863286ed628">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="#3994313c8151a390834e7863286ed628"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A simple IMEngine to deal with the Compose keys. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="4972638b61ed2ecd3432f106002cb4e4"></a><!-- doxytag: member="scim::ComposeKeyFactory::ComposeKeyFactory" ref="4972638b61ed2ecd3432f106002cb4e4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::ComposeKeyFactory::ComposeKeyFactory </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="16e8fd9d08bd5225a223708192602126"></a><!-- doxytag: member="scim::ComposeKeyFactory::~ComposeKeyFactory" ref="16e8fd9d08bd5225a223708192602126" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::ComposeKeyFactory::~ComposeKeyFactory </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="6a00b436255e3e5dda3fd940467569a2"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_name" ref="6a00b436255e3e5dda3fd940467569a2" 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::ComposeKeyFactory::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="4229ae829bfb9ce79df99d339dbcb818"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_uuid" ref="4229ae829bfb9ce79df99d339dbcb818" 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::ComposeKeyFactory::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="b4cec54624d68f0d012a46087ae66b2d"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_icon_file" ref="b4cec54624d68f0d012a46087ae66b2d" 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::ComposeKeyFactory::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="16a7a4d1735ff89c37e78d65fc97031b"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_authors" ref="16a7a4d1735ff89c37e78d65fc97031b" 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::ComposeKeyFactory::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="f26de9ffee1ebfbdca5161fece8c7d49"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_credits" ref="f26de9ffee1ebfbdca5161fece8c7d49" 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::ComposeKeyFactory::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="2fbb13b1b84952c87b743043e85d3914"></a><!-- doxytag: member="scim::ComposeKeyFactory::get_help" ref="2fbb13b1b84952c87b743043e85d3914" 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::ComposeKeyFactory::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="a0a2c89274d9b8e920002b4a3998c336"></a><!-- doxytag: member="scim::ComposeKeyFactory::validate_encoding" ref="a0a2c89274d9b8e920002b4a3998c336" args="(const String &encoding) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ComposeKeyFactory::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="960cfdd285370bafd13cf313bedd0663"></a><!-- doxytag: member="scim::ComposeKeyFactory::validate_locale" ref="960cfdd285370bafd13cf313bedd0663" args="(const String &locale) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ComposeKeyFactory::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="3994313c8151a390834e7863286ed628"></a><!-- doxytag: member="scim::ComposeKeyFactory::create_instance" ref="3994313c8151a390834e7863286ed628" 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::ComposeKeyFactory::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="a00116.html">scim_compose_key.h</a></ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Apr 19 13:02:39 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>
