TFilterInformation Struct Reference

#include <mw/http/tfilterinformation.h>

struct TFilterInformation

Public Attributes
const TDesC8 &	iDataType
const TDesC &	iDisplayName
TFilterCategory	iFilterCategory
TUid	iFilterUid
TBool	iInstallStatus
TInt	iVersion

Public Member Enumerations
enum	TFilterCategory { EImplicitFilter, EExplicitFilter }

Public Member Functions
	TFilterInformation(const TDesC &, const TDesC8 &, TInt, TUid, TFilterCategory, TBool)

Detailed Description

This structure is used by the TFilterConfigurationIterator to hold the information of the current filter. This structure simply contains public members containing the following information, the display name, data type, version, UID, category and install status.

Member Attribute Documentation

iDataType

const TDesC8 &

iDataType

Contains a constant reference to the descriptor containing the filter's data type

iDisplayName

const TDesC &

iDisplayName

Contains a constant reference to the descriptor containing the filter's display name

iFilterCategory

TFilterCategory

iFilterCategory

The filter's category

iFilterUid

TUid	iFilterUid

The filter's plugin UID

iInstallStatus

TBool

iInstallStatus

The install status of the filter. Contains ETrue if installed, otherwise EFalse

iVersion

TInt

iVersion

The filter's version number

Member Enumeration Documentation

Enum TFilterCategory

Public enum defining the filter categories available to the client.

Enumerator	Value	Description
EImplicitFilter
EExplicitFilter

Constructor & Destructor Documentation

TFilterInformation ( const TDesC &, const TDesC8 &, TInt, TUid, TFilterCategory, TBool )

TFilterInformation	(	const TDesC &	aDisplayName,
		const TDesC8 &	aDataType,
		TInt	aVersion,
		TUid	aFilterUid,
		TFilterCategory	aFilterCategory,
		TBool	aInstallStatus
	)	[inline]

Default constructor that simply initialises the data members.

Pre-condition: None

Post-condition: Object is fully constructed and initialised

Parameter	Description
aDisplayName	Reference to descriptor containing the display name
aDataType	Reference to descriptor containing the data type
aVersion	Integer of the version number
aFilterUid	The UID of the filter plugin
aFilterCategory	The category of the filter
aInstallStatus	The install status of the filter plugin. Contains ETrue if installed or EFalse otherwise.