IMEngine

Classes
class	scim::ComposeKeyFactory
	A simple IMEngine to deal with the Compose keys. More...
class	scim::ComposeKeyInstance
class	scim::IMEngineError
	An exception class to hold IMEngine related errors. More...
class	scim::IMEngineFactoryBase
	The base class of the real input methods' IMEngineFactory classes. More...
class	scim::IMEngineInstanceBase
	The base class of the real input methods' IMEngineInstance classes. More...
class	scim::DummyIMEngineFactory
	A trivial IMEngine that do nothing. More...
class	scim::DummyIMEngineInstance
class	scim::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 String & >	scim::IMEngineSlotString
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 String &, const Transaction & >	scim::IMEngineSlotStringTransaction
typedef Slot3< void, IMEngineInstanceBase *, const WideString &, const AttributeList & >	scim::IMEngineSlotWideStringAttributeList
typedef Slot5< bool, IMEngineInstanceBase *, WideString &, int &, int, int >	scim::IMEngineSlotGetSurroundingText
typedef Slot3< bool, IMEngineInstanceBase *, int, int >	scim::IMEngineSlotDeleteSurroundingText
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 > &mod_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.

typedef Pointer< IMEngineInstanceBase > scim::IMEngineInstancePointer

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

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 String&> scim::IMEngineSlotString

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 String&,const Transaction&> scim::IMEngineSlotStringTransaction

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

typedef Slot5<bool, IMEngineInstanceBase*,WideString&,int&,int,int> scim::IMEngineSlotGetSurroundingText

typedef Slot3<bool, IMEngineInstanceBase*,int,int> scim::IMEngineSlotDeleteSurroundingText

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.

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.

---

Function Documentation

int scim_get_imengine_module_list (  std::vector< String > &  mod_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 ().

---