CTzLocalizedCity Class Reference

class CTzLocalizedCity : public CBase

Encapsulates a localized (exemplar) city.

Inherits from

Constructor & Destructor Documentation

CTzLocalizedCity(const TUint8, const TTzLocalizedId &)

CTzLocalizedCity ( const TUint8 aGroupId,
const TTzLocalizedId & aTzLocalizedId
) [private]

Constructor.

Parameters

const TUint8 aGroupId The ID of the group that this city belongs to.
const TTzLocalizedId & aTzLocalizedId Contains the timezone ID and resource ID for this city.

~CTzLocalizedCity()

~CTzLocalizedCity ( )

Destructor

Member Functions Documentation

CityIndex()

TInt CityIndex ( ) const

ConstructL(const TDesC &)

void ConstructL ( const TDesC & aName ) [private]

Second Phase constructor.

Parameters

const TDesC & aName The city name.

GroupId()

IMPORT_C TUint8 GroupId ( ) const

Returns the ID of the group to which the city belongs.

Name()

IMPORT_C TPtrC Name ( ) const

Returns the name of the city.

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

CTzLocalizedCity * NewL ( const TDesC & aName,
const TTzLocalizedId & aTzLocalizedId,
const TUint8 aGroupId = 0
) [static]

Two phase Symbian constructor.

Parameters

const TDesC & aName The name of the city.
const TTzLocalizedId & aTzLocalizedId Contains the time zone ID and resource ID for this city.
const TUint8 aGroupId = 0 The group that this city belongs to. This defaults to zero.

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

CTzLocalizedCity * NewLC ( const TDesC & aName,
const TTzLocalizedId & aTzLocalizedId,
const TUint8 aGroupId = 0
) [static]

Two phase Symbian constructor.

Parameters

const TDesC & aName The name of the city.
const TTzLocalizedId & aTzLocalizedId Contains the time zone ID and resource ID for this city.
const TUint8 aGroupId = 0 The group that this city belongs to. This defaults to zero.

SetCityIndex(TInt)

void SetCityIndex ( TInt aIndex )

Parameters

TInt aIndex

SetUTCOffset(TInt)

void SetUTCOffset ( TInt aUTCoffset )

Sets the UTC offset for this city (in minutes).

Parameters

TInt aUTCoffset UTC offset in minutes for this time zone.

TimeZoneId()

IMPORT_C TUint16 TimeZoneId ( ) const

Returns the city's time zone ID.

TzLocalizedId()

TTzLocalizedId TzLocalizedId ( ) const

Returns the TTzLocalizedId of this city. Cannot be inline, as it is for internal use only.

UTCOffset()

TInt UTCOffset ( ) const

Returns the UTC offset for this city. 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 Data Documentation

TInt iCityIndex

TInt iCityIndex [private]

TUint8 iGroupId

TUint8 iGroupId [private]

HBufC * iName

HBufC * iName [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.