Collapse all Symbian^3 Application Developer Library

CICalProperty Class Reference

class CICalProperty : public CBase

Class representing a property.

Inherits from

CICalProperty
- CBase

Public Member Functions
	~CICalProperty ()
IMPORT_C CICalPropertyParam &	AddPropertyParamL (const TDesC &, CICalValue *)
IMPORT_C CICalPropertyParam &	AddPropertyParamL (const TDesC &, const TDesC &)
CICalPropertyParam &	AddPropertyParamL ()
IMPORT_C void	AddValueL (const TDesC &)
IMPORT_C void	AddValueL ( CICalValue *)
void	ExternalizeL (CICalContentLineWriter &)
IMPORT_C const CICalPropertyParam *	FindParam (const TDesC &)
IMPORT_C CICalProperty *	NewL (const TDesC &, const TDesC &)
IMPORT_C CICalProperty *	NewL (const TDesC &, CICalValue *)
CICalProperty *	NewL (const TDesC &)
IMPORT_C CICalProperty *	NewLC (const TDesC &, const TDesC &)
IMPORT_C CICalProperty *	NewLC (const TDesC &, CICalValue *)
CICalProperty *	NewLC (const TDesC &)
IMPORT_C const RPointerArray < CICalPropertyParam > &	Parameters ()
void	RemovePropertyParamL (const CICalPropertyParam &)
IMPORT_C const TDesC &	Type ()
IMPORT_C const RPointerArray < CICalValue > &	Values ()

Private Member Functions
	CICalProperty ()
	CICalProperty ( CICalValue *)
void	ConstructL (const TDesC &)
void	ConstructL (const TDesC &, const TDesC &)
void	ConstructL (const TDesC &, CICalValue *)

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
RPointerArray < CICalPropertyParam >	iParams
HBufC *	iType
CICalValue *	iValue
RPointerArray < CICalValue >	iValues

Constructor & Destructor Documentation

CICalProperty()

CICalProperty

(

)

[private]

Constructor

CICalProperty(CICalValue *)

CICalProperty

(

CICalValue *

aValue

)

[private]

Constructor

Parameters

CICalValue * aValue

The initial value.

~CICalProperty()

~CICalProperty

(

)

Destructor.

Member Functions Documentation

AddPropertyParamL(const TDesC &, CICalValue *)

IMPORT_C CICalPropertyParam &	AddPropertyParamL	(	const TDesC &	aType,
			CICalValue *	aValue
		)

Adds a parameter with given type and value to the property, taking ownership of the value. Note that further values may be added later.

leave: Leaves with KErrParameterHasNoValue if aValue is NULL.

Parameters

const TDesC & aType	The type of property parameter.
CICalValue * aValue	A value of the property parameter - this will be deleted if this function leaves.

AddPropertyParamL(const TDesC &, const TDesC &)

IMPORT_C CICalPropertyParam &	AddPropertyParamL	(	const TDesC &	aType,
			const TDesC &	aValue
		)

Adds a parameter with given type and value to the property. Note that further values may be added later.

leave: Leaves with if there is an error adding a parameter.

Parameters

const TDesC & aType	The type of property parameter.
const TDesC & aValue	A value of the property parameter.

AddPropertyParamL()

CICalPropertyParam &

AddPropertyParamL

(

)

Adds an empty parameter to the property.

leave: Leaves if there is an error adding a parameter.

AddValueL(const TDesC &)

IMPORT_C void

AddValueL

(

const TDesC &

aValue

)

Adds a value to the property. Any escaped characters in the value string are translated to the actual characters.

leave: Leaves if there is an error adding a value.

Parameters

const TDesC & aValue

The text string of the value, as would be entered into an iCalendar file.

AddValueL(CICalValue *)

IMPORT_C void

AddValueL

(

CICalValue *

aValue

)

Adds value to this property, taking ownership of the passed value pointer and deleting it if this function leaves.

leave: Leaves with KErrPropertyHasNoValue if aValue is NULL.

Parameters

CICalValue * aValue

The value to add - this must not be NULL.

ConstructL(const TDesC &)

void

ConstructL

(

const TDesC &

aType

)

[private]

Internal construction

Parameters

const TDesC & aType

The type of property.

ConstructL(const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aType,
			const TDesC &	aValue
		)	[private]

Internal construction.

Parameters

const TDesC & aType	The type of property.
const TDesC & aValue	A value of the property.

ConstructL(const TDesC &, CICalValue *)

void	ConstructL	(	const TDesC &	aType,
			CICalValue *	aValue
		)	[private]

Internal construction. Takes ownership of the passed value pointer and deletes it if this function leaves.

Parameters

const TDesC & aType	The type of property.
CICalValue * aValue	A value of the property - this class takes ownership.

ExternalizeL(CICalContentLineWriter &)

void

ExternalizeL

(

CICalContentLineWriter &

aWriter

)

Export this property using the given line writer, escaping any necessary characters. Assumes it contains at least one value from the check in CICalBase::ExternalizeL() .

Parameters

CICalContentLineWriter & aWriter

The content line writer to export to.

FindParam(const TDesC &)

IMPORT_C const CICalPropertyParam *

FindParam

(

const TDesC &

aType

)

const

Find a parameter with the given name. Ownership is not passed out.

Parameters

const TDesC & aType

The type of the parameter to search for

NewL(const TDesC &, const TDesC &)

IMPORT_C CICalProperty *	NewL	(	const TDesC &	aType,
			const TDesC &	aValue
		)	[static]

Constructs a new CICalProperty with given type and value and returns it. Note that other values may be added later.

Parameters

const TDesC & aType	The type of the property.
const TDesC & aValue	The value of the property.

NewL(const TDesC &, CICalValue *)

IMPORT_C CICalProperty *	NewL	(	const TDesC &	aType,
			CICalValue *	aValue
		)	[static]

Constructs a new CICalProperty with given type and value and returns it. Takes ownership of the passed value pointer and deletes it if this function leaves. Note that other values may be added later.

leave: Leaves with KErrPropertyHasNoValue if aValue is NULL.

Parameters

const TDesC & aType	The type of the property.
CICalValue * aValue	The value of the property.

NewL(const TDesC &)

CICalProperty *

NewL

(

const TDesC &

aType

)

[static]

Constructs a new CICalProperty with given type and returns it

Parameters

const TDesC & aType

The type of the property.

NewLC(const TDesC &, const TDesC &)

IMPORT_C CICalProperty *	NewLC	(	const TDesC &	aType,
			const TDesC &	aValue
		)	[static]

Constructs a new CICalProperty with given type and value, pushes it onto the Cleanup Stack, and returns it. Note that other values may be added later.

Parameters

const TDesC & aType	The type of the property.
const TDesC & aValue	The value of the property.

NewLC(const TDesC &, CICalValue *)

IMPORT_C CICalProperty *	NewLC	(	const TDesC &	aType,
			CICalValue *	aValue
		)	[static]

Constructs a new CICalProperty with given type and value, pushes it onto the Cleanup Stack, and returns it. Takes ownership of the passed value pointer and deletes it if this function leaves. Note that other values may be added later.

leave: Leaves with KErrPropertyHasNoValue if aValue is NULL.

Parameters

const TDesC & aType	The type of the property.
CICalValue * aValue	The value of the property.

NewLC(const TDesC &)

CICalProperty *

NewLC

(

const TDesC &

aType

)

[static]

Constructs a new CICalProperty with given type, pushes it onto the Cleanup Stack, and returns it.

Parameters

const TDesC & aType

The type of the property.

Parameters()

IMPORT_C const RPointerArray < CICalPropertyParam > &

Parameters

(

)

const

Access method for the array of parameters.

RemovePropertyParamL(const CICalPropertyParam &)

void

RemovePropertyParamL

(

const CICalPropertyParam &

aParam

)

Removes the given parameter from the property.

leave: Leaves in debug mode if the parameter is not found (release mode ignores this).

Parameters

const CICalPropertyParam & aParam

The parameter to remove.

Type()

IMPORT_C const TDesC &

Type

(

)

const

Gets the type of the property.

Values()

IMPORT_C const RPointerArray < CICalValue > &

Values

(

)

const

Access method for the array of properties.

Member Data Documentation

RPointerArray< CICalPropertyParam > iParams

RPointerArray < CICalPropertyParam >

iParams

[private]

HBufC * iType

HBufC *

iType

[private]

CICalValue * iValue

CICalValue *

iValue

[private]

RPointerArray< CICalValue > iValues

RPointerArray < CICalValue >

iValues

[private]