Collapse all Symbian^3 Product Developer Library

CLbtTriggerFilterComposite Class Reference

class CLbtTriggerFilterComposite : public CLbtTriggerFilterBase

Class representing a composite filter. This class is used to combine multiple filters.

All filters combined in this class will be applied when listing triggers. Currently only ECompositionTypeAnd is supported to be the composition type. In this case, only those triggers that fulfill the criteria specified by all the filters will be retrieved.

lbt.lib

Since: S60 5.1

Inherits from

CLbtTriggerFilterComposite
- CLbtTriggerFilterBase
  - CBase

Public Member Functions
	~CLbtTriggerFilterComposite()
IMPORT_C void	AddFilterL(CLbtTriggerFilterBase *)
IMPORT_C CLbtTriggerFilterBase *	GetFilter(TInt)
IMPORT_C CLbtTriggerFilterComposite *	NewL(TCompositeType)
IMPORT_C CLbtTriggerFilterComposite *	NewLC(TCompositeType)
IMPORT_C TInt	NumberOfFilters()
IMPORT_C void	RemoveFilter(TInt)
IMPORT_C void	Reset()
IMPORT_C TFilterType	Type()

Protected Member Functions
void	DoExternalizeL(RWriteStream &)
void	DoInternalizeL(RReadStream &)

Private Member Functions
	CLbtTriggerFilterComposite()
	CLbtTriggerFilterComposite(const CLbtTriggerFilterComposite &)
void	ConstructL()
CLbtTriggerFilterComposite &	operator=(const CLbtTriggerFilterComposite &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CLbtTriggerFilterBase::CLbtTriggerFilterBase()
	CLbtTriggerFilterBase::ExternalizeL(RWriteStream &)const
	CLbtTriggerFilterBase::InternalizeL(RReadStream &)
	CLbtTriggerFilterBase::~CLbtTriggerFilterBase()

Public Member Enumerations
enum	TCompositeType { ECompositionTypeAnd }

Inherited Enumerations
	CLbtTriggerFilterBase:TFilterType

Private Attributes
RPointerArray< CLbtTriggerFilterBase >	iFilters

Constructor & Destructor Documentation

CLbtTriggerFilterComposite()

CLbtTriggerFilterComposite

(

)

[private]

Constructor.

CLbtTriggerFilterComposite(const CLbtTriggerFilterComposite &)

CLbtTriggerFilterComposite

(

const CLbtTriggerFilterComposite &

)

[private]

By default, prohibit copy constructor

Parameters

const CLbtTriggerFilterComposite &

~CLbtTriggerFilterComposite()

IMPORT_C

~CLbtTriggerFilterComposite

(

)

[virtual]

Destructor.

Member Functions Documentation

AddFilterL(CLbtTriggerFilterBase *)

IMPORT_C void

AddFilterL

(

CLbtTriggerFilterBase *

aFilter

)

Adds a filter.

Parameters

CLbtTriggerFilterBase * aFilter

Pointer to the filter to be added. If the pointer is NULL, this function does nothing. Ownership of aFilter is transferred to this object.

ConstructL()

void

ConstructL

(

)

[private]

Symbian 2nd phase constructor

DoExternalizeL(RWriteStream &)

void

DoExternalizeL

(

RWriteStream &

aStream

)

const [protected, virtual]

Externalize method that subclass must implement.

Parameters

RWriteStream & aStream

Stream to which the object should be externalized.

DoInternalizeL(RReadStream &)

void

DoInternalizeL

(

RReadStream &

aStream

)

[protected, virtual]

Internalize method that subclass must implement.

Parameters

RReadStream & aStream

Stream from which the object should be internalized.

GetFilter(TInt)

IMPORT_C CLbtTriggerFilterBase *

GetFilter

(

TInt

aIndex

)

Gets pointer to the filter at the specific position.

panic: USER 130 if aIndex is negative, or greater than the total number of filters contained in this object.

Parameters

TInt aIndex

The position of the filter. The value shall be in the range of 0 to NumberOfFilters()- 1.

NewL(TCompositeType)

IMPORT_C CLbtTriggerFilterComposite *

NewL

(

TCompositeType

aType = ECompositionTypeAnd

)

[static]

Consructs a new instance of CLbtTriggerFilterComposite.

Parameters

TCompositeType aType = ECompositionTypeAnd

NewLC(TCompositeType)

IMPORT_C CLbtTriggerFilterComposite *

NewLC

(

TCompositeType

aType = ECompositionTypeAnd

)

[static]

Consructs a new instance of CLbtTriggerFilterComposite and pushes it onto cleanup stack.

Parameters

TCompositeType aType = ECompositionTypeAnd

NumberOfFilters()

IMPORT_C TInt

NumberOfFilters

(

)

const

Gets the number of filters contained in this object.

RemoveFilter(TInt)

IMPORT_C void

RemoveFilter

(

TInt

aIndex

)

Remove the specific trigger filter from this object

panic: USER 130 if aIndex is negative, or greater than the total number of filters contained in this object.

Parameters

TInt aIndex

The position of the filter to be removed.

Reset()

IMPORT_C void

Reset

(

)

Remove all trigger filters contained in this object.

Type()

IMPORT_C TFilterType

Type

(

)

const [virtual]

Returns CLbtTriggerFilterBase::EFilterComposite.

operator=(const CLbtTriggerFilterComposite &)

CLbtTriggerFilterComposite &

operator=

(

const CLbtTriggerFilterComposite &

)

[private]

Prohibit assigment operator

Parameters

const CLbtTriggerFilterComposite &

Member Enumerations Documentation

Enum TCompositeType

Enumerators

ECompositionTypeAnd

Criteria in all composited filters must be fulfiled.

Member Data Documentation

RPointerArray< CLbtTriggerFilterBase > iFilters

RPointerArray< CLbtTriggerFilterBase >

iFilters

[private]

Trigger filters