TFilterConfigurationIterator Class Reference
|
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
First()
method and the return error code checked before any other operations are called.
Constructor & Destructor Documentation
TFilterConfigurationIterator(CHTTPSession *)
|
TFilterConfigurationIterator
|
(
|
CHTTPSession
*
|
aSession
|
)
|
[private]
|
~TFilterConfigurationIterator()
|
~TFilterConfigurationIterator
|
(
|
)
|
[private]
|
Member Functions Documentation
AtEnd()
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.
-
Pre-condition
-
The iterator has been initialised using the
First()
method
AtStart()
|
IMPORT_C
TBool
|
AtStart
|
(
|
)
|
|
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.
-
Pre-condition
-
The iterator has been initialised using the
First()
method
CurrentFilterInformation()
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
-
Pre-condition
-
The iterator has been initialised using the
First()
method
TFilterInformation
FindByDataType(const TDesC8 &)
|
IMPORT_C
TInt
|
FindByDataType
|
(
|
const
TDesC8
&
|
aDataType
|
)
|
|
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.
-
Pre-condition
-
Object is constructed
-
Post-condition
-
The current filter is set to the filter that matches the data type
Parameters
|
const
TDesC8
& aDataType
|
An 8-bit descriptor containing the data type to match the filter plug-in with
|
First()
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.
-
Pre-condition
-
Object is constructed
-
Post-condition
-
Current filter is set to the first filter in the list
InstallCurrentFilter()
|
IMPORT_C
TInt
|
InstallCurrentFilter
|
(
|
)
|
const
|
Intended Usage: This method will install the current filter. This method will panic if a current filter is not set.
-
Pre-condition
-
A current filter has been set and is not already installed
-
Post-condition
-
The filter is installed
Next()
Intended Usage: This method sets the current filter to the next filter in the list.
-
Pre-condition
-
Object is constructed
-
Post-condition
-
Current filter is set to the next filter in the list
UninstallCurrentFilter()
|
IMPORT_C
TInt
|
UninstallCurrentFilter
|
(
|
)
|
const
|
Intended Usage: This method will uninstall the current filter. This method will panic if a current filter is not set.
-
Pre-condition
-
A current filter has been set and has already been installed
-
Post-condition
-
The filter is uninstalled
Member Data Documentation
TInt
iCurrentFilterIndex
|
TInt
|
iCurrentFilterIndex
|
[private]
|
TInt
iFilterCount
|
TInt
|
iFilterCount
|
[private]
|
RPointerArray< TSessionFilterInfo > & iFilterInfoList
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.