#include <app/vcard.h>
| class CParserGroupedProperty : public CParserProperty |
| Protected Attributes | |
|---|---|
| CDesC8Array * | iArrayOfGroups |
| Public Member Functions | |
|---|---|
| CParserGroupedProperty(CDesC8Array *, CArrayPtr< CParserParam > *) | |
| ~CParserGroupedProperty() | |
| virtual IMPORT_C void | ExternalizeL(RWriteStream &, CVersitParser *) |
| IMPORT_C TBool | Group(const TDesC8 &) |
| const CDesC8Array * | Groups() |
| IMPORT_C CParserGroupedProperty * | NewL(CParserPropertyValue &, const TDesC8 &, CDesC8Array *, CArrayPtr< CParserParam > *) |
| void | SetGroups(CDesC8Array *) |
| virtual IMPORT_C TBool | SupportsInterface(const TUid &) |
| Protected Member Functions | |
|---|---|
| CParserGroupedProperty(CParserPropertyValue &, CDesC8Array *, CArrayPtr< CParserParam > *) | |
| Inherited Attributes | |
|---|---|
| CParserProperty::iArrayOfParams | |
| CParserProperty::iPropertyName | |
| CParserProperty::iPropertyNameUid | |
| CParserProperty::iPropertyValue | |
A grouped property.
This is a vCard property which may be a member of one or more property groups. It owns an array of descriptors, each of which identifies a group to which the property belongs.
An example of how grouped properties may be useful is for a person with two homes. Each home has an address and telephone number, both of which are to be stored on the vCard. The address and telephone number are grouped for each home. A prefix for the address and telephone number properties is provided: one for each home. Each prefix is stored as a property group.
When the property is externalised, the identities of all the groups to which the property belongs (i.e. the prefixes) are written to the stream before CParserProperty::ExternalizeL() is called.
The class also provides a function which can be used to test whether the property is a member of a given group.
Note that the vCard parser stores all properties using this class; if the vCard property is not grouped then the array of property groups is empty. Conversely, the vCalender parser does not have property groups, and so stores all properties using the CParserProperty base class.
| IMPORT_C | CParserGroupedProperty | ( | CDesC8Array * | aArrayOfGroups, |
| CArrayPtr< CParserParam > * | aArrayOfParams | |||
| ) | ||||
Allocates and partially constructs a new grouped property using the array of grouped property names and array of property parameters specified.
| Parameter | Description |
|---|---|
| aArrayOfGroups | Pointer to an array of descriptors. Each one specifies a group name. The grouped property takes ownership of this array. (May be NULL). |
| aArrayOfParams | The property parameters. The grouped property takes ownership of this array. (May be NULL). |
| CParserGroupedProperty | ( | CParserPropertyValue & | aPropertyValue, |
| CDesC8Array * | aArrayOfGroups, | ||
| CArrayPtr< CParserParam > * | aArrayOfParams | ||
| ) | [protected] | ||
| IMPORT_C | ~CParserGroupedProperty | ( | ) |
Frees all resources owned by the property, prior to its destruction.
| IMPORT_C void | ExternalizeL | ( | RWriteStream & | aStream, |
| CVersitParser * | aVersitParser = NULL | |||
| ) | [virtual] | |||
Reimplemented from CParserProperty::ExternalizeL(RWriteStream &,CVersitParser *)
Externalises the property into aStream.
Externalises the list of groups to which the property belongs, if there are any, then calls CParserProperty::ExternalizeL() to write the rest of the property data to the stream.
| Parameter | Description |
|---|---|
| aStream | Stream to which the value should be externalised. |
| aVersitParser | Versit parser which contains the objects to be externalised. This must not be NULL or a panic occurs. |
| const CDesC8Array * | Groups | ( | ) | [inline] |
Gets the groups to which the property belongs.
Returns: Pointer to an array of descriptors. Each one specifies a group name.
| IMPORT_C CParserGroupedProperty * | NewL | ( | CParserPropertyValue & | aPropertyValue, |
| const TDesC8 & | aName, | |||
| CDesC8Array * | aArrayOfGroups, | |||
| CArrayPtr< CParserParam > * | aArrayOfParams | |||
| ) | [static] | |||
Allocates and constructs a new grouped property from the value, name, property parameters and groups specified.
Note: the property value, name and array of property parameters are generic to all properties. The array of grouped property names is specific to the CParserGroupedProperty class.
| Parameter | Description |
|---|---|
| aPropertyValue | The property value. The grouped property takes ownership of this. |
| aName | The property name. The grouped property takes ownership of this. |
| aArrayOfGroups | Pointer to an array of descriptors. Each one specifies a group name. The grouped property takes ownership of this array. (May be NULL). |
| aArrayOfParams | The property parameters. The grouped property takes ownership of this array. (May be NULL). |
Returns: Pointer to the newly created grouped property.
| void | SetGroups | ( | CDesC8Array * | aArrayOfGroups | ) | [inline] |
Sets the list of groups to which the property belongs, replacing any existing list.
| Parameter | Description |
|---|---|
| aArrayOfGroups | Array of descriptors; each of which specifies a group name. The grouped property takes ownership of the array. |
Reimplemented from CParserProperty::SupportsInterface(const TUid &)const
Tests whether the property supports the given interface.
Returns true if the given interface UID is KVersitGroupedPropertyUid.
| Parameter | Description |
|---|---|
| aInterfaceUid | An interface UID. |
Returns: ETrue if aInterfaceUid is KVersitGroupedPropertyUid, and EFalse if not.