Collapse all Symbian^3 Product Developer Library

CESMRICalValue Class Reference

class CESMRICalValue : public CBase

Class representing a property-, property parameter- or rule segement value.

Inherits from

CESMRICalValue
- CBase

Public Member Functions
	~CESMRICalValue()
IMPORT_C HBufC8 *	BinaryLC()
IMPORT_C TBool	BooleanL()
IMPORT_C TTimeIntervalSeconds	DurationL()
IMPORT_C void	GetDateL(TTime &)
IMPORT_C void	GetDateTimeL(TTime &, TTimeZoneType &, TInt)
IMPORT_C void	GetDayL(TDay &, TInt &)
IMPORT_C void	GetFloatL(TReal &)
IMPORT_C void	GetPeriodL(TTime &, TTimeZoneType &, TTime &, TTimeZoneType &)
IMPORT_C void	GetRecurrenceRuleL(RPointerArray< CESMRICalRuleSegment > &)
IMPORT_C void	GetTimeL(TTime &, TTimeZoneType &)
IMPORT_C TInt	IntegerL()
IMPORT_C TMonth	MonthL()
IMPORT_C CESMRICalValue *	NewL()
IMPORT_C CESMRICalValue *	NewLC()
IMPORT_C void	SetBinaryL(const TDesC8 &)
IMPORT_C void	SetBooleanL(TBool)
IMPORT_C void	SetDateL(const TTime &)
IMPORT_C void	SetDateTimeL(const TTime &, TTimeZoneType)
IMPORT_C void	SetDayL(TDay, TInt)
IMPORT_C void	SetDurationL(TTimeIntervalSeconds)
IMPORT_C void	SetFloatL(const TReal &)
IMPORT_C void	SetIntegerL(TInt)
IMPORT_C void	SetMonthL(TMonth)
IMPORT_C void	SetPeriodL(const TTime &, TTimeZoneType, const TTime &, TTimeZoneType)
IMPORT_C void	SetRecurrenceRuleL(const TDesC &)
IMPORT_C void	SetTextL(const TDesC &)
IMPORT_C void	SetTimeL(const TTime &, TTimeZoneType)
IMPORT_C void	SetUtcOffsetL(TTimeIntervalSeconds)
IMPORT_C const TDesC &	TextL()
IMPORT_C TTimeIntervalSeconds	UtcOffsetL()

Private Member Functions
	CESMRICalValue()
void	AppendDateToValueL(const TTime &)
void	AppendTimeToValueL(const TTime &)
void	CheckNullValueL()
void	ConstructL()
void	GetDateFromValueL(TTime &, TInt)
TBool	GetDurDateL(TInt &, TInt &)
TBool	GetDurHourL(TInt &, TInt &)
TBool	GetDurMinuteL(TInt &, TInt &)
TBool	GetDurSecondL(TInt &, TInt &)
TBool	GetDurTimeL(TInt &, TInt &)
TBool	GetDurWeekL(TInt &, TInt &)
void	GetTimeFromValueL(TTime &, TTimeZoneType &, TInt)
void	GetTimeIntervalFromValueL(TTimeIntervalSeconds &, TInt)
void	PrepareValuePointer()
TInt	ReadIntL(const TDesC &)

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()

Public Member Enumerations
enum	TTimeZoneType { EFloatingTime, EUtcTime, ESpecifiedTimeZone }

Private Attributes
HBufC *	iValue

Constructor & Destructor Documentation

CESMRICalValue()

CESMRICalValue

(

)

[private]

~CESMRICalValue()

~CESMRICalValue

(

)

Member Functions Documentation

AppendDateToValueL(const TTime &)

void

AppendDateToValueL

(

const TTime &

aDate

)

[private]

Appends the date to iValue. Member iValue must be initialised before calling.

Parameters

const TTime & aDate

TTime to append to the value.

AppendTimeToValueL(const TTime &)

void

AppendTimeToValueL

(

const TTime &

aTime

)

[private]

Appends the time to iValue. Member iValue must be initialised before calling.

Parameters

const TTime & aTime

TTime to append to the value.

BinaryLC()

IMPORT_C HBufC8 *

BinaryLC

(

)

const

BooleanL()

IMPORT_C TBool

BooleanL

(

)

const

CheckNullValueL()

void

CheckNullValueL

(

)

const [private]

Checks for a NULL value. Should be called before accessing iValue.

leave: Leaves with KErrCorrupt if the value is NULL.

ConstructL()

void

ConstructL

(

)

[private]

DurationL()

IMPORT_C TTimeIntervalSeconds

DurationL

(

)

const

GetDateFromValueL(TTime &, TInt)

void	GetDateFromValueL	(	TTime &	aDate,
			TInt	aFirstCharacterNum = 0
		)	const [private]

Gets the date from iValue descriptor. Should be in the format YYYYMMDD

leave: Leaves with KErrCorrupt if the format of the value is not a valid date.

Parameters

TTime & aDate	A modifiable reference returning a date.
TInt aFirstCharacterNum = 0	Skip this many characters at the start of the value.

GetDateL(TTime &)

IMPORT_C void

GetDateL

(

TTime &

aDate

)

const

Parameters

TTime & aDate

GetDateTimeL(TTime &, TTimeZoneType &, TInt)

IMPORT_C void	GetDateTimeL	(	TTime &	aDateTime,
			TTimeZoneType &	aTzType,
			TInt	aFirstCharacterNum = 0
		)	const

Parameters

TTime & aDateTime
TTimeZoneType & aTzType
TInt aFirstCharacterNum = 0

GetDayL(TDay &, TInt &)

IMPORT_C void	GetDayL	(	TDay &	aDay,
			TInt &	aPos
		)	const

Parameters

TDay & aDay
TInt & aPos

GetDurDateL(TInt &, TInt &)

TBool	GetDurDateL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-day into a number of seconds

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable.
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetDurHourL(TInt &, TInt &)

TBool	GetDurHourL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-hour into a number of seconds. There is no range check on the number of hours.

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable.
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetDurMinuteL(TInt &, TInt &)

TBool	GetDurMinuteL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-minute into a number of seconds. There is no range check on the number of minutes.

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable.
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetDurSecondL(TInt &, TInt &)

TBool	GetDurSecondL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-second into a number of seconds. There is no range check on the number of seconds.

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable.
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetDurTimeL(TInt &, TInt &)

TBool	GetDurTimeL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-time into a number of seconds

leave: Leaves with KErrCorrupt if the value does not hold a valid time.

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable.
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetDurWeekL(TInt &, TInt &)

TBool	GetDurWeekL	(	TInt &	aIntervalSecs,
			TInt &	aCurrentCharNumber
		)	const [private]

Reads in and converts a dur-week into a number of seconds

Parameters

TInt & aIntervalSecs	Function adds number of seconds to this variable
TInt & aCurrentCharNumber	Character number to start looking in the value.

GetFloatL(TReal &)

IMPORT_C void

GetFloatL

(

TReal &

aFloat

)

const

Parameters

TReal & aFloat

GetPeriodL(TTime &, TTimeZoneType &, TTime &, TTimeZoneType &)

IMPORT_C void	GetPeriodL	(	TTime &	aStartTime,
			TTimeZoneType &	aStartTzType,
			TTime &	aEndTime,
			TTimeZoneType &	aEndTzType
		)	const

Parameters

TTime & aStartTime
TTimeZoneType & aStartTzType
TTime & aEndTime
TTimeZoneType & aEndTzType

GetRecurrenceRuleL(RPointerArray< CESMRICalRuleSegment > &)

IMPORT_C void

GetRecurrenceRuleL

(

RPointerArray< CESMRICalRuleSegment > &

aRuleSegmentArray

)

const

Parameters

RPointerArray< CESMRICalRuleSegment > & aRuleSegmentArray

GetTimeFromValueL(TTime &, TTimeZoneType &, TInt)

void	GetTimeFromValueL	(	TTime &	aTime,
			TTimeZoneType &	aTzType,
			TInt	aFirstCharacterNum = 0
		)	const [private]

Gets the time from iValue descriptor, starting from a pre-determined point. Should be in the format HHMMSS[Z]

leave: Leaves with KErrCorrupt if the value does not hold a valid time.

Parameters

TTime & aTime	TTime to store result of read in
TTimeZoneType & aTzType	Enumeration showing whether the time represents local time (not supported), UTC or a custom time zone.
TInt aFirstCharacterNum = 0	The character number to start searching from.

GetTimeIntervalFromValueL(TTimeIntervalSeconds &, TInt)

void	GetTimeIntervalFromValueL	(	TTimeIntervalSeconds &	aTime,
			TInt	aFirstCharacterNum = 0
		)	const [private]

Retrieves a time interval stored as a duration as per the RFC 2445 specification.

leave: Leaves with KErrCorrupt if the value does not hold a valid interval.

Parameters

TTimeIntervalSeconds & aTime	TTimeIntervalSeconds to store the result in.
TInt aFirstCharacterNum = 0	The position in the value containing the first character of the duration.

GetTimeL(TTime &, TTimeZoneType &)

IMPORT_C void	GetTimeL	(	TTime &	aTime,
			TTimeZoneType &	aTzType
		)	const

Parameters

TTime & aTime
TTimeZoneType & aTzType

IntegerL()

IMPORT_C TInt

IntegerL

(

)

const

MonthL()

IMPORT_C TMonth

MonthL

(

)

const

NewL()

IMPORT_C CESMRICalValue *

NewL

(

)

[static]

NewLC()

IMPORT_C CESMRICalValue *

NewLC

(

)

[static]

PrepareValuePointer()

void

PrepareValuePointer

(

)

[private]

Prepares iValue pointer for writing. Deletes existing pointer if it exists.

ReadIntL(const TDesC &)

TInt

ReadIntL

(

const TDesC &

aDes

)

const [private]

Reads a TInt from the given descriptor.

leave: Leaves if there is an error reading an integer.

Parameters

const TDesC & aDes

The descriptor to convert

SetBinaryL(const TDesC8 &)

IMPORT_C void

SetBinaryL

(

const TDesC8 &

aBuffer

)

Parameters

const TDesC8 & aBuffer

SetBooleanL(TBool)

IMPORT_C void

SetBooleanL

(

TBool

aBool

)

Parameters

TBool aBool

SetDateL(const TTime &)

IMPORT_C void

SetDateL

(

const TTime &

aDate

)

Parameters

const TTime & aDate

SetDateTimeL(const TTime &, TTimeZoneType)

IMPORT_C void	SetDateTimeL	(	const TTime &	aDateTime,
			TTimeZoneType	aTzType
		)

Parameters

const TTime & aDateTime
TTimeZoneType aTzType

SetDayL(TDay, TInt)

IMPORT_C void	SetDayL	(	TDay	aDay,
			TInt	aPos = 0
		)

Parameters

TDay aDay
TInt aPos = 0

SetDurationL(TTimeIntervalSeconds)

IMPORT_C void

SetDurationL

(

TTimeIntervalSeconds

aDuration

)

Parameters

TTimeIntervalSeconds aDuration

SetFloatL(const TReal &)

IMPORT_C void

SetFloatL

(

const TReal &

aFloat

)

Parameters

const TReal & aFloat

SetIntegerL(TInt)

IMPORT_C void

SetIntegerL

(

TInt

aInt

)

Parameters

TInt aInt

SetMonthL(TMonth)

IMPORT_C void

SetMonthL

(

TMonth

aMonth

)

Parameters

TMonth aMonth

SetPeriodL(const TTime &, TTimeZoneType, const TTime &, TTimeZoneType)

IMPORT_C void	SetPeriodL	(	const TTime &	aStartTime,
			TTimeZoneType	aStartTzType,
			const TTime &	aEndTime,
			TTimeZoneType	aEndTzType
		)

Parameters

const TTime & aStartTime
TTimeZoneType aStartTzType
const TTime & aEndTime
TTimeZoneType aEndTzType

SetRecurrenceRuleL(const TDesC &)

IMPORT_C void

SetRecurrenceRuleL

(

const TDesC &

aRuleValue

)

Parameters

const TDesC & aRuleValue

SetTextL(const TDesC &)

IMPORT_C void

SetTextL

(

const TDesC &

aText

)

Parameters

const TDesC & aText

SetTimeL(const TTime &, TTimeZoneType)

IMPORT_C void	SetTimeL	(	const TTime &	aTime,
			TTimeZoneType	aTzType
		)

Parameters

const TTime & aTime
TTimeZoneType aTzType

SetUtcOffsetL(TTimeIntervalSeconds)

IMPORT_C void

SetUtcOffsetL

(

TTimeIntervalSeconds

aOffset

)

Parameters

TTimeIntervalSeconds aOffset

TextL()

IMPORT_C const TDesC &

TextL

(

)

const

UtcOffsetL()

IMPORT_C TTimeIntervalSeconds

UtcOffsetL

(

)

const

Member Enumerations Documentation

Enum TTimeZoneType

Enumerators

EFloatingTime	Local "floating" time.
EUtcTime	UTC time.
ESpecifiedTimeZone	User specified time zone.

Member Data Documentation

HBufC * iValue

HBufC *

iValue

[private]