|
|
|
class TFilterConfigurationIterator;
This class can only be created and destroyed by the session. It is supplied to the client, if the client wishes to configure
the filter that are installed or install filters that must be installed explicitly. The API of the class allows the client
to navigate, install, uninstall and query the filter list. The filters visible in this list are only the implicit and explicit
filters declared as plugins. This iterator MUST be initialised using the TFilterConfigurationIterator::First() method and the return error code checked before any other operations are called.
Defined in TFilterConfigurationIterator:
AtEnd()Intended Usage: This method indicates whether the current filter is the last fil...AtStart()Intended Usage: This method indicates whether the current filter is the first fi...CurrentFilterInformation()constIntended Usage: This method will return the information of the current filter. T...FindByDataType(const TDesC8 &)Intended Usage: This method find the first filter in the list that has a matchin...First()Intended Usage: This method sets the current filter to the first filter in the l...InstallCurrentFilter()constIntended Usage: This method will install the current filter. This method will pa...Next()Intended Usage: This method sets the current filter to the next filter in the li...UninstallCurrentFilter()constIntended Usage: This method will uninstall the current filter. This method will ...IMPORT_C TInt First();
Object is constructed
Intended Usage: This method sets the current filter to the first filter in the list. This method must be used initially to set the current filter and the returned error code must be noted prior to using any of the methods that query or modify the current filter.
Current filter is set to the first filter in the list
|
IMPORT_C TInt Next();
Object is constructed
Intended Usage: This method sets the current filter to the next filter in the list.
Current filter is set to the next filter in the list
|
IMPORT_C TBool AtStart();
The iterator has been initialised using the TFilterConfigurationIterator::First() method
Intended Usage: This method indicates whether the current filter is the first filter in the list. This method will panic if
the iterator has not been initialised using the TFilterConfigurationIterator::First() method.
|
IMPORT_C TBool AtEnd();
The iterator has been initialised using the TFilterConfigurationIterator::First() method
Intended Usage: This method indicates whether the current filter is the last filter in the list. This method will panic if
the iterator has not been initialised using the TFilterConfigurationIterator::First() method.
|
IMPORT_C TInt FindByDataType(const TDesC8 &aDataType);
Object is constructed
Intended Usage: This method find the first filter in the list that has a matching data type that is passed in. The method will set the current filter to the filter that matches the data type or if not found the current filter will not change. This method will always begin its search from the beginning of the list.
The current filter is set to the filter that matches the data type
|
|
IMPORT_C const TFilterInformation CurrentFilterInformation() const;
The iterator has been initialised using the TFilterConfigurationIterator::First() method
Intended Usage: This method will return the information of the current filter. The information is provided in a TFilterInformation structure containing the following information: 1) Display name 2) Data type 3) Version 4) UID 5) Category 6) Install status
This method will panic if the iterator has not been initialised using the TFilterConfigurationIterator::First() method
|
TFilterInformationThis structure is used by the TFilterConfigurationIterator to hold the informati...IMPORT_C TInt InstallCurrentFilter() const;
A current filter has been set and is not already installed
Intended Usage: This method will install the current filter. This method will panic if a current filter is not set.
The filter is installed
|
IMPORT_C TInt UninstallCurrentFilter() const;
A current filter has been set and has already been installed
Intended Usage: This method will uninstall the current filter. This method will panic if a current filter is not set.
The filter is uninstalled
|