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

Config


Classes

class  scim::ConfigError
 An exception class to hold Config related errors. More...
class  scim::ConfigBase
 The interface class to access the configuration data. More...
class  scim::DummyConfig
 A dummy implementation of interface class scim::ConfigBase. More...
class  scim::ConfigModule
 The class to manipulate the config modules. More...

Defines

#define SCIM_CONFIG_UPDATE_TIMESTAMP   "/UpdateTimeStamp"
#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_FACTORY   "/FrontEnd/Keys/NextFactory"
#define SCIM_CONFIG_FRONTEND_KEYS_PREVIOUS_FACTORY   "/FrontEnd/Keys/PreviousFactory"
#define SCIM_CONFIG_FRONTEND_KEYS_SHOW_FACTORY_MENU   "/FrontEnd/Keys/ShowFactoryMenu"
#define SCIM_CONFIG_FRONTEND_KEYS_VALID_KEY_MASK   "/FrontEnd/Keys/ValidKeyMask"
#define SCIM_GLOBAL_CONFIG_DEFAULT_IMENGINE_FACTORY   "/DefaultIMEngineFactory"
#define SCIM_GLOBAL_CONFIG_DISABLED_IMENGINE_FACTORIES   "/DisabledIMEngineFactories"
#define SCIM_GLOBAL_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"
#define SCIM_GLOBAL_CONFIG_DEFAULT_PANEL_PROGRAM   "/DefaultPanelProgram"
#define SCIM_GLOBAL_CONFIG_DEFAULT_CONFIG_MODULE   "/DefaultConfigModule"
#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_FRONTEND_ADDRESS   "/DefaultSocketFrontEndAddress"
#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_IMENGINE_ADDRESS   "/DefaultSocketIMEngineAddress"
#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_CONFIG_ADDRESS   "/DefaultSocketConfigAddress"
#define SCIM_GLOBAL_CONFIG_DEFAULT_PANEL_SOCKET_ADDRESS   "/DefaultPanelSocketAddress"
#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_TIMEOUT   "/DefaultSocketTimeout"

Typedefs

typedef Pointer< ConfigBase > scim::ConfigPointer
typedef Slot1< void, const
ConfigPointer & > 
scim::ConfigSlotVoid
typedef Signal1< void, const
ConfigPointer & > 
scim::ConfigSignalVoid
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_UPDATE_TIMESTAMP   "/UpdateTimeStamp"
 

Definition at line 41 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND   "/FrontEnd"
 

Definition at line 42 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS   "/FrontEnd/Keys"
 

Definition at line 43 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_TRIGGER   "/FrontEnd/Keys/Trigger"
 

Definition at line 44 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_NEXT_FACTORY   "/FrontEnd/Keys/NextFactory"
 

Definition at line 45 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_PREVIOUS_FACTORY   "/FrontEnd/Keys/PreviousFactory"
 

Definition at line 46 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_SHOW_FACTORY_MENU   "/FrontEnd/Keys/ShowFactoryMenu"
 

Definition at line 47 of file scim_config_path.h.

#define SCIM_CONFIG_FRONTEND_KEYS_VALID_KEY_MASK   "/FrontEnd/Keys/ValidKeyMask"
 

Definition at line 48 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_IMENGINE_FACTORY   "/DefaultIMEngineFactory"
 

Definition at line 50 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DISABLED_IMENGINE_FACTORIES   "/DisabledIMEngineFactories"
 

Definition at line 51 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"
 

Definition at line 52 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_PANEL_PROGRAM   "/DefaultPanelProgram"
 

Definition at line 53 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_CONFIG_MODULE   "/DefaultConfigModule"
 

Definition at line 54 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_FRONTEND_ADDRESS   "/DefaultSocketFrontEndAddress"
 

Definition at line 55 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_IMENGINE_ADDRESS   "/DefaultSocketIMEngineAddress"
 

Definition at line 56 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_CONFIG_ADDRESS   "/DefaultSocketConfigAddress"
 

Definition at line 57 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_PANEL_SOCKET_ADDRESS   "/DefaultPanelSocketAddress"
 

Definition at line 58 of file scim_config_path.h.

#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_TIMEOUT   "/DefaultSocketTimeout"
 

Definition at line 59 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 Slot1< void, const ConfigPointer & > scim::ConfigSlotVoid
 

The slot type to connect to the coresponding signal. Definition at line 71 of file scim_config_base.h.

typedef Signal1< void, const ConfigPointer & > scim::ConfigSignalVoid
 

The signal type to connect with the ConfigSlotVoid slot type. Definition at line 78 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 Thu Dec 30 21:03:19 2004 for scim by doxygen 1.3.8