#include <scim_filter_manager.h>
List of all members.
Constructor & Destructor Documentation
scim::FilterManager::FilterManager |
( |
const ConfigPointer & |
config |
) |
|
scim::FilterManager::~FilterManager |
( |
|
) |
|
Member Function Documentation
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.
- Parameters:
-
| idx | The index of the filter, must between 0 to number_of_filters () - 1. |
| info | The FilterInfo object to store the information. |
- Returns:
- true if this filter is ok and the information is stored correctly.
bool scim::FilterManager::get_filter_info |
( |
const String & |
uuid, |
|
|
FilterInfo & |
info | |
|
) |
| | const |
Get the information of a specific filter by its uuid.
- Parameters:
-
| uuid | The uuid of the filter. |
| info | The FilterInfo object to store the information. |
- Returns:
- true if this filter is ok and the information is stored correctly.
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.
- Parameters:
-
| uuid | The uuid of the IMEngine to be queried. |
| filters | The list of Filters' UUIDs binded to the IMEngine will be stored here. |
- Returns:
- How many filters binded to this IMEngine.
void scim::FilterManager::set_filters_for_imengine |
( |
const String & |
uuid, |
|
|
const std::vector< String > & |
filters | |
|
) |
| | const |
Bind one or more Filters to an IMEngine.
- Parameters:
-
| 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.
- Parameters:
-
| imengines | The UUIDs of filtered imengines will be stored here. |
- Returns:
- How many imengines are being filtered.
Create a FilterFactory according to its index.
- Parameters:
-
- Returns:
- The pointer of the FilterFactory object.
Create a FilterFactory according to its UUID.
- Parameters:
-
| uuid | The UUID of the filter to be created. |
- Returns:
- The pointer of the FilterFactory object.
Attach all binded Filters to an IMEngineFactory object.
- Parameters:
-
| factory | The pointer to an IMEngineFactory object which would be filtered. |
- Returns:
- New pointer of IMEngineFactory object which has Filters binded.
The documentation for this class was generated from the following file: