IMEngine

Classes
class	ComposeKeyFactory
	A simple IMEngine to deal with the Compose keys. More...
class	ComposeKeyInstance
class	IMEngineError
	An exception class to hold IMEngine related errors. More...
class	IMEngineFactoryBase
	The base class of the real input methods' IMEngineFactory classes. More...
class	IMEngineInstanceBase
	The base class of the real input methods' IMEngineInstance classes. More...
class	DummyIMEngineFactory
	A trivial IMEngine that do nothing. More...
class	DummyIMEngineInstance
class	IMEngineModule
	The class to manipulate the IMEngine modules. More...
Typedefs
typedef Pointer< IMEngineFactoryBase >	scim::IMEngineFactoryPointer
typedef Pointer< IMEngineInstanceBase >	scim::IMEngineInstancePointer
typedef Slot1< void, IMEngineInstanceBase * >	scim::IMEngineSlotVoid
typedef Slot2< void, IMEngineInstanceBase *, int >	scim::IMEngineSlotInt
typedef Slot2< void, IMEngineInstanceBase *, bool >	scim::IMEngineSlotBool
typedef Slot2< void, IMEngineInstanceBase *, const WideString & >	scim::IMEngineSlotWideString
typedef Slot2< void, IMEngineInstanceBase *, const KeyEvent & >	scim::IMEngineSlotKeyEvent
typedef Slot2< void, IMEngineInstanceBase *, const LookupTable & >	scim::IMEngineSlotLookupTable
typedef Slot2< void, IMEngineInstanceBase *, const Property & >	scim::IMEngineSlotProperty
typedef Slot2< void, IMEngineInstanceBase *, const PropertyList & >	scim::IMEngineSlotPropertyList
typedef Slot3< void, IMEngineInstanceBase *, const WideString &, const AttributeList & >	scim::IMEngineSlotWideStringAttributeList
typedef unsigned int(*	scim::IMEngineModuleInitFunc )(const ConfigPointer &config)
	Initialize a IMEngine Module.
typedef IMEngineFactoryPointer(*	scim::IMEngineModuleCreateFactoryFunc )(unsigned int engine)
	Create a factory instance for an engine,.
Functions
int	scim::scim_get_imengine_module_list (std::vector< String > &engine_list)
	Get a name list of currently available IMEngine modules.

---

Detailed Description

The base classes for input method engine modules.

---

Typedef Documentation

typedef Pointer< IMEngineFactoryBase > scim::IMEngineFactoryPointer

A smart pointer for scim::IMEngineFactoryBase and its derived classes. Definition at line 69 of file scim_imengine.h.

typedef Pointer< IMEngineInstanceBase > scim::IMEngineInstancePointer

A smart pointer for scim::IMEngineInstanceBase and its derived classes. Definition at line 76 of file scim_imengine.h.

typedef Slot1<void, IMEngineInstanceBase*> scim::IMEngineSlotVoid

Definition at line 79 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,int> scim::IMEngineSlotInt

Definition at line 82 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,bool> scim::IMEngineSlotBool

Definition at line 85 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,const WideString&> scim::IMEngineSlotWideString

Definition at line 88 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,const KeyEvent&> scim::IMEngineSlotKeyEvent

Definition at line 91 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,const LookupTable&> scim::IMEngineSlotLookupTable

Definition at line 94 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,const Property&> scim::IMEngineSlotProperty

Definition at line 97 of file scim_imengine.h.

typedef Slot2<void, IMEngineInstanceBase*,const PropertyList&> scim::IMEngineSlotPropertyList

Definition at line 100 of file scim_imengine.h.

typedef Slot3<void, IMEngineInstanceBase*,const WideString&,const AttributeList&> scim::IMEngineSlotWideStringAttributeList

Definition at line 103 of file scim_imengine.h.

typedef unsigned int(* scim::IMEngineModuleInitFunc)(const ConfigPointer &config)

Initialize a IMEngine Module. There must be a function called "scim_imengine_module_init" in each imengine module which complies with this prototype. This function name can have a prefix like table_LTX_, in which "table" is the module's name. Parameters: config  - a ConfigBase instance to maintain the configuration. Returns: the number of factories supported by this IMEngine Module. Definition at line 51 of file scim_imengine_module.h.

typedef IMEngineFactoryPointer(* scim::IMEngineModuleCreateFactoryFunc)(unsigned int engine)

Create a factory instance for an engine,. There must be a function called "scim_imengine_module_create_factory" which complies with this prototype. This function name can have a prefix like table_LTX_, in which "table" is the module's name. Parameters: engine  - the index of the engine for which a factory object will be created. Returns: the pointer of the factory object. Definition at line 64 of file scim_imengine_module.h.

---

Function Documentation

int scim_get_imengine_module_list (  std::vector< String > &  engine_list  )

Get a name list of currently available IMEngine modules. Parameters: mod_list  - the result list will be stored here. Returns: the number of the modules, equal to mod_list.size ().

---