Collapse all Symbian^3 Product Developer Library

CICalPropertyParam Class Reference

class CICalPropertyParam : public CBase

Class representing a property parameter.

Inherits from

CICalPropertyParam
- CBase

Public Member Functions
	~CICalPropertyParam()
IMPORT_C void	AddValueL(const TDesC &)
IMPORT_C void	AddValueL(CICalValue *)
TBool	EqualsL(const CICalPropertyParam &, const CICalPropertyParam &)
void	ExternalizeL(CICalContentLineWriter &)
IMPORT_C CICalPropertyParam *	NewL(const TDesC &, CICalValue *)
IMPORT_C CICalPropertyParam *	NewL(const TDesC &, const TDesC &)
IMPORT_C CICalPropertyParam *	NewLC(const TDesC &, CICalValue *)
IMPORT_C CICalPropertyParam *	NewLC(const TDesC &, const TDesC &)
CICalPropertyParam *	NewLC()
void	SetTypeL(const TDesC &)
IMPORT_C const TDesC &	Type()
IMPORT_C const RPointerArray< CICalValue > &	Values()

Private Member Functions
	CICalPropertyParam()
	CICalPropertyParam(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
HBufC *	iType
CICalValue *	iValue
RPointerArray< CICalValue >	iValues

Constructor & Destructor Documentation

CICalPropertyParam()

CICalPropertyParam

(

)

[private]

Constructor

CICalPropertyParam(CICalValue *)

CICalPropertyParam

(

CICalValue *

aValue

)

[private]

Constructor

Parameters

CICalValue * aValue

The initial value.

~CICalPropertyParam()

~CICalPropertyParam

(

)

Destructor

Member Functions Documentation

AddValueL(const TDesC &)

IMPORT_C void

AddValueL

(

const TDesC &

aValue

)

Adds a string to the parameter's list of values. Any quotes are removed from the value as they are only used to escape other characters and are not a valid parameter value character in themselves.

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

Parameters

const TDesC & aValue

The value to add.

AddValueL(CICalValue *)

IMPORT_C void

AddValueL

(

CICalValue *

aValue

)

Adds a value to the parameter's list of values, taking ownership. Note that the value is deleted if this function leaves.

leave: Leaves with KErrParameterHasNoValue if aValue is NULL.

Parameters

CICalValue * aValue

The value to add.

ConstructL(const TDesC &)

void

ConstructL

(

const TDesC &

aType

)

[private]

Internal construction.

Parameters

const TDesC & aType

The type of parameter.

ConstructL(const TDesC &, const TDesC &)

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

Internal construction.

Parameters

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

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 parameter.
CICalValue * aValue	A value of the parameter - this class takes ownership.

EqualsL(const CICalPropertyParam &, const CICalPropertyParam &)

TBool	EqualsL	(	const CICalPropertyParam &	aParam1,
			const CICalPropertyParam &	aParam2
		)	[static]

Determines if two property parameters are equal. Comparison is case-sensitive.

Parameters

const CICalPropertyParam & aParam1	The first property parameter.
const CICalPropertyParam & aParam2	The second property parameter.

ExternalizeL(CICalContentLineWriter &)

void

ExternalizeL

(

CICalContentLineWriter &

aWriter

)

Export this property parameter using the given line writer. Values are quoted if they contain characters that need to be escaped. Assumes it contains at least one value from the check in CICalProperty::ExternalizeL().

Parameters

CICalContentLineWriter & aWriter

The content line writer to export to.

NewL(const TDesC &, CICalValue *)

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

Static factory constructor. 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 KErrParameterHasNoValue if aValue is NULL.

Parameters

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

NewL(const TDesC &, const TDesC &)

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

Static factory constructor. Note that other values may be added later. The constructed object is pushed onto the Cleanup Stack.

Parameters

const TDesC & aType	The type of parameter.
const TDesC & aValue	A value of the parameter passed as a descriptor.

NewLC(const TDesC &, CICalValue *)

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

Static factory constructor. Takes ownership of the passed value pointer and deletes it if this function leaves. Note that other values may be added later. The constructed object is pushed onto the Cleanup Stack.

leave: Leaves with KErrParameterHasNoValue if aValue is NULL.

Parameters

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

NewLC(const TDesC &, const TDesC &)

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

Static factory constructor. Note that other values may be added later. The constructed object is pushed onto the Cleanup Stack.

Parameters

const TDesC & aType	The type of parameter.
const TDesC & aValue	A value of the parameter passed as a descriptor.

NewLC()

CICalPropertyParam *

NewLC

(

)

[static]

Static factory construction. The constructed object is pushed onto the Cleanup Stack. Note that this constructor is not exported.

SetTypeL(const TDesC &)

void

SetTypeL

(

const TDesC &

aType

)

Sets the type of the parameter to a string value

Parameters

const TDesC & aType

the type of the property parameter

Type()

IMPORT_C const TDesC &

Type

(

)

const

Gets the type of the parameter

Values()

IMPORT_C const RPointerArray< CICalValue > &

Values

(

)

const

Access method for the value array.

Member Data Documentation

HBufC * iType

HBufC *

iType

[private]

CICalValue * iValue

CICalValue *

iValue

[private]

RPointerArray< CICalValue > iValues

RPointerArray< CICalValue >

iValues

[private]