Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members

scim::DummyConfig Class Reference
[Config]

A dummy implementation of interface class scim::ConfigBase. More...

#include <scim_config_base.h>

Inheritance diagram for scim::DummyConfig:

Inheritance graph
[legend]
Collaboration diagram for scim::DummyConfig:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 DummyConfig (const String &app_name=String("scim"))
virtual ~DummyConfig ()
virtual bool valid () const
 Check if this Config object is valid.

virtual bool read (const String &key, String *ret) const
 Read a string from the given key.

virtual bool read (const String &key, int *ret) const
 Read an int value from the given key.

virtual bool read (const String &key, double *ret) const
 Read a double value from the given key.

virtual bool read (const String &key, bool *ret) const
 Read a bool value from the given key.

virtual bool read (const String &key, std::vector< String > *ret) const
 Read a string list from the given key.

virtual bool read (const String &key, std::vector< int > *ret) const
 Read an int list from the given key.

virtual bool write (const String &key, const String &value)
 Write a string to the given key.

virtual bool write (const String &key, int value)
 Write an int value to the given key.

virtual bool write (const String &key, double value)
 Write a double value to the given key.

virtual bool write (const String &key, bool value)
 Write a bool value to the given key.

virtual bool write (const String &key, const std::vector< String > &value)
 Write a string list to the given key.

virtual bool write (const String &key, const std::vector< int > &value)
 Write an int list to the given key.

virtual bool flush ()
 Permanently writes all changes.

virtual bool erase (const String &key)
 Erase a key and its value.


Detailed Description

A dummy implementation of interface class scim::ConfigBase.

The read methods will just return false and the default value (if available). The write methods will do nothing.

Definition at line 342 of file scim_config_base.h.


Constructor & Destructor Documentation

scim::DummyConfig::DummyConfig const String app_name = String("scim")  ) 
 

virtual scim::DummyConfig::~DummyConfig  )  [virtual]
 


Member Function Documentation

virtual bool scim::DummyConfig::valid  )  const [virtual]
 

Check if this Config object is valid.

Returns:
true if its valid and ready to work.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
String ret
const [virtual]
 

Read a string from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the string is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
int *  ret
const [virtual]
 

Read an int value from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the value is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
double *  ret
const [virtual]
 

Read a double value from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the value is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
bool *  ret
const [virtual]
 

Read a bool value from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the value is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
std::vector< String > *  ret
const [virtual]
 

Read a string list from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the string list is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::read const String key,
std::vector< int > *  ret
const [virtual]
 

Read an int list from the given key.

Parameters:
key - the key to be read.
ret - the result will be stored into *ret.
Returns:
true if the int list is read successfully, otherwise return false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
const String value
[virtual]
 

Write a string to the given key.

Parameters:
key - the key to be written.
value - the string to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
int  value
[virtual]
 

Write an int value to the given key.

Parameters:
key - the key to be written.
value - the int value to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
double  value
[virtual]
 

Write a double value to the given key.

Parameters:
key - the key to be written.
value - the double value to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
bool  value
[virtual]
 

Write a bool value to the given key.

Parameters:
key - the key to be written.
value - the bool value to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
const std::vector< String > &  value
[virtual]
 

Write a string list to the given key.

Parameters:
key - the key to be written.
value - the string list to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::write const String key,
const std::vector< int > &  value
[virtual]
 

Write an int list to the given key.

Parameters:
key - the key to be written.
value - the int list to be written to the key.
Returns:
true if success, otherwise false.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::flush  )  [virtual]
 

Permanently writes all changes.

Returns:
true if success.

Implements scim::ConfigBase.

virtual bool scim::DummyConfig::erase const String key  )  [virtual]
 

Erase a key and its value.

Parameters:
key - the key to be erased.
Returns:
true if success.

Implements scim::ConfigBase.


The documentation for this class was generated from the following file:
Generated on Fri May 7 17:27:27 2004 for scim by doxygen 1.3.6