#include <scim_helper_module.h>
Collaboration diagram for scim::HelperModule:

Public Member Functions | |
| HelperModule (const String &name=String("")) | |
| Constructor. | |
| bool | load (const String &name) |
| Load a Helper module. | |
| bool | unload () |
| Unload the module. | |
| bool | valid () const |
| Check if a Helper module has been loaded successfully. | |
| unsigned int | number_of_helpers () const |
| Get the number of helpers supported by this module. | |
| bool | get_helper_info (unsigned int idx, HelperInfo &info) const |
| The the information of a specific helper. | |
| void | run_helper (const String &uuid, const ConfigPointer &config, const String &display) const |
| Run a specific helper. | |
This class should not be used directly. HelperManager should be used instead.
Constructor.
| name | The name of the Helper module to be loaded. |
| bool scim::HelperModule::load | ( | const String & | name | ) |
Load a Helper module.
If a module has already been loaded, then it'll be unloaded first.
| name | The name of the Helper module to be loaded. |
| bool scim::HelperModule::unload | ( | ) |
Unload the module.
| bool scim::HelperModule::valid | ( | ) | const |
Check if a Helper module has been loaded successfully.
| unsigned int scim::HelperModule::number_of_helpers | ( | ) | const |
Get the number of helpers supported by this module.
| bool scim::HelperModule::get_helper_info | ( | unsigned int | idx, | |
| HelperInfo & | info | |||
| ) | const |
The the information of a specific helper.
| idx | The index of the helper, must between 0 to number_of_helpers () - 1. | |
| info | The HeperInfo object to store the information. |
| void scim::HelperModule::run_helper | ( | const String & | uuid, | |
| const ConfigPointer & | config, | |||
| const String & | display | |||
| ) | const |
Run a specific helper.
The helper should be run in an independent process, this function will not return until the helper exits.
| config | The Config object to be used to read configurations. | |
| uuid | The UUID of the helper, which is returned by get_helper_info (). | |
| display | The display in which this helper should run. |
1.5.0