CTzLocalizedCity Class Reference

#include <mw/tzlocalizationdatatypes.h>

Link against: timezonelocalization.lib

class CTzLocalizedCity : public CBase

Inherits from

  • CTzLocalizedCity

    Detailed Description

    Encapsulates a localized (exemplar) city.

    Constructor & Destructor Documentation

    ~CTzLocalizedCity ( )

    ~CTzLocalizedCity()

    Destructor

    Member Function Documentation

    CityIndex ( )

    TInt CityIndex()const

    GroupId ( )

    IMPORT_C TUint8GroupId()const

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

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

    Name ( )

    IMPORT_C TPtrCName()const

    Returns the name of the city.

    Returns: The name of the city.

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

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

    Two phase Symbian constructor.

    ParameterDescription
    aNameThe name of the city.
    aTzLocalizedIdContains the time zone ID and resource ID for this city.
    aGroupIdThe group that this city belongs to. This defaults to zero.

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

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

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

    Two phase Symbian constructor.

    ParameterDescription
    aNameThe name of the city.
    aTzLocalizedIdContains the time zone ID and resource ID for this city.
    aGroupIdThe group that this city belongs to. This defaults to zero.

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

    SetCityIndex ( TInt )

    voidSetCityIndex(TIntaIndex)

    SetUTCOffset ( TInt )

    voidSetUTCOffset(TIntaUTCoffset)

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

    ParameterDescription
    aUTCoffsetUTC offset in minutes for this time zone.

    TimeZoneId ( )

    IMPORT_C TUint16TimeZoneId()const

    Returns the city's time zone ID.

    Returns: The time zone ID.

    TzLocalizedId ( )

    TTzLocalizedId TzLocalizedId()const

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

    Returns: The TTzLocalizedId of this city.

    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.

    Returns: TInt representing UTC offset (in minutes).