#include <scim_filter_manager.h>
Public Member Functions | |
FilterManager (const ConfigPointer &config) | |
~FilterManager () | |
unsigned int | number_of_filters () const |
Get the total number of Filters supported by all filter modules. | |
bool | get_filter_info (unsigned int idx, FilterInfo &info) const |
Get the information of a specific filter by its index. | |
bool | get_filter_info (const String &uuid, FilterInfo &info) const |
Get the information of a specific filter by its uuid. | |
void | clear_all_filter_settings () const |
Clear all Filter settings for IMEngines. | |
size_t | get_filters_for_imengine (const String &uuid, std::vector< String > &filters) const |
Get a list of Filters binded to an IMEngine. | |
void | set_filters_for_imengine (const String &uuid, const std::vector< String > &filters) const |
Bind one or more Filters to an IMEngine. | |
size_t | get_filtered_imengines (std::vector< String > &imengines) const |
Get a list of imengines which have one or more filters attached. | |
FilterFactoryPointer | create_filter (unsigned int idx) const |
Create a FilterFactory according to its index. | |
FilterFactoryPointer | create_filter (const String &uuid) const |
Create a FilterFactory according to its UUID. | |
IMEngineFactoryPointer | attach_filters_to_factory (const IMEngineFactoryPointer &factory) const |
Attach all binded Filters to an IMEngineFactory object. |
scim::FilterManager::FilterManager | ( | const ConfigPointer & | config | ) |
scim::FilterManager::~FilterManager | ( | ) |
unsigned int scim::FilterManager::number_of_filters | ( | ) | const |
Get the total number of Filters supported by all filter modules.
bool scim::FilterManager::get_filter_info | ( | unsigned int | idx, | |
FilterInfo & | info | |||
) | const |
Get the information of a specific filter by its index.
idx | The index of the filter, must between 0 to number_of_filters () - 1. | |
info | The FilterInfo object to store the information. |
bool scim::FilterManager::get_filter_info | ( | const String & | uuid, | |
FilterInfo & | info | |||
) | const |
Get the information of a specific filter by its uuid.
uuid | The uuid of the filter. | |
info | The FilterInfo object to store the information. |
void scim::FilterManager::clear_all_filter_settings | ( | ) | const |
Clear all Filter settings for IMEngines.
size_t scim::FilterManager::get_filters_for_imengine | ( | const String & | uuid, | |
std::vector< String > & | filters | |||
) | const |
Get a list of Filters binded to an IMEngine.
uuid | The uuid of the IMEngine to be queried. | |
filters | The list of Filters' UUIDs binded to the IMEngine will be stored here. |
void scim::FilterManager::set_filters_for_imengine | ( | const String & | uuid, | |
const std::vector< String > & | filters | |||
) | const |
Bind one or more Filters to an IMEngine.
uuid | The uuid of the IMEngine to be binded. | |
filters | The list of Filters' UUIDs to be binded to the IMEngine. |
size_t scim::FilterManager::get_filtered_imengines | ( | std::vector< String > & | imengines | ) | const |
Get a list of imengines which have one or more filters attached.
imengines | The UUIDs of filtered imengines will be stored here. |
FilterFactoryPointer scim::FilterManager::create_filter | ( | unsigned int | idx | ) | const |
Create a FilterFactory according to its index.
idx | The index of the filter to be created, must be less than number_of_filters() - 1. |
FilterFactoryPointer scim::FilterManager::create_filter | ( | const String & | uuid | ) | const |
Create a FilterFactory according to its UUID.
uuid | The UUID of the filter to be created. |
IMEngineFactoryPointer scim::FilterManager::attach_filters_to_factory | ( | const IMEngineFactoryPointer & | factory | ) | const |
Attach all binded Filters to an IMEngineFactory object.
factory | The pointer to an IMEngineFactory object which would be filtered. |