Collapse all Symbian^3 Product Developer Library

TVersitDateTime Class Reference

class TVersitDateTime

Defines a Versit date and time.

This class is used throughout Versit to represent the date and time. It uses a TDateTime object to store the date/time value and records whether this value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal time (UTC).

The Year(), Month() and Day() member functions of class TDateTime may be used to extract the date and time components from the TVersitDateTime::iDateTime.

Public Member Functions
	TVersitDateTime(const TDateTime &, TRelativeTime)
void	ClearFlag(TVersitDateTimeFlags)
TBool	IsFlagSet(TVersitDateTimeFlags)
void	SetFlag(TVersitDateTimeFlags)

Public Member Enumerations
enum	TRelativeTime { EIsUTC, EIsVCardLocal, EIsMachineLocal, EIsCorrect }
enum	TVersitDateTimeFlags { EExportNullFlag = 0, EExportTimeZoneDesignator = 0x01, EExportLeaveAsLocalTime = 0x02 }

Public Attributes
TDateTime	iDateTime
TRelativeTime	iRelativeTime

Private Attributes
TInt	iFlags

Constructor & Destructor Documentation

TVersitDateTime(const TDateTime &, TRelativeTime)

IMPORT_C	TVersitDateTime	(	const TDateTime &	aDateTime,
			TRelativeTime	aRelativeTime
		)

Constructs the Versit date/time object with a date/time value and a specification of whether this value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal time.

Parameters

const TDateTime & aDateTime	The date/time value.
TRelativeTime aRelativeTime	The time the date/time value represents.

Member Functions Documentation

ClearFlag(TVersitDateTimeFlags)

void

ClearFlag

(

TVersitDateTimeFlags

aFlag

)

[inline]

since 9.1

Parameters

TVersitDateTimeFlags aFlag

IsFlagSet(TVersitDateTimeFlags)

TBool

IsFlagSet

(

TVersitDateTimeFlags

aFlag

)

const [inline]

since 9.1

Parameters

TVersitDateTimeFlags aFlag

SetFlag(TVersitDateTimeFlags)

void

SetFlag

(

TVersitDateTimeFlags

aFlag

)

[inline]

since 9.1

Parameters

TVersitDateTimeFlags aFlag

Member Enumerations Documentation

Enum TRelativeTime

Relative time flags.

Enumerators

EIsUTC	Time is stored in UTC.
EIsVCardLocal	Time is local to the machine which originated the vCard.
EIsMachineLocal	Time is local to the machine on which the code is running.
EIsCorrect	Unused.

Enum TVersitDateTimeFlags

Date/time flags. since 9.1

Enumerators

EExportNullFlag = 0

EExportTimeZoneDesignator = 0x01

Indicates whether the relative time is to be externalized along with the date/time value.

The flag is set to 'EExportNullFlag' by default.

This is only implemented (by CParserTimePropertyValue::EncodeVersitDateTimeL()) if the date/time is universal. When the flag is set, the externalised value is followed by the token, KVersitTokenUniversalTime.

EExportLeaveAsLocalTime = 0x02

Member Data Documentation

TDateTime iDateTime

TDateTime

iDateTime

The date/time value.

TInt iFlags

TInt

iFlags

[private]

TRelativeTime iRelativeTime

TRelativeTime

iRelativeTime

Specifies whether the time value is local to the machine which originated the vCard, local to the machine on which the code is running, or universal.