/*

* Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). 

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description:   This is the header file for the CClkDateTimeView class.

*

*/

#ifndef __CLK_DATETIMEVIEW_H__

#define __CLK_DATETIMEVIEW_H__

// System includes

#include <aknview.h>

#include <e32def.h>

#include <eiklbx.h>

#include <aknlists.h>

#include <coecntrl.h>

#include <eiklbo.h>

#include <bacntf.h>

#include <ConeResLoader.h>

#include <tzlocalizationdatatypes.h>

// User includes

#include "clkmdlobserver.h"

// Constants

const TInt KMaxItemLength( 128 );

const TInt KMaxValueLength( 64 );

const TInt KNotiferPriority( CActive::EPriorityIdle );

const TUid KMainViewId = { 1 };

const TUid KClkDateTimeViewId = { 10 };

// Forward declaration 

class CClockAppUi;

// Literals

_LIT( KRESOURCE, "z:\\resource\\apps\\clock.rsc" );

_LIT( KHardCodedAlarmTone, "z:\\resource\\sounds\\simple\\clock.rng" );		// Unused variables but kept to preserve BC.

/**

* @class TClkDateTimeInfo

* @brief Class containing date and time information.

*/

class TClkDateTimeInfo

    {

    public:         // Data

		/**

		* @var iTime

		* @brief The time.

		*/

        TTime					iTime;

		/**

		* @var iDateFormat

		* @brief The current date format.

		*/

        TDateFormat				iDateFormat;

		/**

		* @var iDateSepar

		* @brief The current date separator.

		*/

        TInt					iDateSepar;

		/**

		* @var iTimeFormat

		* @brief The current time format.

		*/

        TTimeFormat				iTimeFormat;

		/**

		* @var iTimeSepar

		* @brief The current time separator.

		*/

        TInt					iTimeSepar;

		/**

		* @var iClockFormat

		* @brief The current clock format.

		*/

        TClockFormat			iClockFormat;

		/**

		* @var iGMTOffset

		* @brief The current gmt offset.

		*/

        TTimeIntervalSeconds	iGMTOffset;

		/**

		* @var iNITZ

		* @brief Holds the Nitz plugin state.

		*/

		TBool					iNITZ;

    };

/**

* @enum TClkDateTimeViewPanic

* @brief The CClkDateTimeView panic codes.

*/

enum TClkDateTimeViewPanic

    {

    EClkDateTimeViewBadLocale,

    EClkDateTimeViewBadCommandId,

    EClkDateTimeViewBadItemIndex

    };

#ifdef _DEBUG

// Function prototypes

GLREF_C void Panic( TClkDateTimeViewPanic aPanic );

#endif 			// _DEBUG

// Forward declarations

class CClkDateTimeViewContainer;

class CClkUiClkSrvModel;

class CClkUiMdlIntermediateObserver;

class CEnvironmentChangeNotifier;

class CDRMHelper;

class CClkDateTimeViewExtension;

class RConeResourceLoader;

class CTzId;

// Class declaration

/**

* @class CClkDateTimeView

* @brief Common "Date & Time" settings view class. This is a dynamic link library which,

*	     provides APIs for using the common Date and Time Settings view. 

*	     The Clock and General Settings applications make use of this.

* @dll clkdatetimeview.dll

*/

class CClkDateTimeView : public CAknView,  

    					 public MEikListBoxObserver, 

    					 public MClkModelObserver

    {

    public:			// Constructors and destructor

		/**

		* @brief Two-phased constructor, returned value is also kept on the CleanupStack        

		* @param aViewId Id of a view which is changed to,

		*                  		 when Back softkey is pressed. It is ignored when aClockUse is ETrue.

		* @param aClockUse ETrue means Clock application uses this.

		*                   	    EFalse means any application except Clock uses this.

		* @return CClkDateTimeView* Constructed CClkDateTimeView object.

		*/

        IMPORT_C static CClkDateTimeView* NewLC( TUid aViewId, TBool aClockUse = EFalse );

		/**

		* Destructor.

		*/

        IMPORT_C ~CClkDateTimeView();

    public:			// Functions from base classes

		/**

		* @brief From CAknView. Returns this view Id.

		* @return TUid  The view id.

		*/

        TUid Id() const;

		/**

		* @brief From MEikCommandObserver. Handles commands.

		* @param aCommandId It is the value of the command to be handled in the setting.

		*/

        void HandleCommandL( TInt aCommandId );

		/**

		* @brief From MClkModelObserver. Called when the model is changed.

		* @param aNotification The cause of the notification.

		*/

        void HandleUpdateL( TInt aNotification );

		/**

		* @brief From CCoeAppUi. Called when the application switches from foreground to background and vice versa.

		* @param aForeground ETrue if foreground, EFalse if sent to background.

		*/

		void HandleForegroundEventL( TBool aForeground );

		/**

		* @brief From MEikMenuObserver.  Intialize the menu dynamically.	

		* @param aResourceId The resource id for the option popup menu

		* @param aMenuPane The dynamic menupane to delete the help cmd from the menu         

		*/

        void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane );

    public:			// New functions

		/**

		* @brief Moves the current item to the top of the list items.

		*/

        IMPORT_C void InitCurrentItem();

		/**

		* @brief Handle options changed by system.

		* @param aChange It indicates a cause of the change.

		*/

        void HandleSettingsChangeL( const TInt aChange );

		/**

		* @brief Increments the current list item to handle the task swapping event.

		*/

        void IncCurrentItem();

		/**

		* @brief Decrements the current list item to handle the task swapping event.

		*/

        void DecCurrentItem();

		/**

		* @brief Gets a flag meaning that Clock application is using.

		* @return ETrue means the ClockApp uses this object.

		*         EFalse means the ClockApp doesn't use this object.

		*/

        TBool IsClockInUse() const;

		/**

		* @brief Gets a previous view id.

		* @return TVwsViewId

		*/

        TVwsViewId PrevViewId() const;

		/**

		* @brief Handles a softkey event "Change".

		* @param aItemId The current item id of the settings list box.

		*/

        void HandleChangeCmdL(const TInt aItemId);

		/**

		* @brief When an alarm tone / snooze time is changed , through general settings, it gets updated in the clock settings.

		* @param aId Id which has changed

		* @param aNewValue Update cenrep value

		*/

		void UpdateDTViewL( TUint32 aId, const TDesC16& aNewValue );

		/**

		* @brief Returns the string "Off" when aStrVal is EFalse and string "On" when aStrVal is ETrue. 

		* Called from extension when the automatic time update page has to be modified dynamically.

		* @param aStrVal

		* @return The string containing the value "Off"

		*/

		HBufC& GetAutoTimeUpdateStr( TBool aStrVal );

		/**

		* @brief Returns the application's appui.

		* @return CClockAppUi The pointer to the clock application ui.

		*/

		CClockAppUi* ClockApplicationUi();

		protected:			// Functions from base classes

		/**

		* @brief From CAknView. Activates this view.

		* @param aPrevViewId The view id for the view from where the date time view setting called.

		* @param aCustomMessageId Not used for the implementation.

		* @param aCustomMessage Not used for the implementation.

		*/

        void DoActivateL( const TVwsViewId& aPrevViewId, TUid aCustomMessageId, const TDesC8& aCustomMessage );

		/**

		* @brief From CAknView.Deactivates this view.

		*/

        void DoDeactivate();

		/**

		* @brief From MEikListBoxObserver. Handles an event happend in aListBox.

		* @param aListBox The pointer to the ListBox in date time setting view.

		* @param aEventType The type of the event on the ListBox.

		*/

        void HandleListBoxEventL( CEikListBox* aListBox, TListBoxEvent aEventType );

	protected:			// New functions

		/**

		* @brief Performs the 2nd phase of two-phase construction.

		* @param aViewId Id of a view which is changed to, when Back softkey is pressed. It is ignored when aClockUse is ETrue.

		* @param aClockUse ETrue means Clock application uses. EFalse means any application except Clock uses.

		*/

        void ConstructL( TUid aViewId, TBool aClockUse );

    private:			// New functions

		/**

		* @brief Returns the index of the country.

		* @param aGroupId The groupid of the selected city.

		* @param aCountryList Pointer to the list of the Countries.

		* @return TInt The index of the country in the list box for a given group id.

		*/

    	TInt IndexOfCountry( TInt aGroupId, CTzLocalizedCityGroupArray* aCountryList );

		/**

		* @brief Reads the resources for settings list.        

		*/

        void GetResourcesL();

		/**

		* @brief Makes the list box items.

		*/

        void PopulateListBoxL();

		/**

		* @brief Updates the list box items.

		* @param aItemId An item id of the listbox.

		*/

        void UpdateListBoxL(TInt aItemId);

		/**

		* @brief Updates all items.

		*/

        void UpdateAllL();

		/**

		* @brief Updates the date and the time.

		* @param aTime The new time.

		* @return error code

		*/

        TInt SetDateTimeL(TTime& aTime);

		/**

		* @brief Updates the Workdays values.

		*/

		void SetWorkDays();

		/**

		* @brief Updates the date format.

		*/

        void SetDateFormat();

		/**

		* @brief Updates the date separator.

		*/

        void SetDateSeparator();

		/**

		* @brief Updates the time format.

		*/

        void SetTimeFormat();

		/**

		* @brief Updates the time format.

		*/

        void SetTimeSeparator();

		/**

		* @brief Updates the clock type.

		*/

        void SetClockType();

		/**

		* @brief Gets the currently active protocol.

		*/

        void GetActiveProtocolL();

		/**

		* @brief Gets the device's setting values.

		*/

        void SettingsL();

		/**

		* @brief Makes the date item in the list box.

		*/

        void MakeDateItemL();

		/**

		* @brief Makes the time zone item in the list box.

		*/

		void MakeZoneItemL();

		/**

		* @brief Makes the date format item in the list box.

		*/

        void MakeDateFormatItem();

		/**

		* @brief Makes the date separator item in the list box.

		*/

        void MakeDateSeparItem();

		/**

		* @brief Makes the time item in the list box.

		*/

        void MakeTimeItemL();

		/**

		* @brief Makes the time format item in the list box.

		*/

        void MakeTimeFormatItem();

		/**

		* @brief Makes the time separator item in the list box.

		*/

        void MakeTimeSeparItem();

		/**

		* @brief Makes the automatic time update setting item in the list box.

		*/

        void MakeAutomaticTimeUpdateItem();

		/**

		* @brief Makes the Workdays item in the list box.

		*/

		void MakeWorkDaysItemL();

		/**

		* @brief Makes the clock control type item in the list box.

		*/

        void MakeClockTypeItem();

		/**

		* @brief Makes the clock alarm tone item in the list box.

		*/

        void MakeClockAlarmToneItem();

		/**

		* @brief Makes the clock snooze time item in the list box.

		*/

		void MakeClockSnoozeTimeItemL();

		/**

		* @brief Deletes the buffers used for the list box resources.

		*/

        void DeleteResourceBuf();

		/**

		* @brief Gets the date format of the device.

		* @return TInt The enum const for respective dateformat

		*/

        TInt DateFmt();

		/**

		* @brief Handles a back softkey command.

		*/

        void HandleBackCmdL();

		/**

		* @brief Handles a Workdays command.

		*/        

		void HandleWorkDaysCmdL();

		/**

		* @brief Handles a date command.

		*/

        void HandleDateCmdL();

		/**

		* @brief Handles a date format command.

		*/

        void HandleDateFrmtCmdL();

		/**

		* @brief Handles a date separator command.

		*/

        void HandleDateSeparCmdL();

		/**

		* @brief Handles a time command.

		*/

        void HandleTimeCmdL();

		/**

		* @brief Handles a zone command.

		*/

		void HandleZoneCmdL();

		/**

		* @brief Handles a time format command.

		*/

        void HandleTimeFrmtCmdL();

		/**

		* @brief Handles a time separator command.

		*/

        void HandleTimeSeparCmdL();

		/**

		* @brief Handles the automatic time update command.

		* @param aDraw ETrue means this redraws the time update item.

		*              EFalse means this doesn't redraw the time update item.

		*/

        void HandleAutomaticTimeUpdateCmdL( TBool aDraw = ETrue );

		/**

		* @brief Handles a clock type command.

		*/

        void HandleClockTypeCmdL();

		/**

		* @brief opens file list resource reader.

		* @param aResourceLoader Used to open the required resource file

		*/

		void OpenFileListResourceLC( RConeResourceLoader& aResourceLoader );

		/**

		* @brief Handles a clock alarm tone command.

		*/

        void HandleClockAlarmToneCmdL();

		/**

		* @brief Handles a clock alarm snooze command.

		*/

		void HandleClockSnoozeTimeCmdL();

		/**

		* @brief Shows a popup setting page.

		* @param aItemArray containing setting items.

		* @param aIndex an index of initial item.

		* @param aLabel a text of label.

		* @return an index of selected item.

		*/

        TInt QueryPopupSettingPageL( CDesCArray& aItemArray, TInt aIndex, const TDesC& aLabel );

		/**

		* @brief Callback when enviroment changed.

		* @param aThis This class.

		* @return TInt ETRUE or EFALSE

		*/

        static TInt DoNotiferCallbackL( TAny* aThis );

		/**

		* @brief Displays confirmation note saying Automatic time update will be switched off.

		*/

        void ShowAutomaticTimeUpdateOffNoteL();