EPOC   SDK Home Glossary Indexes Previous Next Up

CParserGroupedProperty class


Contents


CParserGroupedProperty class — Grouped property

Section Contents


Overview

Compatibility

Applications that use this class will not work correctly on a version of EPOC earlier than ER5.

Derivation

CBase

Abstract: CBase behaviour.

CParserProperty

Base class for versit properties.

Defined in

vcard.h

Link against

versit.lib

Description

Encapsulates a grouped property.

A grouped property is a parser property, derived from CParserProperty, which is a member of a property group. It owns an array of descriptors, each of which specifies the name of a group to which the property belongs.


Construction and destruction


NewL() — Allocate and construct

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

Description

Use this function to allocate and construct a new grouped property from the value, name, property parameters and groups specified.

Arguments

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 (a grouped property can be a member of more than one group).

The grouped property object takes ownership of the array of groups.

May be NULL if the property is not a member of a group.

CArrayPtr<CParserParam>* aArrayOfParams

The property parameters.

The grouped property object takes ownership of the array of parameters.

May be NULL if the property has no parameters.

Return value

CParserGroupedProperty*

Pointer to the newly created grouped property.


NewLC() — Allocate and construct

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

Description

Use this function to allocate and construct a new property group from the value, name, property parameters and groups specified. The grouped property is left on the cleanup stack.

Arguments

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 (a grouped property can be a member of more than one group).

The grouped property object takes ownership of the array of groups.

May be NULL if the property is not a member of a group.

CArrayPtr<CParserParam>* aArrayOfParams

The property parameters.

The grouped property object takes ownership of the array of parameters.

May be NULL if the property has no parameters.

Return value

CParserGroupedProperty*

Pointer to the newly created grouped property.


~CParserGroupedProperty() — Destructor

~CParserGroupedProperty();

Description

The destructor frees all resources owned by the property, prior to its destruction.


Property group


Group() — Get whether property is in group

TBool Group(const TDesC& aGroup) const;

Description

Use this function to test whether the grouped property is a member of the specified property group.

Arguments

const TDesC& aGroup

The name of the property group.

Return value

TBool

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

EPOC       SDK Home Glossary Indexes Previous Next Up