CLbtTriggerFilterComposite Class Reference

#include <mw/lbttriggerfiltercomposite.h>

Link against: lbt.lib

class CLbtTriggerFilterComposite : public CLbtTriggerFilterBase

Inherits from

Detailed Description

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.

Since
S60 5.1

Member Enumeration Documentation

Enum TCompositeType

EnumeratorValueDescription
ECompositionTypeAnd

Criteria in all composited filters must be fulfiled.

Constructor & Destructor Documentation

~CLbtTriggerFilterComposite ( )

IMPORT_C~CLbtTriggerFilterComposite()[virtual]

Destructor.

Member Function Documentation

AddFilterL ( CLbtTriggerFilterBase * )

IMPORT_C voidAddFilterL(CLbtTriggerFilterBase *aFilter)

Adds a filter.

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

DoExternalizeL ( RWriteStream & )

voidDoExternalizeL(RWriteStream &aStream)const [protected, virtual]

Externalize method that subclass must implement.

ParameterDescription
aStreamStream to which the object should be externalized.

DoInternalizeL ( RReadStream & )

voidDoInternalizeL(RReadStream &aStream)[protected, virtual]

Internalize method that subclass must implement.

ParameterDescription
aStreamStream from which the object should be internalized.

GetFilter ( TInt )

IMPORT_C CLbtTriggerFilterBase *GetFilter(TIntaIndex)

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.
ParameterDescription
aIndexThe position of the filter. The value shall be in the range of 0 to NumberOfFilters()- 1.

Returns: The pointer to the filter. Ownership of the returned object is not transferred to the client.

NewL ( TCompositeType )

IMPORT_C CLbtTriggerFilterComposite *NewL(TCompositeTypeaType = ECompositionTypeAnd)[static]

Consructs a new instance of CLbtTriggerFilterComposite.

Returns: New instance of CLbtTriggerFilterComposite.

NewLC ( TCompositeType )

IMPORT_C CLbtTriggerFilterComposite *NewLC(TCompositeTypeaType = ECompositionTypeAnd)[static]

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

Returns: New instance of CLbtTriggerFilterComposite.

NumberOfFilters ( )

IMPORT_C TIntNumberOfFilters()const

Gets the number of filters contained in this object.

Returns: The number of filters contained in this object.

RemoveFilter ( TInt )

IMPORT_C voidRemoveFilter(TIntaIndex)

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.
ParameterDescription
aIndexThe position of the filter to be removed.

Reset ( )

IMPORT_C voidReset()

Remove all trigger filters contained in this object.

Type ( )

IMPORT_C TFilterTypeType()const [virtual]

Returns: CLbtTriggerFilterBase::EFilterComposite.