Symbian^3 Product Developer Library >

CMenuFilter Class Reference

class CMenuFilter : public CBase
Menu item filter criteria. Allows querying items filtered by flags, type and attributes. Wildcards are not supported (neither in attributes, nor in type). mcsmenu.lib
Since
S60 v5.0

Inherits from

Public Member Functions
~CMenuFilter()
IMPORT_C voidDoNotHaveAttributeL(const TDesC &)
voidExternalizeL(RWriteStream &)
IMPORT_C TUint32FlagsOff()
IMPORT_C TUint32FlagsOn()
IMPORT_C TBoolGetAttribute(TInt, TPtrC &, TPtrC &)
IMPORT_C voidHaveAttributeL(const TDesC &, const TDesC &)
voidInternalizeL(RReadStream &)
IMPORT_C CMenuFilter *NewL()
IMPORT_C CMenuFilter *NewLC()
IMPORT_C TIntNumAttributes()
IMPORT_C voidRemoveAttribute(const TDesC &)
IMPORT_C voidReset()
IMPORT_C voidSetFlags(TUint32, TUint32)
IMPORT_C voidSetType(const TDesC &)
IMPORT_C TPtrCType()
Private Member Functions
CMenuFilter()
voidConstructL()
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()
Private Attributes
TData *iData

Constructor & Destructor Documentation

CMenuFilter()

CMenuFilter()[private]

Constructor.

~CMenuFilter()

IMPORT_C~CMenuFilter()[virtual]
Destructor.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Member Functions Documentation

ConstructL()

voidConstructL()[private]

Second-phase constructor.

DoNotHaveAttributeL(const TDesC &)

IMPORT_C voidDoNotHaveAttributeL(const TDesC &aAttrName)
Add/replace attribute filter criteria. The attribute must not exist.
Since
S60 v5.0
capability
None.
Exceptions
System-wide

error codes if an error occurs.

panic
None.

Parameters

const TDesC & aAttrNameAttribute name. Previous attribute filter with the same name is replaced.

ExternalizeL(RWriteStream &)

voidExternalizeL(RWriteStream &aStream)const

Externalize object.

Parameters

RWriteStream & aStreamStream to externalize into.

FlagsOff()

IMPORT_C TUint32FlagsOff()const
Get flag filter criteria: these flags must be off.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

FlagsOn()

IMPORT_C TUint32FlagsOn()const
Get flag filter criteria: these flags must be on.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

GetAttribute(TInt, TPtrC &, TPtrC &)

IMPORT_C TBoolGetAttribute(TIntaIndex,
TPtrC &aAttrName,
TPtrC &aAttrValue
)const
Get attribute filter criteria by index. (Attribute must be defined and have a certain value, or it must be undefined).
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Parameters

TInt aIndexIndex of attribute filter criteria.
TPtrC & aAttrNameAttribute name is returned here.
TPtrC & aAttrValueAttribute value (if defined) is returned here.

HaveAttributeL(const TDesC &, const TDesC &)

IMPORT_C voidHaveAttributeL(const TDesC &aAttrName,
const TDesC &aAttrValue
)
Add/replace attribute filter criteria. The attribute must exist and have the given value.
Since
S60 v5.0
capability
None.
Exceptions
System-wide

error codes if an error occurs.

panic
None.

Parameters

const TDesC & aAttrNameAttribute name. Previous attribute filter with the same name is replaced. aAttrValue Attribute must have this value.
const TDesC & aAttrValue

InternalizeL(RReadStream &)

voidInternalizeL(RReadStream &aStream)

Internalize object.

Parameters

RReadStream & aStreamStream to externalize from.

NewL()

IMPORT_C CMenuFilter *NewL()[static]
Two phased constructor.
Since
S60 v5.0
capability
None.
Exceptions
System-wide

error codes if an error occurs.

panic
None.

NewLC()

IMPORT_C CMenuFilter *NewLC()[static]
Two phased constructor.
Since
S60 v5.0
capability
None.
Exceptions
System-wide

error codes if an error occurs.

panic
None.

NumAttributes()

IMPORT_C TIntNumAttributes()const
Get number of attribute filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

RemoveAttribute(const TDesC &)

IMPORT_C voidRemoveAttribute(const TDesC &aAttrName)
Remove attribute filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Parameters

const TDesC & aAttrNameAttribute name. Previous attribute filter with the same name (if any) is removed.

Reset()

IMPORT_C voidReset()
Reset filter (==pass all).
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

SetFlags(TUint32, TUint32)

IMPORT_C voidSetFlags(TUint32aFlagsOn,
TUint32aFlagsOff
)
Set on and off flag filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Parameters

TUint32 aFlagsOnThese flags must be on. (0=="flag on" filter off)
TUint32 aFlagsOffThese flags must be off. (0=="flag off" filter off)

SetType(const TDesC &)

IMPORT_C voidSetType(const TDesC &aType)
Set type filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Parameters

const TDesC & aTypeType filter. (empty==type filter off)

Type()

IMPORT_C TPtrCType()const
Get type filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Member Data Documentation

TData * iData

TData *iData[private]

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.