<!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::ConfigBase 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="a00014.html">ConfigBase</a>
</div>
</div>
<div class="contents">
<h1>scim::ConfigBase Class Reference<br>
<small>
[<a class="el" href="a00161.html">Config</a>]</small>
</h1><!-- doxytag: class="scim::ConfigBase" --><!-- doxytag: inherits="scim::ReferencedObject" -->The interface class to access the configuration data.
<a href="#_details">More...</a>
<p>
<code>#include <scim_config_base.h></code>
<p>
<p>
<a href="a00226.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 colspan="2"><div class="groupHeader">Constructor and Destructor.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#cf56d4a508b4a6800797fde987310f72">ConfigBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Contrustor. <a href="#cf56d4a508b4a6800797fde987310f72"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#54a2e088138586f33b36944c526b3ed4">~ConfigBase</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Virtual destructor empty but ensures that dtor of all derived classes is virtual. <a href="#54a2e088138586f33b36944c526b3ed4"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Pure virtual methods which should be implemented in derived classes.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#e720e362afb14e676f085693de54fc8a">valid</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Check if this Config object is valid. <a href="#e720e362afb14e676f085693de54fc8a"></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="a00014.html#4d2f00acafe3a8911ae4e741b97c7439">get_name</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of this configuration module. <a href="#4d2f00acafe3a8911ae4e741b97c7439"></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="a00014.html#d9fed9514a1ce654167086bb8e359ecc">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string from the given key. <a href="#d9fed9514a1ce654167086bb8e359ecc"></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="a00014.html#cae40a3eab88d11974b79cfdc9cd29d4">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, int *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read an int value from the given key. <a href="#cae40a3eab88d11974b79cfdc9cd29d4"></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="a00014.html#56f734168bc0e231a39e837fe695f522">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, double *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a double value from the given key. <a href="#56f734168bc0e231a39e837fe695f522"></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="a00014.html#f2a78d9e6c1bca8d53be89af7f9077d5">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, bool *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a bool value from the given key. <a href="#f2a78d9e6c1bca8d53be89af7f9077d5"></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="a00014.html#3a332a697c5fa4af7f3af5501900cc77">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string list from the given key. <a href="#3a332a697c5fa4af7f3af5501900cc77"></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="a00014.html#aa2e07c94fba25c786d2451708c49cbb">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, std::vector< int > *ret) const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read an int list from the given key. <a href="#aa2e07c94fba25c786d2451708c49cbb"></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="a00014.html#89ff8f5744d90eba7fc998183be41337">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a string to the given key. <a href="#89ff8f5744d90eba7fc998183be41337"></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="a00014.html#5939e08fb974d30be53d64f2587feaeb">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, int value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write an int value to the given key. <a href="#5939e08fb974d30be53d64f2587feaeb"></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="a00014.html#300cf1c508109f32e71348efa13974e5">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, double value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a double value to the given key. <a href="#300cf1c508109f32e71348efa13974e5"></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="a00014.html#905b1abc502bb06e154ce7525fbb96cd">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, bool value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a bool value to the given key. <a href="#905b1abc502bb06e154ce7525fbb96cd"></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="a00014.html#ce19b0755ad9795d8baebb31a4ef7d1d">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write a string list to the given key. <a href="#ce19b0755ad9795d8baebb31a4ef7d1d"></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="a00014.html#9abc5349ca5c5433eca91895bde3bfa7">write</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const std::vector< int > &value)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Write an int list to the given key. <a href="#9abc5349ca5c5433eca91895bde3bfa7"></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="a00014.html#a9824385a67753fc96fb57bdcef1fb72">flush</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Permanently writes all changes. <a href="#a9824385a67753fc96fb57bdcef1fb72"></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="a00014.html#73ee5cc8ee1c7dfe6cb653d4a9cbc079">erase</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Erase a key and its value. <a href="#73ee5cc8ee1c7dfe6cb653d4a9cbc079"></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="a00014.html#5bb8f187d9458de729e7ad5c1f7b3efe">reload</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reload the configurations from storage. <a href="#5bb8f187d9458de729e7ad5c1f7b3efe"></a><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Other helper methods.</div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#aefe25553c16c72944f29ce2e750d499">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &defVal=<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>()) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string from the given key with a default fallback value. <a href="#aefe25553c16c72944f29ce2e750d499"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#9d817f947b662f5ca17aa51c455636ad">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, int defVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read an int value from the given key with a default fallback value. <a href="#9d817f947b662f5ca17aa51c455636ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#c86971c14ccf0c4fe10882ac44e93078">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, double defVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a double value from the given key with a default fallback value. <a href="#c86971c14ccf0c4fe10882ac44e93078"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#0141e0b95c8b7e5b0ff62a7d6a9a178a">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, bool defVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a bool value from the given key with a default fallback value. <a href="#0141e0b95c8b7e5b0ff62a7d6a9a178a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#049517c19eb82a05b77f8304223c61aa">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > &defVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string list from the given key with a default fallback value. <a href="#049517c19eb82a05b77f8304223c61aa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#9253bcd6179a740f0ac2a8eed6159a98">read</a> (const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &key, const std::vector< int > &defVal) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Read an int list from the given key with a default fallback value. <a href="#9253bcd6179a740f0ac2a8eed6159a98"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="a00017.html">Connection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#fd5f4aff60fe45968dad84dbff8fe6c8">signal_connect_reload</a> (<a class="el" href="a00097.html">ConfigSlotVoid</a> *slot)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">connect the given slot to the reload signal. <a href="#fd5f4aff60fe45968dad84dbff8fe6c8"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00070.html">ConfigPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#43e9426c3970cfbbaab509b328a3a104">set</a> (const <a class="el" href="a00070.html">ConfigPointer</a> &p_config)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the default global Config object. <a href="#43e9426c3970cfbbaab509b328a3a104"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="a00070.html">ConfigPointer</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00014.html#73a79b17ea541355cdabd740002f5008">get</a> (bool create_on_demand=true, const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> &default_module=<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>(""))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the default global Config object. <a href="#73a79b17ea541355cdabd740002f5008"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The interface class to access the configuration data.
<p>
This is an interface class to access the configuration data. All of the SCIM objects which have configuration data should use this interface to store and load them. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="cf56d4a508b4a6800797fde987310f72"></a><!-- doxytag: member="scim::ConfigBase::ConfigBase" ref="cf56d4a508b4a6800797fde987310f72" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">scim::ConfigBase::ConfigBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Contrustor.
<p>
</div>
</div><p>
<a class="anchor" name="54a2e088138586f33b36944c526b3ed4"></a><!-- doxytag: member="scim::ConfigBase::~ConfigBase" ref="54a2e088138586f33b36944c526b3ed4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual scim::ConfigBase::~ConfigBase </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor empty but ensures that dtor of all derived classes is virtual.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="e720e362afb14e676f085693de54fc8a"></a><!-- doxytag: member="scim::ConfigBase::valid" ref="e720e362afb14e676f085693de54fc8a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::valid </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if this Config object is valid.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if its valid and ready to work. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#49b9586fed01e03740d6a73ff007221f">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="4d2f00acafe3a8911ae4e741b97c7439"></a><!-- doxytag: member="scim::ConfigBase::get_name" ref="4d2f00acafe3a8911ae4e741b97c7439" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::ConfigBase::get_name </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the name of this configuration module.
<p>
This name must be same as the config module's name.
<p>Implemented in <a class="el" href="a00021.html#ee52bb51be2b69f45928b0c547b35e0b">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9fed9514a1ce654167086bb8e359ecc"></a><!-- doxytag: member="scim::ConfigBase::read" ref="d9fed9514a1ce654167086bb8e359ecc" args="(const String &key, String *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a string from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the string is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#c1bc6dd6b666f7f9734bc2836925ba08">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="cae40a3eab88d11974b79cfdc9cd29d4"></a><!-- doxytag: member="scim::ConfigBase::read" ref="cae40a3eab88d11974b79cfdc9cd29d4" args="(const String &key, int *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read an int value from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#61024264acb2c4becd698f351fbf050e">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="56f734168bc0e231a39e837fe695f522"></a><!-- doxytag: member="scim::ConfigBase::read" ref="56f734168bc0e231a39e837fe695f522" args="(const String &key, double *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a double value from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#bbffd8e352b75203657146f6797b3939">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="f2a78d9e6c1bca8d53be89af7f9077d5"></a><!-- doxytag: member="scim::ConfigBase::read" ref="f2a78d9e6c1bca8d53be89af7f9077d5" args="(const String &key, bool *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a bool value from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the value is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#d1a03e1ac6e1f87a2c986d03f69d8c92">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="3a332a697c5fa4af7f3af5501900cc77"></a><!-- doxytag: member="scim::ConfigBase::read" ref="3a332a697c5fa4af7f3af5501900cc77" args="(const String &key, std::vector< String > *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a string list from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the string list is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#c58e0513cba90f3884b2b2f3770d9c88">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="aa2e07c94fba25c786d2451708c49cbb"></a><!-- doxytag: member="scim::ConfigBase::read" ref="aa2e07c94fba25c786d2451708c49cbb" args="(const String &key, std::vector< int > *ret) const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< int > * </td>
<td class="paramname"> <em>ret</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read an int list from the given key.
<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ret</em> </td><td>- the result will be stored into *ret. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if the int list is read successfully, otherwise return false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#0517b6f041becee217591bad1bd9e08a">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="89ff8f5744d90eba7fc998183be41337"></a><!-- doxytag: member="scim::ConfigBase::write" ref="89ff8f5744d90eba7fc998183be41337" args="(const String &key, const String &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a string to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the string to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#a0247e8a5de58d7c80bddae5d1f8e92e">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="5939e08fb974d30be53d64f2587feaeb"></a><!-- doxytag: member="scim::ConfigBase::write" ref="5939e08fb974d30be53d64f2587feaeb" args="(const String &key, int value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write an int value to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the int value to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#e20fdb06eecfe9439c6b003a2d10b40d">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="300cf1c508109f32e71348efa13974e5"></a><!-- doxytag: member="scim::ConfigBase::write" ref="300cf1c508109f32e71348efa13974e5" args="(const String &key, double value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a double value to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the double value to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#cebf4a876f7e1d2f585757c3be233609">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="905b1abc502bb06e154ce7525fbb96cd"></a><!-- doxytag: member="scim::ConfigBase::write" ref="905b1abc502bb06e154ce7525fbb96cd" args="(const String &key, bool value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a bool value to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the bool value to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#7fc97b4cc7ce2d56938f6dbd4004a7fe">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="ce19b0755ad9795d8baebb31a4ef7d1d"></a><!-- doxytag: member="scim::ConfigBase::write" ref="ce19b0755ad9795d8baebb31a4ef7d1d" args="(const String &key, const std::vector< String > &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write a string list to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the string list to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#c74b59ce79545306e58f7e5ceed5cb5e">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="9abc5349ca5c5433eca91895bde3bfa7"></a><!-- doxytag: member="scim::ConfigBase::write" ref="9abc5349ca5c5433eca91895bde3bfa7" args="(const String &key, const std::vector< int > &value)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::write </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"> <em>value</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write an int list to the given key.
<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>key</em> </td><td>- the key to be written. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>- the int list to be written to the key. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success, otherwise false. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#f54acc8a1efd76e81819b16b080ad014">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="a9824385a67753fc96fb57bdcef1fb72"></a><!-- doxytag: member="scim::ConfigBase::flush" ref="a9824385a67753fc96fb57bdcef1fb72" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::flush </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Permanently writes all changes.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#2555bb79ca1ecb6b084de579c6a6daa1">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="73ee5cc8ee1c7dfe6cb653d4a9cbc079"></a><!-- doxytag: member="scim::ConfigBase::erase" ref="73ee5cc8ee1c7dfe6cb653d4a9cbc079" args="(const String &key)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::erase </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Erase a key and its value.
<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>key</em> </td><td>- the key to be erased. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#d9c987174ba7f5d8a5fc470c62dc7a9d">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="5bb8f187d9458de729e7ad5c1f7b3efe"></a><!-- doxytag: member="scim::ConfigBase::reload" ref="5bb8f187d9458de729e7ad5c1f7b3efe" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool scim::ConfigBase::reload </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reload the configurations from storage.
<p>
All modified keys after the last flush maybe lost.<p>
The derived method should call this base method after reload the configurations successfully, in order to emit the reload signal.<p>
The derived method should have some machanism to avoid reload again if there is no update after the previous reload.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>true if success. </dd></dl>
<p>Implemented in <a class="el" href="a00021.html#96c93844f53bc83426a10454b2f7487d">scim::DummyConfig</a>.</p>
</div>
</div><p>
<a class="anchor" name="aefe25553c16c72944f29ce2e750d499"></a><!-- doxytag: member="scim::ConfigBase::read" ref="aefe25553c16c72944f29ce2e750d499" args="(const String &key, const String &defVal=String()) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>defVal</em> = <code><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>()</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a string from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result string. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9d817f947b662f5ca17aa51c455636ad"></a><!-- doxytag: member="scim::ConfigBase::read" ref="9d817f947b662f5ca17aa51c455636ad" args="(const String &key, int defVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>defVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read an int value from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result int value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="c86971c14ccf0c4fe10882ac44e93078"></a><!-- doxytag: member="scim::ConfigBase::read" ref="c86971c14ccf0c4fe10882ac44e93078" args="(const String &key, double defVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>defVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a double value from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result double value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="0141e0b95c8b7e5b0ff62a7d6a9a178a"></a><!-- doxytag: member="scim::ConfigBase::read" ref="0141e0b95c8b7e5b0ff62a7d6a9a178a" args="(const String &key, bool defVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>defVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a bool value from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result bool value. </dd></dl>
</div>
</div><p>
<a class="anchor" name="049517c19eb82a05b77f8304223c61aa"></a><!-- doxytag: member="scim::ConfigBase::read" ref="049517c19eb82a05b77f8304223c61aa" args="(const String &key, const std::vector< String > &defVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<<a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>> scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> > & </td>
<td class="paramname"> <em>defVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read a string list from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result string list. </dd></dl>
</div>
</div><p>
<a class="anchor" name="9253bcd6179a740f0ac2a8eed6159a98"></a><!-- doxytag: member="scim::ConfigBase::read" ref="9253bcd6179a740f0ac2a8eed6159a98" args="(const String &key, const std::vector< int > &defVal) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<int> scim::ConfigBase::read </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"> <em>defVal</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Read an int list from the given key with a default fallback value.
<p>
If failed to read from the given key, then return the given default value.<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>key</em> </td><td>- the key to be read. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>defVal</em> </td><td>- the default value to be return if failed to read. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>The result int list. </dd></dl>
</div>
</div><p>
<a class="anchor" name="fd5f4aff60fe45968dad84dbff8fe6c8"></a><!-- doxytag: member="scim::ConfigBase::signal_connect_reload" ref="fd5f4aff60fe45968dad84dbff8fe6c8" args="(ConfigSlotVoid *slot)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00017.html">Connection</a> scim::ConfigBase::signal_connect_reload </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00097.html">ConfigSlotVoid</a> * </td>
<td class="paramname"> <em>slot</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
connect the given slot to the reload signal.
<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>slot</em> </td><td>- the given slot to be connected. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the <a class="el" href="a00017.html" title="A signal connection class.">Connection</a> object, can be used to disconnect this slot. </dd></dl>
</div>
</div><p>
<a class="anchor" name="43e9426c3970cfbbaab509b328a3a104"></a><!-- doxytag: member="scim::ConfigBase::set" ref="43e9426c3970cfbbaab509b328a3a104" args="(const ConfigPointer &p_config)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00070.html">ConfigPointer</a> scim::ConfigBase::set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00070.html">ConfigPointer</a> & </td>
<td class="paramname"> <em>p_config</em> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the default global Config object.
<p>
There is only one global Config object in an application. All other objects should use it by default.<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>p_config</em> </td><td>- a smart pointer to the Config object. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a smart pointer to the old default Config object. </dd></dl>
</div>
</div><p>
<a class="anchor" name="73a79b17ea541355cdabd740002f5008"></a><!-- doxytag: member="scim::ConfigBase::get" ref="73a79b17ea541355cdabd740002f5008" args="(bool create_on_demand=true, const String &default_module=String(""))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00070.html">ConfigPointer</a> scim::ConfigBase::get </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>create_on_demand</em> = <code>true</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a> & </td>
<td class="paramname"> <em>default_module</em> = <code><a class="el" href="a00157.html#e6432a785654dd7fbfe52e8dd8cd7799">String</a>("")</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the default global Config object.
<p>
The default global Config object can be set with function <a class="el" href="a00014.html#43e9426c3970cfbbaab509b328a3a104" title="Set the default global Config object.">ConfigBase::set</a>. If there is no default object set, a new object can be created if needed.<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>create_on_demand</em> </td><td>- if it's true then a new object will be created, if there is no one available. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>default_module</em> </td><td>- the Config module should be used to create the default Config object. If omitted, then use the default module defined in global config file. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a smart pointer to the default global Config object. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="a00118.html">scim_config_base.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>
