Class CParserGroupedProperty

CParserGroupedProperty

Support

Supported from 5.0

Description

A grouped property. This is a vCard property which is a member of a property group. It owns an array of descriptors, each of which identifies the name of a group to which the property belongs (a grouped property can be a member of more than one group).

Derivation

CBase Base class for all classes to be instantiated on the heap CParserGroupedProperty A grouped property CParserProperty A property in a vCard or vCalendar

Defined in CParserGroupedProperty:
Group(), NewL(), NewLC(), ~CParserGroupedProperty()

Inherited from CBase:
operator new()

Inherited from CParserProperty:
AddParamL(), DeleteParam(), Name(), Param(), SetNameL(), Value()

CParserGroupedProperty* NewL(CParserPropertyValue* aPropertyValue, const TDesC& aName, CDesCArray* aArrayOfGroups, CArrayPtr<CParserParam>* aArrayOfParams);

Description

Allocates and constructs a new grouped property from the value, name, property parameters and groups specified.

Parameters

CParserPropertyValue* aPropertyValue Pointer to the property value. const TDesC& aName The property name. CDesCArray* aArrayOfGroups Pointer to an array of descriptors. Each one specifies a group name. The grouped property object takes ownership of the array of groups. May be NULL. CArrayPtr<CParserParam>* aArrayOfParams The property parameters. The grouped property object takes ownership of the array of parameters. May be NULL.

Return value

CParserGroupedProperty* Pointer to the newly created grouped property.

CParserGroupedProperty* NewLC(CParserPropertyValue* aPropertyValue, const TDesC& aName, CDesCArray* aArrayOfGroups, CArrayPtr<CParserParam>* aArrayOfParams);

Description

Allocates and constructs a new property group from the value, name, property parameters and groups specified — the grouped property is left on the cleanup stack.

Parameters

CParserPropertyValue* aPropertyValue Pointer to the property value. const TDesC& aName The property name. CDesCArray* aArrayOfGroups Pointer to an array of descriptors. Each descriptor in the array is a group name. The grouped property object takes ownership of the array of groups. May be NULL. CArrayPtr<CParserParam>* aArrayOfParams The property parameters. The grouped property object takes ownership of the array of parameters. May be NULL.

Return value

CParserGroupedProperty* Pointer to the newly created grouped property.

~CParserGroupedProperty();

Description

Frees all resources owned by the property, prior to its destruction.

TBool Group(const TDesC& aGroup) const;

Description

Tests whether the property is a member of the specified property group.

Parameters

const TDesC& aGroup The name of the property group.

Return value

TBool ETrue if the property is a member of the specified property group. EFalse if not.