Class TFilterConfigurationIterator

class TFilterConfigurationIterator;

Description

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 First() method and the return error code checked before any other operations are called.

Members

Defined in TFilterConfigurationIterator:
AtEnd(), AtStart(), CurrentFilterInformation(), FindByDataType(), First(), InstallCurrentFilter(), Next(), UninstallCurrentFilter()

IMPORT_C TInt First();

Pre-Condition

Object is constructed

Description

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.

Post-Condition

Current filter is set to the first filter in the list

Return value

IMPORT_C TInt Next();

Pre-Condition

Object is constructed

Description

Intended Usage: This method sets the current filter to the next filter in the list.

Post-Condition

Current filter is set to the next filter in the list

Return value

IMPORT_C TBool AtStart();

Pre-Condition

The iterator has been initialised using the First() method

Description

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 First() method.

Return value

IMPORT_C TBool AtEnd();

Pre-Condition

The iterator has been initialised using the First() method

Description

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 First() method.

Return value

IMPORT_C TInt FindByDataType(const TDesC8 &aDataType);

Pre-Condition

Object is constructed

Description

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.

Post-Condition

The current filter is set to the filter that matches the data type

Parameters

Return value

IMPORT_C const TFilterInformation CurrentFilterInformation() const;

Pre-Condition

The iterator has been initialised using the First() method

Description

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 First() method

Return value

See also:

• TFilterInformation

IMPORT_C TInt InstallCurrentFilter() const;

Pre-Condition

A current filter has been set and is not already installed

Description

Intended Usage: This method will install the current filter. This method will panic if a current filter is not set.

Post-Condition

The filter is installed

Return value

IMPORT_C TInt UninstallCurrentFilter() const;

Pre-Condition

A current filter has been set and has already been installed

Description

Intended Usage: This method will uninstall the current filter. This method will panic if a current filter is not set.

Post-Condition

The filter is uninstalled

Return value