CTzLocalizedTimeZone Class Reference

#include <mw/tzlocalizationdatatypes.h>

Link against: timezonelocalization.lib

class CTzLocalizedTimeZone : public CBase

Inherits from

CTzLocalizedTimeZone

Public Member Enumerations
enum	TTzFrequentlyUsedZone { ECurrentZone, EHomeZone, EInterestZone, ERecentZone1, ..., ECachedTimeZones }

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

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

Detailed Description

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

Member Enumeration Documentation

Enum TTzFrequentlyUsedZone

Flags to identify a cached zone.

Enumerator	Value	Description
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.

Constructor & Destructor Documentation

~CTzLocalizedTimeZone ( )

~CTzLocalizedTimeZone

(

)

Destructor

Member Function Documentation

DaylightName ( )

IMPORT_C TPtrC

DaylightName

(

)

const

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

Returns: The daylight saving time name of this time zone.

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.

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

Returns: A pointer to a new instance of a localized time zone object.

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.

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

Returns: A pointer to a new instance of a localized time zone object that is left on the cleanup stack.

SetUTCOffset ( TInt )

void

SetUTCOffset

(

TInt

aUTCoffset

)

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

Parameter	Description
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".

Returns: The short daylight saving time name of this time zone.

ShortStandardName ( )

IMPORT_C TPtrC

ShortStandardName

(

)

const

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

Returns: The short standard name of this time zone.

StandardName ( )

IMPORT_C TPtrC

StandardName

(

)

const

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

Returns: The standard name of this time zone.

TimeZoneId ( )

IMPORT_C TUint16

TimeZoneId

(

)

const

Returns the time zone ID.

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.

Returns: The TTzLocalizedId of this time zone.

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

Returns: TInt representing UTC offset (in minutes)