Collapse all Symbian^3 Product Developer Library

CTzLocalizedTimeZone Class Reference

class CTzLocalizedTimeZone : public CBase

Encapsulates a group of LDML localized timezone names. LDML stands for Locale Data Markup Language. For details, see http://www.openi18n.org/specs/ldml/1.0/ldml-spec.htm

Inherits from

CTzLocalizedTimeZone
- CBase

Public Member Functions
	~CTzLocalizedTimeZone()
IMPORT_C TPtrC	DaylightName()
CTzLocalizedTimeZone *	NewL(const TTzLocalizedId &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)
CTzLocalizedTimeZone *	NewLC(const TTzLocalizedId &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)
void	SetUTCOffset(TInt)
IMPORT_C TPtrC	ShortDaylightName()
IMPORT_C TPtrC	ShortStandardName()
IMPORT_C TPtrC	StandardName()
IMPORT_C TUint16	TimeZoneId()
TTzLocalizedId	TzLocalizedId()
TInt	UTCOffset()

Private Member Functions
	CTzLocalizedTimeZone(const TTzLocalizedId &)
void	ConstructL(const TDesC &, const TDesC &, const TDesC &, 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	TTzFrequentlyUsedZone { ECurrentZone, EHomeZone, EInterestZone, ERecentZone1, ERecentZone2, ECachedTimeZones }

Private Attributes
HBufC *	iDaylightName
HBufC *	iShortDaylightName
HBufC *	iShortStandardName
HBufC *	iStandardName
TTzLocalizedId	iTzLocalizedId
TInt	iUTCOffset

Constructor & Destructor Documentation

CTzLocalizedTimeZone(const TTzLocalizedId &)

CTzLocalizedTimeZone

(

const TTzLocalizedId &

aTzLocalizedId

)

[private]

First phase construtor

Parameters

const TTzLocalizedId & aTzLocalizedId

~CTzLocalizedTimeZone()

~CTzLocalizedTimeZone

(

)

Destructor

Member Functions Documentation

ConstructL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)

void	ConstructL	(	const TDesC &	aStandardName,
			const TDesC &	aDaylightName,
			const TDesC &	aShortStandardName,
			const TDesC &	aShortDaylightName
		)	[private]

Second phase construtor.

Parameters

const TDesC & aStandardName	The standard name of the time zone, for instance "Greenwich Mean Time", "Pacific Standard Time".
const TDesC & aDaylightName	The daylight saving time name, for instance "British Summer Time", "Pacific Daylight Time" of this time zone.
const TDesC & aShortStandardName	The short standard name, for instance "GMT", "PST" of this time zone.
const TDesC & aShortDaylightName	The short daylight saving time name, for instance "BST", "PDT" of this time zone.

DaylightName()

IMPORT_C TPtrC

DaylightName

(

)

const

Returns this time zone's daylight saving time name, for instance "British Summer Time", "Pacific Daylight Time".

NewL(const TTzLocalizedId &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

CTzLocalizedTimeZone *	NewL	(	const TTzLocalizedId &	aTzLocalizedId,
			const TDesC &	aStandardName,
			const TDesC &	aDaylightName,
			const TDesC &	aShortStandardName,
			const TDesC &	aShortDaylightName
		)	[static]

Two phase Symbian constructor.

Parameters

const TTzLocalizedId & aTzLocalizedId	Contains the time zone ID and resource ID for this time zone.
const TDesC & aStandardName	The standard name of the time zone, for instance "Greenwich Mean Time", "Pacific Standard Time".
const TDesC & aDaylightName	The daylight saving time name, for instance "British Summer Time", "Pacific Daylight Time" of this time zone.
const TDesC & aShortStandardName	The short standard name, for instance "GMT", "PST" of this time zone.
const TDesC & aShortDaylightName	The short daylight saving time name for instance "BST", "PDT" of this time zone.

NewLC(const TTzLocalizedId &, const TDesC &, const TDesC &, const TDesC &, const TDesC &)

CTzLocalizedTimeZone *	NewLC	(	const TTzLocalizedId &	aTzLocalizedId,
			const TDesC &	aStandardName,
			const TDesC &	aDaylightName,
			const TDesC &	aShortStandardName,
			const TDesC &	aShortDaylightName
		)	[static]

Two phase Symbian constructor.

Parameters

const TTzLocalizedId & aTzLocalizedId	Contains the time zone ID and resource ID for this time zone.
const TDesC & aStandardName	The standard name of the time zone, for instance "Greenwich Mean Time", "Pacific Standard Time".
const TDesC & aDaylightName	The daylight saving time name, for instance "British Summer Time", "Pacific Daylight Time" of this time zone.
const TDesC & aShortStandardName	The short standard name, for instance "GMT", "PST" of this time zone.
const TDesC & aShortDaylightName	The short daylight saving time name for instance "BST", "PDT" of this time zone.

SetUTCOffset(TInt)

void

SetUTCOffset

(

TInt

aUTCoffset

)

Sets the UTC offset for this time zone (in minutes)

Parameters

TInt aUTCoffset

UTC offset in minutes for this time zone.

ShortDaylightName()

IMPORT_C TPtrC

ShortDaylightName

(

)

const

Returns this time zone's short daylight saving time name, for instance "BST", "PDT".

ShortStandardName()

IMPORT_C TPtrC

ShortStandardName

(

)

const

Returns this time zone's short standard name, for instance "GMT", "PST".

StandardName()

IMPORT_C TPtrC

StandardName

(

)

const

Returns this time zone's standard name, for instance "Greenwich Mean Time", "Pacific Standard Time".

TimeZoneId()

IMPORT_C TUint16

TimeZoneId

(

)

const

Returns the time zone ID.

TzLocalizedId()

TTzLocalizedId

TzLocalizedId

(

)

const

Returns this time zone's TTzLocalizedId. Cannot be inline, as it is for internal use only.

UTCOffset()

TInt

UTCOffset

(

)

const

Returns the UTC offset for this time zone. This is for internal sorting use only. A more accurate offset can be obtained from Tz by using the time zone id stored in iTzLocalizedId

Member Enumerations Documentation

Enum TTzFrequentlyUsedZone

Flags to identify a cached zone.

Enumerators

ECurrentZone	The current zone.
EHomeZone	The home zone.
EInterestZone	The zone of interest.
ERecentZone1	The first recently-used zone.
ERecentZone2	The second recently-used zone.
ECachedTimeZones	Specifies the number of cached zones. Not to be used as an API argument.

Member Data Documentation

HBufC * iDaylightName

HBufC *

iDaylightName

[private]

HBufC * iShortDaylightName

HBufC *

iShortDaylightName

[private]

HBufC * iShortStandardName

HBufC *

iShortStandardName

[private]

HBufC * iStandardName

HBufC *

iStandardName

[private]

TTzLocalizedId iTzLocalizedId

TTzLocalizedId

iTzLocalizedId

[private]

TInt iUTCOffset

TInt

iUTCOffset

[private]

When sorting arrays in UTC order the UTC offset is stored here. It is expressed in minutes. This value should only be used for this purpose.