<!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::CommonLookupTable 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="a00011.html">CommonLookupTable</a></div>
<h1>scim::CommonLookupTable Class Reference<br>
<small>
[<a class="el" href="a00158.html">Accessories</a>]</small>
</h1><!-- doxytag: class="scim::CommonLookupTable" --><!-- doxytag: inherits="scim::LookupTable" -->A common lookup table class.
<a href="#_details">More...</a>
<p>
<code>#include <scim_lookup_table.h></code>
<p>
Inheritance diagram for scim::CommonLookupTable:<p><center><img src="a00400.png" border="0" usemap="#a00401" alt="Inheritance graph"></center>
<map name="a00401">
<area href="a00055.html" shape="rect" coords="27,8,163,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for scim::CommonLookupTable:<p><center><img src="a00402.png" border="0" usemap="#a00403" alt="Collaboration graph"></center>
<map name="a00403">
<area href="a00055.html" shape="rect" coords="27,8,163,32" alt="">
</map>
<center><font size="2">[<a target="top" href="graph_legend.html">legend</a>]</font></center><a href="a00404.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="a00011.html#e89647a81e8d9936b2ce6e3d372f8ff2">CommonLookupTable</a> (int page_size=10)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#5849ee207598fd09f8f93acd73f5b88f">CommonLookupTable</a> (int page_size, const std::vector< <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> > &labels)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#5849ee207598fd09f8f93acd73f5b88f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#8ab8e1a525f325d306f3c7393f55f300">~CommonLookupTable</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="a00011.html#84614a5f971d95716e46394eae8191d2">get_candidate</a> (int index) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a candidate. <a href="#84614a5f971d95716e46394eae8191d2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#57a4a5734e1c134647fd6c094cce83ba">get_attributes</a> (int index) const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the attributes of a candidate. <a href="#57a4a5734e1c134647fd6c094cce83ba"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#db8489fdace4e44ac9cf2f11001f99af">number_of_candidates</a> () const</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of candidates in this table. <a href="#db8489fdace4e44ac9cf2f11001f99af"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#16472ade2321132ba6f0ad531aa4e751">clear</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clear the table. <a href="#16472ade2321132ba6f0ad531aa4e751"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#f96e1ed85ed14998e85cd2078040f171">append_candidate</a> (const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> &cand, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs=<a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a candidate string into the table. <a href="#f96e1ed85ed14998e85cd2078040f171"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00011.html#e932594f0987dec1879eba3f17bfc815">append_candidate</a> (<a class="el" href="a00157.html#34ddb69b99962cd0e75941288f8b2ee8">ucs4_t</a> cand, const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> &attrs=<a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>())</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Append a candidate char into the table. <a href="#e932594f0987dec1879eba3f17bfc815"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A common lookup table class.
<p>
This class implements the <a class="el" href="a00055.html">LookupTable</a> interface in a common way.
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e89647a81e8d9936b2ce6e3d372f8ff2"></a><!-- doxytag: member="scim::CommonLookupTable::CommonLookupTable" ref="e89647a81e8d9936b2ce6e3d372f8ff2" args="(int page_size=10)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::CommonLookupTable::CommonLookupTable </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>page_size</em> = <code>10</code> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="5849ee207598fd09f8f93acd73f5b88f"></a><!-- doxytag: member="scim::CommonLookupTable::CommonLookupTable" ref="5849ee207598fd09f8f93acd73f5b88f" args="(int page_size, const std::vector< WideString > &labels)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::CommonLookupTable::CommonLookupTable </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>page_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> > & </td>
<td class="paramname"> <em>labels</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>page_size</em> </td><td>- the maximum page size, can be set by set_page_size () later. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>labels</em> </td><td>- the strings to label the candidates in one page. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="8ab8e1a525f325d306f3c7393f55f300"></a><!-- doxytag: member="scim::CommonLookupTable::~CommonLookupTable" ref="8ab8e1a525f325d306f3c7393f55f300" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::CommonLookupTable::~CommonLookupTable </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="84614a5f971d95716e46394eae8191d2"></a><!-- doxytag: member="scim::CommonLookupTable::get_candidate" ref="84614a5f971d95716e46394eae8191d2" args="(int index) 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::CommonLookupTable::get_candidate </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get a candidate.
<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 candidate index in the lookup table. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the content of this candidate. </dd></dl>
<p>
Implements <a class="el" href="a00055.html#3c250b7d462583885ea705e4870e6e40">scim::LookupTable</a>.
</div>
</div><p>
<a class="anchor" name="57a4a5734e1c134647fd6c094cce83ba"></a><!-- doxytag: member="scim::CommonLookupTable::get_attributes" ref="57a4a5734e1c134647fd6c094cce83ba" args="(int index) const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> scim::CommonLookupTable::get_attributes </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>index</em> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the attributes of a candidate.
<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 in the lookup table. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the AttributeList object holding the attributes of this candidate. </dd></dl>
<p>
Implements <a class="el" href="a00055.html#0c3a579e64fd0f80beea0decaf896647">scim::LookupTable</a>.
</div>
</div><p>
<a class="anchor" name="db8489fdace4e44ac9cf2f11001f99af"></a><!-- doxytag: member="scim::CommonLookupTable::number_of_candidates" ref="db8489fdace4e44ac9cf2f11001f99af" args="() const" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#984ae8c1b52846cf538b7f936193d590">uint32</a> scim::CommonLookupTable::number_of_candidates </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the number of candidates in this table.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of entries currently in this table. </dd></dl>
<p>
Implements <a class="el" href="a00055.html#0e9e14cacb63a63ef583ca3d34c6b870">scim::LookupTable</a>.
</div>
</div><p>
<a class="anchor" name="16472ade2321132ba6f0ad531aa4e751"></a><!-- doxytag: member="scim::CommonLookupTable::clear" ref="16472ade2321132ba6f0ad531aa4e751" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void scim::CommonLookupTable::clear </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Clear the table.
<p>
<p>
Implements <a class="el" href="a00055.html#12f16e00fb475c3102a51b3435b2c740">scim::LookupTable</a>.
</div>
</div><p>
<a class="anchor" name="f96e1ed85ed14998e85cd2078040f171"></a><!-- doxytag: member="scim::CommonLookupTable::append_candidate" ref="f96e1ed85ed14998e85cd2078040f171" args="(const WideString &cand, const AttributeList &attrs=AttributeList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::CommonLookupTable::append_candidate </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#850f268430a53180832d6677ba9d27a8">WideString</a> & </td>
<td class="paramname"> <em>cand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> & </td>
<td class="paramname"> <em>attrs</em> = <code><a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a candidate string into the table.
<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>cand</em> </td><td>- a candidate string to be added into the table. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attrs</em> </td><td>- the attributes to control the display effect of this entry. It can be omitted if no attribute.</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="e932594f0987dec1879eba3f17bfc815"></a><!-- doxytag: member="scim::CommonLookupTable::append_candidate" ref="e932594f0987dec1879eba3f17bfc815" args="(ucs4_t cand, const AttributeList &attrs=AttributeList())" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::CommonLookupTable::append_candidate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00157.html#34ddb69b99962cd0e75941288f8b2ee8">ucs4_t</a> </td>
<td class="paramname"> <em>cand</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a> & </td>
<td class="paramname"> <em>attrs</em> = <code><a class="el" href="a00158.html#g81a9bf12437e21157b5fb7dabda841fe">AttributeList</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Append a candidate char into the table.
<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>cand</em> </td><td>- a candidate char to be added into the table. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>attrs</em> </td><td>- the attributes to control the display effect of this entry. It can be omitted if no attribute.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00140.html">scim_lookup_table.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 28 14:12:40 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>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-release
>
by-pkgid
>
3c9265ee0944a35fbede43df6ed55872
>
files
>
70
