diff -r 2fe1408b6811 -r e1b950c65cb4 epoc32/include/mw/vtzrules.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/epoc32/include/mw/vtzrules.h Wed Mar 31 12:27:01 2010 +0100 @@ -0,0 +1,187 @@ +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// 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 +// which accompanies this distribution, and is available +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// + +#ifndef __VTZRULES_H__ +#define __VTZRULES_H__ + +#include +#include +#include +#include + +class CVTzActualisedRules; +class TVTzActualisedRule; + +const TInt KVTzRulesGranularity = 4; + +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Time zone rules + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/** +Encapsulates one time zone rule. + +@publishedAll +@released +*/ +class TTzRule + { +public: + IMPORT_C TTzRule(TInt16 aFromYear, TInt16 aToYear, TInt16 aOldOffset, TInt16 aNewOffset, TMonth aMonth, TTzRuleDay aDayRule, + TUint8 aDayOfMonth, TUint8 aDayOfWeek, TTzTimeReference aTimeReference, TUint16 aTimeOfChange); + IMPORT_C TTzRule(); + IMPORT_C TTzRule(const TTzRule& aRule); + IMPORT_C TTzRule(TTimeWithReference aFromYear, TTimeWithReference aToYear, TInt16 aOldOffset, TInt16 aNewOffset, TMonth aMonth, TTzRuleDay aDayRule, + TUint8 aDayOfMonth, TUint8 aDayOfWeek, TTzTimeReference aTimeReference, TUint16 aTimeOfChange); + + + void ExternalizeL(RWriteStream& aStream) const; + void InternalizeL(RReadStream& aStream); + TBool RuleApplies(const TTime& aStart, const TTime& aEnd) const; + + IMPORT_C TVTzActualisedRule Actualise(TInt aYear) const; // deprecated, replace by the L version + IMPORT_C TVTzActualisedRule ActualiseL(TInt aYear) const; + +public: + TTimeWithReference iFrom; // first date the rule applies + TTimeWithReference iTo; // last date the rule applies + TInt16 iOldLocalTimeOffset; // local time offset (in minutes) BEFORE the change (local time = UTC + DST) + TInt16 iNewLocalTimeOffset; // local time offset (in minutes) AFTER the change + TMonth iMonth; + TTzRuleDay iDayRule; // format in which the rule is expressed + TUint8 iDayOfMonth; + TUint8 iDayOfWeek; + TTzTimeReference iTimeReference; + TUint16 iTimeOfChange; // number of minutes since midnight + TUint32 iReserved; + }; + + + +/** +Encapsulates a collection of time zone rules, and includes the period covered by the rules +and the standard time offset at the start of that period. + +@publishedAll +@released +*/ +class CTzRules : public CBase + { +public: + IMPORT_C static CTzRules* NewL(); + IMPORT_C static CTzRules* NewL(TInt aStartYear, TInt aEndYear); + IMPORT_C static CTzRules* NewL(RReadStream& aStream); + IMPORT_C ~CTzRules(); + IMPORT_C TBool RulesApply(const TTime& aTime) const; + IMPORT_C void AddRuleL(TTzRule aRule); + IMPORT_C void RemoveRule(TInt aIndex); + IMPORT_C TTzRule& operator[](TInt aIndex); + IMPORT_C TInt Count() const; + IMPORT_C TInt StartYear() const; + IMPORT_C TInt EndYear() const; + IMPORT_C void SetStartYear(TInt aYear); + IMPORT_C void SetEndYear(TInt aYear); + IMPORT_C void ExternalizeL(RWriteStream& aStream) const; + IMPORT_C void InternalizeL(RReadStream& aStream); + IMPORT_C TInt InitialStdTimeOffset() const; + IMPORT_C void SetInitialStdTimeOffset(TInt aOffset); + IMPORT_C void ConvertToUtcL(TTime& aLocalTime) const; + IMPORT_C void ConvertToLocalL(TTime& aUtcTime) const; + IMPORT_C CTzRules* CloneL() const; + IMPORT_C TBool IsEqualTo(const CTzRules& aRules) const; + + IMPORT_C void GetActualisedRulesL(CVTzActualisedRules& aActRules) const; + IMPORT_C TInt ConvertTime(CVTzActualisedRules& aRules, TTime& aTime, TTzTimeReference aTimerRef) const; + +private: + CTzRules(); + CTzRules(TInt aStartYear, TInt aEndYear); + void GetActualisedRulesL(CVTzActualisedRules& aActRules, TInt aYear) const; + TInt GetOffsetL(const TTime& aTime, TTzTimeReference aTimeRef) const; + TInt AddActualisedRulesL(CVTzActualisedRules& aActRules, TInt aYear) const; + TInt CompareTimesWithRef(TTime aTimeA, TTzTimeReference aTimeARef, + TTime aTimeB, TTzTimeReference aTimeBRef, TInt aStdOffset, TInt aWallOffset, + TTimeIntervalMinutes* aMinutesDifference) const; + +private: + TInt16 iStartYear; + TInt16 iEndYear; + RArray iRules; + TInt iInitialStdTimeOffset; + }; + + + +/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * + * Actualised time zone rules + * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ + +/** +Encapsulates a local time change. + +@publishedAll +@released +*/ +class TVTzActualisedRule + { +public: + IMPORT_C TVTzActualisedRule(TTime aTimeOfChange, TInt aNewOffset, TTzTimeReference aTimeReference); + IMPORT_C TVTzActualisedRule(); + + IMPORT_C void operator=(TVTzActualisedRule aRule); + static TInt Order(const TVTzActualisedRule& aLeft, const TVTzActualisedRule& aRight); + +public: + TTime iTimeOfChange; + TInt32 iNewOffset; + TTzTimeReference iTimeReference; + }; + + +/** +Encapsulates a collection of the local time changes occurring during a range of years. + +@publishedAll +@released +*/ +NONSHARABLE_CLASS(CVTzActualisedRules) : public CBase + { +public: + IMPORT_C static CVTzActualisedRules* NewL(TInt aStartYear, TInt aEndYear); + IMPORT_C ~CVTzActualisedRules(); + IMPORT_C void AddRuleL(const TVTzActualisedRule& aRule); + IMPORT_C TInt Count() const; + IMPORT_C TVTzActualisedRule& operator[](TInt aIndex) const; + + IMPORT_C TInt StartYear() const; + IMPORT_C TInt EndYear() const; + + IMPORT_C TBool IsDaylightSavingOn(TTime& aTime) const; + IMPORT_C TInt GetOffsetFromRuleL(const TTime& aTime, TTzTimeReference aTimeRef) const; + +private: + CVTzActualisedRules(TInt aStartYear, TInt aEndYear); + CVTzActualisedRules(); + TInt CompareTimesWithRef(TTime aRolloverTime, TTzTimeReference aTimeRefRollover, + TTime aUserTime, TTzTimeReference aTimeRefUser, + TInt aOldWallOffset, TTimeIntervalMinutes& aDiffMinutes) const; + +private: + TInt32 iStartYear; // years covered by + TInt32 iEndYear; // the actualised rules + RArray iRules; + }; + +#endif