scim
1.4.18
|
The class to manipulate the IMEngine modules. More...
#include <scim_imengine_module.h>
Public Member Functions | |
IMEngineModule () | |
Default constructor. More... | |
IMEngineModule (const String &name, const ConfigPointer &config) | |
Constructor. More... | |
bool | load (const String &name, const ConfigPointer &config) |
Load a IMEngine Module by its name. More... | |
bool | unload () |
Unload the IMEngine Module. More... | |
bool | valid () const |
Check if a module is loaded and initialized successfully. More... | |
unsigned int | number_of_factories () const |
Get how many IMEngine factories supported by this module. More... | |
IMEngineFactoryPointer | create_factory (unsigned int engine) const |
Create an object for an IMEngine factory. More... | |
The class to manipulate the IMEngine modules.
This is a wrapper of scim::Module class, which is specially for manipulating the IMEngine modules.
scim::IMEngineModule::IMEngineModule | ( | ) |
Default constructor.
scim::IMEngineModule::IMEngineModule | ( | const String & | name, |
const ConfigPointer & | config | ||
) |
Constructor.
name | - the module's name, eg. "rawcode". |
config | - a smart pointer points to a ConfigBase instance. |
bool scim::IMEngineModule::load | ( | const String & | name, |
const ConfigPointer & | config | ||
) |
Load a IMEngine Module by its name.
Load a module into memory. If another module has been loaded into this object, then the old module will be unloaded first. If the old module is resident, false will be returned, and the old module will be untouched.
name | - the name of the IMEngine Module. |
config | - the ConfigBase instance to be used for storing/loading configs. |
bool scim::IMEngineModule::unload | ( | ) |
Unload the IMEngine Module.
bool scim::IMEngineModule::valid | ( | ) | const |
Check if a module is loaded and initialized successfully.
unsigned int scim::IMEngineModule::number_of_factories | ( | ) | const |
Get how many IMEngine factories supported by this module.
IMEngineFactoryPointer scim::IMEngineModule::create_factory | ( | unsigned int | engine | ) | const |
Create an object for an IMEngine factory.
engine | - the index of this IMEngine factory, must be less than the result of number_of_factories method and greater than or equal to zero. |