Server

Classes
class	ServerError
	An exception class to hold Server related errors. More...
class	ServerFactoryBase
	The base class of the real input methods' ServerFactory classes. More...
class	ServerInstanceBase
	The base class of the real input methods' ServerInstance classes. More...
class	DummyServerFactory
class	DummyServerInstance
class	ServerModule
	The class to manipulate the server modules. More...
Typedefs
typedef Pointer< ServerFactoryBase >	scim::ServerFactoryPointer
typedef Pointer< ServerInstanceBase >	scim::ServerInstancePointer
typedef Slot1< void, ServerInstanceBase * >	scim::ServerSlotVoid
typedef Slot2< void, ServerInstanceBase *, int >	scim::ServerSlotInt
typedef Slot2< void, ServerInstanceBase *, bool >	scim::ServerSlotBool
typedef Slot2< void, ServerInstanceBase *, const WideString & >	scim::ServerSlotWideString
typedef Slot2< void, ServerInstanceBase *, const KeyEvent & >	scim::ServerSlotKeyEvent
typedef Slot2< void, ServerInstanceBase *, const LookupTable & >	scim::ServerSlotLookupTable
typedef Slot3< void, ServerInstanceBase *, const WideString &, const AttributeList & >	scim::ServerSlotWideStringAttributeList
typedef Signal1< void, ServerInstanceBase * >	scim::ServerSignalVoid
typedef Signal2< void, ServerInstanceBase *, int >	scim::ServerSignalInt
typedef Signal2< void, ServerInstanceBase *, bool >	scim::ServerSignalBool
typedef Signal2< void, ServerInstanceBase *, const WideString & >	scim::ServerSignalWideString
typedef Signal2< void, ServerInstanceBase *, const KeyEvent & >	scim::ServerSignalKeyEvent
typedef Signal2< void, ServerInstanceBase *, const LookupTable & >	scim::ServerSignalLookupTable
typedef Signal3< void, ServerInstanceBase *, const WideString &, const AttributeList & >	scim::ServerSignalWideStringAttributeList
typedef unsigned int(*	scim::ServerModuleInitFunc )(const ConfigPointer &config)
	Initialize a Server Module.
typedef ServerFactoryPointer(*	scim::ServerModuleCreateFactoryFunc )(unsigned int server)
	Create a factory instance for a server,.
Functions
int	scim::scim_get_server_module_list (std::vector< String > &mod_list)
	Get a name list of currently available server modules.

---

Detailed Description

The base classes for input method server modules.

---

Typedef Documentation

typedef Pointer< ServerFactoryBase > scim::ServerFactoryPointer

A smart pointer for scim::ServerFactoryBase and its derived classes. Definition at line 68 of file scim_server.h.

typedef Pointer< ServerInstanceBase > scim::ServerInstancePointer

A smart pointer for scim::ServerInstanceBase and its derived classes. Definition at line 75 of file scim_server.h.

typedef Slot1<void, ServerInstanceBase*> scim::ServerSlotVoid

Definition at line 78 of file scim_server.h.

typedef Slot2<void, ServerInstanceBase*,int> scim::ServerSlotInt

Definition at line 81 of file scim_server.h.

typedef Slot2<void, ServerInstanceBase*,bool> scim::ServerSlotBool

Definition at line 84 of file scim_server.h.

typedef Slot2<void, ServerInstanceBase*,const WideString&> scim::ServerSlotWideString

Definition at line 87 of file scim_server.h.

typedef Slot2<void, ServerInstanceBase*,const KeyEvent&> scim::ServerSlotKeyEvent

Definition at line 90 of file scim_server.h.

typedef Slot2<void, ServerInstanceBase*,const LookupTable&> scim::ServerSlotLookupTable

Definition at line 93 of file scim_server.h.

typedef Slot3<void, ServerInstanceBase*,const WideString&,const AttributeList&> scim::ServerSlotWideStringAttributeList

Definition at line 96 of file scim_server.h.

typedef Signal1<void, ServerInstanceBase*> scim::ServerSignalVoid

Definition at line 100 of file scim_server.h.

typedef Signal2<void, ServerInstanceBase*,int> scim::ServerSignalInt

Definition at line 103 of file scim_server.h.

typedef Signal2<void, ServerInstanceBase*,bool> scim::ServerSignalBool

Definition at line 106 of file scim_server.h.

typedef Signal2<void, ServerInstanceBase*,const WideString&> scim::ServerSignalWideString

Definition at line 109 of file scim_server.h.

typedef Signal2<void, ServerInstanceBase*,const KeyEvent&> scim::ServerSignalKeyEvent

Definition at line 112 of file scim_server.h.

typedef Signal2<void, ServerInstanceBase*,const LookupTable&> scim::ServerSignalLookupTable

Definition at line 115 of file scim_server.h.

typedef Signal3<void, ServerInstanceBase*,const WideString&,const AttributeList&> scim::ServerSignalWideStringAttributeList

Definition at line 118 of file scim_server.h.

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

Initialize a Server Module. There must be a function called "scim_server_module_init" in each server 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 Server Module. Definition at line 51 of file scim_server_module.h.

typedef ServerFactoryPointer(* scim::ServerModuleCreateFactoryFunc)(unsigned int server)

Create a factory instance for a server,. There must be a function called "scim_server_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: server  - the number of the server for which a factory instance will be created. Returns: the pointer of the factory instance. Definition at line 64 of file scim_server_module.h.

---

Function Documentation

int scim_get_server_module_list (  std::vector< String > &  mod_list  )

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

---