scim 1.4.18
scim_global_config.h File Reference

functions to read the global configurations. More...

Namespaces

namespace  scim
 

Functions

String scim::scim_global_config_read (const String &key, const String &defVal=String())
 Read a string value from the global configuration file.
 
int scim::scim_global_config_read (const String &key, int defVal)
 Read an int value from the global configuration file.
 
bool scim::scim_global_config_read (const String &key, bool defVal)
 Read a bool value from the global configuration file.
 
double scim::scim_global_config_read (const String &key, double defVal)
 Read a double value from the global configuration file.
 
std::vector< Stringscim::scim_global_config_read (const String &key, const std::vector< String > &defVal)
 Read a string list from the global configuration file.
 
std::vector< intscim::scim_global_config_read (const String &key, const std::vector< int > &defVal)
 Read an int list from the global configuration file.
 
void scim::scim_global_config_write (const String &key, const String &val)
 Write a string value into the user global config.
 
void scim::scim_global_config_write (const String &key, int val)
 Write an int value into the user global config.
 
void scim::scim_global_config_write (const String &key, bool val)
 Write a bool value into the user global config.
 
void scim::scim_global_config_write (const String &key, double val)
 Write a double value into the user global config.
 
void scim::scim_global_config_write (const String &key, const std::vector< String > &val)
 Write a string list into the user global config.
 
void scim::scim_global_config_write (const String &key, const std::vector< int > &val)
 Write an int list into the user global config.
 
void scim::scim_global_config_reset (const String &key)
 Reset the value associated to the specified key to its default value.
 
bool scim::scim_global_config_flush ()
 Flush the updated global config into user global config file.
 

Detailed Description

functions to read the global configurations.

The global configuration file (normally /etc/scim/global) is used to store the configurations for libscim itself and the system wide configurations which will be read before any Config module is loaded.