Symbian^3 Application 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 void DoNotHaveAttributeL (const TDesC &)
void ExternalizeL ( RWriteStream &)
IMPORT_C TUint32 FlagsOff ()
IMPORT_C TUint32 FlagsOn ()
IMPORT_C TBool GetAttribute ( TInt , TPtrC &, TPtrC &)
IMPORT_C void HaveAttributeL (const TDesC &, const TDesC &)
void InternalizeL ( RReadStream &)
IMPORT_C CMenuFilter * NewL ()
IMPORT_C CMenuFilter * NewLC ()
IMPORT_C TInt NumAttributes ()
IMPORT_C void RemoveAttribute (const TDesC &)
IMPORT_C void Reset ()
IMPORT_C void SetFlags ( TUint32 , TUint32 )
IMPORT_C void SetType (const TDesC &)
IMPORT_C TPtrC Type ()
Private Member Functions
CMenuFilter ()
void ConstructL ()
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()

void ConstructL ( ) [private]

Second-phase constructor.

DoNotHaveAttributeL(const TDesC &)

IMPORT_C void DoNotHaveAttributeL ( 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 & aAttrName Attribute name. Previous attribute filter with the same name is replaced.

ExternalizeL(RWriteStream &)

void ExternalizeL ( RWriteStream & aStream ) const

Externalize object.

Parameters

RWriteStream & aStream Stream to externalize into.

FlagsOff()

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

panic
None.

FlagsOn()

IMPORT_C TUint32 FlagsOn ( ) 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 TBool GetAttribute ( TInt aIndex,
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 aIndex Index of attribute filter criteria.
TPtrC & aAttrName Attribute name is returned here.
TPtrC & aAttrValue Attribute value (if defined) is returned here.

HaveAttributeL(const TDesC &, const TDesC &)

IMPORT_C void HaveAttributeL ( 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 & aAttrName Attribute name. Previous attribute filter with the same name is replaced. aAttrValue Attribute must have this value.
const TDesC & aAttrValue

InternalizeL(RReadStream &)

void InternalizeL ( RReadStream & aStream )

Internalize object.

Parameters

RReadStream & aStream Stream 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 TInt NumAttributes ( ) const
Get number of attribute filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

RemoveAttribute(const TDesC &)

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

panic
None.

Parameters

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

Reset()

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

panic
None.

SetFlags(TUint32, TUint32)

IMPORT_C void SetFlags ( TUint32 aFlagsOn,
TUint32 aFlagsOff
)
Set on and off flag filter criteria.
Since
S60 v5.0
capability
None.
Exceptions
None.

panic
None.

Parameters

TUint32 aFlagsOn These flags must be on. (0=="flag on" filter off)
TUint32 aFlagsOff These flags must be off. (0=="flag off" filter off)

SetType(const TDesC &)

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

panic
None.

Parameters

const TDesC & aType Type filter. (empty==type filter off)

Type()

IMPORT_C TPtrC Type ( ) 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.