scim 1.4.18
|
The class to manipulate the Filter modules. More...
#include <scim_filter_module.h>
Public Member Functions | |
FilterModule () | |
Default constructor. | |
FilterModule (const String &name, const ConfigPointer &config) | |
Constructor. | |
bool | load (const String &name, const ConfigPointer &config) |
Load a Filter Module by its name. | |
bool | unload () |
Unload the Filter Module. | |
bool | valid () const |
Check if a module is loaded and initialized successfully. | |
unsigned int | number_of_filters () const |
Get how many Filter factories supported by this module. | |
FilterFactoryPointer | create_filter (unsigned int index) const |
Create an object for a Filter factory. | |
bool | get_filter_info (unsigned int index, FilterInfo &info) const |
Get basic information of the FilterFactory class provided by this module. | |
The class to manipulate the Filter modules.
This is a wrapper of scim::Module class, which is specially for manipulating the Filter modules.
scim::FilterModule::FilterModule | ( | ) |
Default constructor.
scim::FilterModule::FilterModule | ( | const String & | name, |
const ConfigPointer & | config ) |
Constructor.
name | the module's name, eg. "sctc". |
config | a ConfigBase instance to maintain the configuration. |
bool scim::FilterModule::load | ( | const String & | name, |
const ConfigPointer & | config ) |
Load a Filter 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 Filter Module. |
config | a ConfigBase instance to maintain the configuration. |
bool scim::FilterModule::valid | ( | ) | const |
Check if a module is loaded and initialized successfully.
Get how many Filter factories supported by this module.
FilterFactoryPointer scim::FilterModule::create_filter | ( | unsigned int | index | ) | const |
Create an object for a Filter factory.
index | The index of the Filter factory, must be less than the result of number_of_factories method and greater than or equal to zero. |
bool scim::FilterModule::get_filter_info | ( | unsigned int | index, |
FilterInfo & | info ) const |
Get basic information of the FilterFactory class provided by this module.
index | The index of the Filter factory to be queried. |
info | The result will be stored in this parameter. |