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

Config


Classes

class  ConfigError
 An exception class to hold Config related errors. More...

class  ConfigBase
 The interface class to access the configuration data. More...

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

class  ConfigModule
 The class to manipulate the config modules. More...


Defines

#define SCIM_CONFIG_FRONTEND   "/FrontEnd"
#define SCIM_CONFIG_FRONTEND_KEYS   "/FrontEnd/Keys"
#define SCIM_CONFIG_FRONTEND_KEYS_TRIGGER   "/FrontEnd/Keys/Trigger"
#define SCIM_CONFIG_FRONTEND_KEYS_NEXT_SERVER   "/FrontEnd/Keys/NextServer"
#define SCIM_CONFIG_FRONTEND_KEYS_PREVIOUS_SERVER   "/FrontEnd/Keys/PreviousServer"
#define SCIM_CONFIG_FRONTEND_KEYS_VALID_KEY_MASK   "/FrontEnd/Keys/ValidKeyMask"
#define SCIM_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"
#define SCIM_CONFIG_DEFAULT_SERVER_FACTORY   "/DefaultServerFactory"
#define SCIM_CONFIG_DISABLED_SERVER_FACTORIES   "/DisabledServerFactories"

Typedefs

typedef Pointer< ConfigBase > scim::ConfigPointer
typedef void(* scim::ConfigModuleInitFunc )(void)
 The prototype of initialization function in config modules.

typedef ConfigPointer(* scim::ConfigModuleCreateConfigFunc )(const String &app_name)
 The prototype of configure object creation function in config modules.


Functions

int scim::scim_get_config_module_list (std::vector< String > &mod_list)
 Get a name list of currently available configuration modules.


Detailed Description

The base classes for config modules

Define Documentation

#define SCIM_CONFIG_FRONTEND   "/FrontEnd"
 

Definition at line 40 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS   "/FrontEnd/Keys"
 

Definition at line 41 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_TRIGGER   "/FrontEnd/Keys/Trigger"
 

Definition at line 42 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_NEXT_SERVER   "/FrontEnd/Keys/NextServer"
 

Definition at line 43 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_PREVIOUS_SERVER   "/FrontEnd/Keys/PreviousServer"
 

Definition at line 44 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_VALID_KEY_MASK   "/FrontEnd/Keys/ValidKeyMask"
 

Definition at line 45 of file scim_config_path.h.

#define SCIM_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"
 

Definition at line 47 of file scim_config_path.h.

#define SCIM_CONFIG_DEFAULT_SERVER_FACTORY   "/DefaultServerFactory"
 

Definition at line 49 of file scim_config_path.h.

#define SCIM_CONFIG_DISABLED_SERVER_FACTORIES   "/DisabledServerFactories"
 

Definition at line 51 of file scim_config_path.h.


Typedef Documentation

typedef Pointer< ConfigBase > scim::ConfigPointer
 

A smart pointer for scim::ConfigBase and its derived classes.

Definition at line 64 of file scim_config_base.h.

typedef void(* scim::ConfigModuleInitFunc)(void)
 

The prototype of initialization function in config modules.

There must be a function called "scim_config_module_init" which complies with this prototype. This function name can have a prefix like simple_LTX_, in which "simple" is the module's name.

Definition at line 51 of file scim_config_module.h.

typedef ConfigPointer(* scim::ConfigModuleCreateConfigFunc)(const String & app_name)
 

The prototype of configure object creation function in config modules.

There must be a function called "scim_config_module_create_config" which complies with this prototype. This function name can have a prefix like simple_LTX_, in which "simple" is the module's name.

Definition at line 61 of file scim_config_module.h.


Function Documentation

int scim_get_config_module_list std::vector< String > &  mod_list  ) 
 

Get a name list of currently available configuration modules.

Parameters:
mod_list - the result list will be stored here.
Returns:
the number of the modules, equal to mod_list.size ().


Generated on Fri May 7 17:27:26 2004 for scim by doxygen 1.3.6