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_DEFAULT_IMENGINE_FACTORY   "/DefaultIMEngineFactory"
#define SCIM_CONFIG_FRONTEND_ON_THE_SPOT   "/FrontEnd/OnTheSpot"
#define SCIM_CONFIG_FRONTEND_SHARED_INPUT_METHOD   "/FrontEnd/SharedInputMethod"
#define SCIM_CONFIG_FRONTEND_IM_OPENED_BY_DEFAULT   "/FrontEnd/IMOpenedByDefault"
#define SCIM_CONFIG_HOTKEYS_FRONTEND   "/Hotkeys/FrontEnd"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_TRIGGER   "/Hotkeys/FrontEnd/Trigger"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_ON   "/Hotkeys/FrontEnd/On"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_OFF   "/Hotkeys/FrontEnd/Off"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_NEXT_FACTORY   "/Hotkeys/FrontEnd/NextFactory"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_PREVIOUS_FACTORY   "/Hotkeys/FrontEnd/PreviousFactory"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_SHOW_FACTORY_MENU   "/Hotkeys/FrontEnd/ShowFactoryMenu"
#define SCIM_CONFIG_HOTKEYS_FRONTEND_VALID_KEY_MASK   "/Hotkeys/FrontEnd/ValidKeyMask"
#define SCIM_CONFIG_HOTKEYS_IMENGINE   "/Hotkeys/IMEngine"
#define SCIM_CONFIG_HOTKEYS_IMENGINE_LIST   "/Hotkeys/IMEngine/List"
#define SCIM_CONFIG_FILTER_FILTERED_IMENGINES   "/Filter/FilteredIMEngines"
#define SCIM_CONFIG_FILTER_FILTERED_IMENGINES_LIST   "/Filter/FilteredIMEngines/List"
#define SCIM_GLOBAL_CONFIG_DISABLED_IMENGINE_FACTORIES   "/DisabledIMEngineFactories"
#define SCIM_GLOBAL_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"
#define SCIM_GLOBAL_CONFIG_DEFAULT_KEYBOARD_LAYOUT   "/DefaultKeyboardLayout"
#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_HELPER_MANAGER_SOCKET_ADDRESS   "/DefaultHelperManagerSocketAddress"
#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 ()
 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"

#define SCIM_CONFIG_DEFAULT_IMENGINE_FACTORY   "/DefaultIMEngineFactory"

#define SCIM_CONFIG_FRONTEND_ON_THE_SPOT   "/FrontEnd/OnTheSpot"

#define SCIM_CONFIG_FRONTEND_SHARED_INPUT_METHOD   "/FrontEnd/SharedInputMethod"

#define SCIM_CONFIG_FRONTEND_IM_OPENED_BY_DEFAULT   "/FrontEnd/IMOpenedByDefault"

#define SCIM_CONFIG_HOTKEYS_FRONTEND   "/Hotkeys/FrontEnd"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_TRIGGER   "/Hotkeys/FrontEnd/Trigger"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_ON   "/Hotkeys/FrontEnd/On"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_OFF   "/Hotkeys/FrontEnd/Off"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_NEXT_FACTORY   "/Hotkeys/FrontEnd/NextFactory"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_PREVIOUS_FACTORY   "/Hotkeys/FrontEnd/PreviousFactory"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_SHOW_FACTORY_MENU   "/Hotkeys/FrontEnd/ShowFactoryMenu"

#define SCIM_CONFIG_HOTKEYS_FRONTEND_VALID_KEY_MASK   "/Hotkeys/FrontEnd/ValidKeyMask"

#define SCIM_CONFIG_HOTKEYS_IMENGINE   "/Hotkeys/IMEngine"

#define SCIM_CONFIG_HOTKEYS_IMENGINE_LIST   "/Hotkeys/IMEngine/List"

#define SCIM_CONFIG_FILTER_FILTERED_IMENGINES   "/Filter/FilteredIMEngines"

#define SCIM_CONFIG_FILTER_FILTERED_IMENGINES_LIST   "/Filter/FilteredIMEngines/List"

#define SCIM_GLOBAL_CONFIG_DISABLED_IMENGINE_FACTORIES   "/DisabledIMEngineFactories"

#define SCIM_GLOBAL_CONFIG_SUPPORTED_UNICODE_LOCALES   "/SupportedUnicodeLocales"

#define SCIM_GLOBAL_CONFIG_DEFAULT_KEYBOARD_LAYOUT   "/DefaultKeyboardLayout"

#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_HELPER_MANAGER_SOCKET_ADDRESS   "/DefaultHelperManagerSocketAddress"

#define SCIM_GLOBAL_CONFIG_DEFAULT_SOCKET_TIMEOUT   "/DefaultSocketTimeout"


Typedef Documentation

typedef Pointer< ConfigBase > scim::ConfigPointer

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

typedef Slot1< void, const ConfigPointer & > scim::ConfigSlotVoid

The slot type to connect to the coresponding signal.

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

The signal type to connect with the ConfigSlotVoid slot type.

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.

typedef ConfigPointer(*) scim::ConfigModuleCreateConfigFunc()

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.


Function Documentation

int scim::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 Sat Jun 21 21:12:57 2008 for scim by  doxygen 1.4.7