williamr@2: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@2: // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: // which accompanies this distribution, and is available williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // williamr@2: williamr@2: #ifndef __TzLocalizer_H__ williamr@2: #define __TzLocalizer_H__ williamr@2: williamr@2: #include //CBase williamr@2: williamr@2: #include //CTzLocalizedCity, CTzLocalizedCityGroup etc williamr@2: williamr@2: // Forward Declarations williamr@2: class MTzLocalizationReader; williamr@2: class MTzLocalizationWriter; williamr@2: williamr@2: /** williamr@2: Retrieves localized time zone information based on a time zone ID. williamr@2: williamr@2: Time zone information is available in the following forms: williamr@2: - Standard Name, for instance Greenwich Mean Time, williamr@2: - Short Standard Name, for instance GMT, williamr@2: - Daylight Savings Name, for instance British Summer Time, williamr@2: - Short Daylight Savings Name, for instance BST. williamr@2: williamr@2: This information is encapsulated in a CTzLocalizedTimeZone object. williamr@2: williamr@2: A collection of localizable cities for a specific time zone can also be returned. williamr@2: New cities can be added to a time zone. Cities may also be added to groups, but williamr@2: a city may only be a member of one group. williamr@2: williamr@2: @publishedAll williamr@2: @released williamr@2: */ williamr@2: class CTzLocalizer : public CBase williamr@2: { williamr@2: public: williamr@2: /** Panic reasons for the time zone localization component. */ williamr@2: enum TTzLocalizerPanics williamr@2: { williamr@2: /** The time zone server was not found. */ williamr@2: ETzLocalizerPanicTimeZoneServerNotFound, williamr@2: /** A resource file was not found. */ williamr@2: ETzLocalizerPanicResourceFileNotFound williamr@2: }; williamr@2: williamr@2: /** Used to specify the sort order of localized time zone information. */ williamr@2: enum TTzSortOrder williamr@2: { williamr@2: /** Unsorted. This is the fastest way to get localized data. */ williamr@2: ETzUnsorted, williamr@2: /** Sort by UTC offset starting with the lowest. */ williamr@2: ETzUTCAscending, williamr@2: /** Sort by UTC offset starting with the highest. */ williamr@2: ETzUTCDescending, williamr@2: /** Sort by name (city name/group name/standard time zone name), from A-Z. */ williamr@2: ETzAlphaNameAscending, williamr@2: /** Sort by name (city name/group name/standard time zone name), from Z-A. */ williamr@2: ETzAlphaNameDescending, williamr@2: /** Sort by standard name from A-Z. */ williamr@2: ETzAlphaStandardNameAscending, williamr@2: /** Sort by daylight savings name from A-Z. */ williamr@2: ETzAlphaDaylightNameAscending, williamr@2: /** Sort by short standard name from A-Z. */ williamr@2: ETzAlphaShortStandardNameAscending, williamr@2: /** Sort by short daylight savings name from A-Z. */ williamr@2: ETzAlphaShortDaylightNameAscending, williamr@2: /** Sort by standard name from Z-A. */ williamr@2: ETzAlphaStandardNameDescending, williamr@2: /** Sort by daylight savings name from Z-A. */ williamr@2: ETzAlphaDaylightNameDescending, williamr@2: /** Sort by short standard name from Z-A. */ williamr@2: ETzAlphaShortStandardNameDescending, williamr@2: /** Sort by short daylight savings name from Z-A. */ williamr@2: ETzAlphaShortDaylightNameDescending williamr@2: }; williamr@2: williamr@2: public: williamr@2: //Construction / Destruction williamr@2: IMPORT_C static CTzLocalizer* NewL(); williamr@2: IMPORT_C static CTzLocalizer* NewLC(); williamr@2: IMPORT_C ~CTzLocalizer(); williamr@2: williamr@2: //Time zones williamr@2: IMPORT_C CTzLocalizedTimeZone* GetLocalizedTimeZoneL(TInt aTimeZoneId) const; williamr@2: IMPORT_C CTzLocalizedTimeZone* GetLocalizedTimeZoneL(const CTzLocalizedCity& aCity) const; williamr@2: IMPORT_C CTzLocalizedTimeZoneArray* GetAllTimeZonesL(const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: williamr@2: IMPORT_C void SetTimeZoneL(TInt aTimeZoneId); williamr@2: williamr@2: //City Management williamr@2: IMPORT_C CTzLocalizedCity* GetDefaultCityL(TInt aTimeZoneId) const; williamr@2: IMPORT_C CTzLocalizedCity* GetDefaultCityL(const CTzLocalizedCity& aCity) const; williamr@2: IMPORT_C CTzLocalizedCity* GetDefaultCityL(const CTzLocalizedTimeZone& aTimeZone) const; williamr@2: williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesL(const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesL(TInt aTimeZoneId,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesL(const CTzLocalizedTimeZone& aTimeZone,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesL(const CTzLocalizedCity& aCity,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: williamr@2: IMPORT_C CTzLocalizedCity* AddCityL(TInt aTimeZoneId,const TDesC& aCityName, TInt aGroupId = 0); williamr@2: IMPORT_C void RemoveCityL(CTzLocalizedCity* aCity); williamr@2: williamr@2: //City Groups williamr@2: IMPORT_C CTzLocalizedCityGroupArray* GetAllCityGroupsL(const TTzSortOrder aSortOrder = ETzUnsorted) const; williamr@2: IMPORT_C CTzLocalizedCityGroup* GetCityGroupL(TInt aGroupId) const; williamr@2: IMPORT_C CTzLocalizedCityGroup* GetCityGroupL(const CTzLocalizedCity& aCity) const ; williamr@2: williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesInGroupL(TInt aGroupId,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesInGroupL(const CTzLocalizedCity& aCity,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesInGroupL(const CTzLocalizedCityGroup& aCityGroup,const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: williamr@2: //Frequently Used Zones williamr@2: IMPORT_C CTzLocalizedTimeZone* GetFrequentlyUsedZoneL(const CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFrequentlyUsedZone); williamr@2: IMPORT_C CTzLocalizedCity* GetFrequentlyUsedZoneCityL(const CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFrequentlyUsedZone); williamr@2: IMPORT_C void SetFrequentlyUsedZoneL(TInt aTimeZoneId,const CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFrequentlyUsedZone); williamr@2: IMPORT_C void SetFrequentlyUsedZoneL(const CTzLocalizedTimeZone& aTimeZone,const CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFrequentlyUsedZone); williamr@2: IMPORT_C void SetFrequentlyUsedZoneL(const CTzLocalizedCity& aCity,const CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFrequentlyUsedZone); williamr@2: williamr@2: //Find functions williamr@2: IMPORT_C CTzLocalizedCity* FindCityByNameL(const TDesC& aCityName, const TInt aTimeZoneId = 0); williamr@2: IMPORT_C CTzLocalizedTimeZone* FindTimeZoneByNameL(const TDesC& aTimeZoneName); williamr@2: IMPORT_C CTzLocalizedCityGroup* FindCityGroupByNameL(const TDesC& aCityGroupName); williamr@2: williamr@2: IMPORT_C TBool CheckLanguage(); williamr@2: williamr@2: //Cities and Time Zones with a specified UTC offset williamr@2: IMPORT_C CTzLocalizedCityArray* GetCitiesWithUTCOffsetL(TInt aUTCOffsetInMinutes, const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: IMPORT_C CTzLocalizedTimeZoneArray* GetTimeZonesWithUTCOffsetL(TInt aUTCOffsetInMinutes, const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: williamr@2: private: williamr@2: void ConstructL(); williamr@2: CTzLocalizer(); williamr@2: williamr@2: TBool PrepareFrequentlyUsedZonesL(); williamr@2: void UpdateFrequentlyUsedZonesL(); williamr@2: CTzLocalizedTimeZone* GetFrequentlyUsedDefaultZoneL(CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFreqUsedZone); williamr@2: TUint32 GetFrequentlyUsedDefaultZoneCenRepKeyL(CTzLocalizedTimeZone::TTzFrequentlyUsedZone aFreqUsedZone); williamr@2: williamr@2: void GetCitiesL(CTzLocalizedCityArray& aCities, const TTzLocalizedId& aLocalizedId, const TTzSortOrder aSortOrder = ETzUnsorted); williamr@2: williamr@2: TLinearOrder CitySortOrderL(const TTzSortOrder aSortOrder); williamr@2: TLinearOrder TimeZoneSortOrderL(const TTzSortOrder aSortOrder); williamr@2: template void PrepareForUTCSortL(T& aArray); williamr@2: williamr@2: TInt GetTimeZoneIdFromTzServerL(); williamr@2: void DoSetTimeZoneL(TInt aTimeZoneId); williamr@2: void ChangeHomeTimeZoneL(TInt aNewId); williamr@2: williamr@2: void ValidateDbL(); williamr@2: void RecreateDbL(); williamr@2: TBool DbNeedsUpdatingL() const; williamr@2: TBool DbIsInvalidL() const; williamr@2: void UpgradeDbVersionL(); williamr@2: void FetchCityToUpgradeL(CTzLocalizedTimeZoneArray& aTimeZoneArray, CTzLocalizedCityArray& aCityArray, CTzLocalizedTimeZone::TTzFrequentlyUsedZone aCachedZone); williamr@2: williamr@2: private: williamr@2: //Member data williamr@2: MTzLocalizationReader* iStaticDataReader; williamr@2: MTzLocalizationReader* iPersistedDataReader; williamr@2: MTzLocalizationWriter* iPersistedDataWriter; williamr@2: TLanguage iLanguage; williamr@2: }; williamr@2: williamr@2: #endif//__TzLocalizer_H__