Collapse all Symbian^3 Application Developer Library

TFilterInformation Struct Reference

struct TFilterInformation

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. TFilterConfigurationIterator

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

Public Member Enumerations
enum	TFilterCategory { EImplicitFilter , EExplicitFilter }

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

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

Parameters

const TDesC & aDisplayName	Reference to descriptor containing the display name
const TDesC8 & aDataType	Reference to descriptor containing the data type
TInt aVersion	Integer of the version number
TUid aFilterUid	The UID of the filter plugin
TFilterCategory aFilterCategory	The category of the filter
TBool aInstallStatus	The install status of the filter plugin. Contains ETrue if installed or EFalse otherwise.

Member Enumerations Documentation

Enum TFilterCategory

Public enum defining the filter categories available to the client.

Enumerators

EImplicitFilter
EExplicitFilter

Member Data Documentation

const TDesC8 & iDataType

const TDesC8 &

iDataType

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

const TDesC & iDisplayName

const TDesC &

iDisplayName

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

TFilterCategory iFilterCategory

TFilterCategory

iFilterCategory

The filter's category

TUid iFilterUid

TUid	iFilterUid

The filter's plugin UID

TBool iInstallStatus

TBool

iInstallStatus

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

TInt iVersion

TInt

iVersion

The filter's version number