idlehomescreen/xmluicontroller/inc/onlineofflinehelper.h
branchRCL_3
changeset 83 5456b4e8b3a8
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/idlehomescreen/xmluicontroller/inc/onlineofflinehelper.h	Wed Sep 01 12:32:46 2010 +0100
@@ -0,0 +1,284 @@
+/*
+* Copyright (c) 2009-2010 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:  Helper for online/offline state handling
+*
+*/
+
+#ifndef ONLINEOFFLINEHELPER_H
+#define ONLINEOFFLINEHELPER_H
+
+#include <e32base.h>
+#include <NWHandlingEngine.h>
+#include <MProfileChangeObserver.h>
+#include <babitflags.h>
+#include <cmgenconnsettings.h>
+#include "cenrepobserver.h"
+
+// Forward declrations
+class CNWSession;
+class CProfileChangeNotifyHandler;
+class CXnNodeAppIf;
+class CAknGlobalConfirmationQuery;
+
+namespace AiXmlUiController
+{
+// Forward declrations
+class CXmlUiController;
+class CGlobalQueryHandler;
+// Classe declaration
+
+
+/**
+ * Online/offline state helper
+ *
+ * @ingroup group_aixmluimain
+ * @lib ai3xmluimain.lib
+ * @since S60 5.0
+ */
+
+class COnlineOfflineHelper : public CBase, 
+    public MNWMessageObserver, public MProfileChangeObserver, public MCenRepObserver
+    {    
+public:
+    // Constructors
+
+    /**
+     * Two-phased constructor.
+     */
+    static COnlineOfflineHelper* NewL( CXmlUiController& aUiCtl );
+    
+public:
+    // Destructor
+    
+    ~COnlineOfflineHelper();
+        
+private:
+    /*
+     * C++ default constructor
+     */
+    COnlineOfflineHelper( CXmlUiController& aUiCtl );
+    
+    /**
+     *  2nd phase constructor
+     */
+    void ConstructL();    
+
+public : 
+    // from MCenRepObserver
+
+    /**
+    * This method is called every time when Central Repository key 
+    * KCRUidCmManager/ KCurrentCellularDataUsage changes.
+    *
+    * @param aValue The new value for KCurrentCellularDataUsage.
+    * 
+    */
+    void CurrentCellularDataUsageChangedL( const TInt aValue );
+    
+public:
+    // New functions
+    
+    /*
+     * Determines if online menuitem can be shown
+     * 
+     * @since S60 5.0
+     * @return ETrue if item can be shown, EFalse otherwise
+     */
+    TBool ShowOnlineItem() const;
+
+    /*
+     * Determines if offline menuitem can be shown
+     * 
+     * @since S60 5.0
+     * @return ETrue if item can be shown, EFalse otherwise
+     */    
+    TBool ShowOfflineItem() const;
+    
+    /*
+     * Set online or offline state based on user selection
+     * 
+     * @since S60 5.0
+     * @param aOnline ETrue to set online, EFalse to offline 
+     */    
+    void ProcessOnlineStateL( TBool aOnline );
+    
+    /*
+     * Handles the connection query dialogs
+     * 
+     * @since S60 5.0
+     * @param aConnection connection disconnected or connected 
+     */ 
+    void HandleConnectionQueryL( const TDesC& aConnection);
+    
+    /**
+     * Displayes global query for 'go online' or 'go offline' confirmations
+     * @param aResourceId resource id for the text string
+     * @param aSetOnline if ETrue then set widgets online if confirmation accepted,
+     *     if EFalse then set widgets offline if confirmation accepted 
+     */
+    void ShowGlobalQueryL( TInt aResourceId, TBool aSetOnline );
+
+private:    
+    // from MNWMessageObserver
+
+    /**
+     * From MNWMessageObserver.
+     * Called by network handling engine when network info changes.
+     *
+     * @since S60 5.0
+     * @param aMessage is type of the change.
+     */
+    void HandleNetworkMessage( const TNWMessages aMessage );
+
+    /**
+     * From MNWMessageObserver.
+     * Called if network handling engine fails.
+     *
+     * @since S60 5.0
+     * @param aOperation is failed operation.
+     * @param aErrorCode is fail reason.
+     */
+    void HandleNetworkError( const TNWOperation aOperation, TInt aErrorCode );
+
+private:
+    // from MProfileChangeObserver
+
+    /**
+     * Called when active profile changes.
+     *
+     * @since S60 5.0
+     * @param aProfileEvent Profile event.
+     * @param aProfileId New profile id.
+     */
+    void HandleActiveProfileEventL( TProfileEvent aProfileEvent, TInt aProfileId );
+    
+private:
+    // New functions
+    
+    TBool HasNetworkInfoChanged( const TNWMessages aMsg );
+    void InterpretNWMessageL( const TNWMessages aMessage, const TNWInfo );
+    
+    void SetOnline( TBool aOnline );
+    
+    void CurrentNetworkSetting();
+    
+private:
+    // Data types
+    
+    /**
+     * Network related message flags
+     */    
+    enum TNetInfoFlags 
+        {
+        ENetworkProviderNameReceived        = 0x00000001,
+        ENetworkProviderNameOk              = 0x00000002,
+        EServiceProviderNameReceived        = 0x00000004,
+        EServiceProviderNameOk              = 0x00000008,
+        ERegistrationStatusReceived         = 0x00000010,
+        ENetworkInfoChangeReceived          = 0x00000020,
+        EProgrammableOperatorInfoReceived   = 0x00000040,
+        EProgrammableOperatorInfoReceivedOk = 0x00000080
+        };
+    
+    enum
+        {
+        // if defined Home Screen is in online mode.
+        EOnline,
+        // if defined there is no need to show automatic offline note 
+        // and automatic offline setting is disabled.
+        ERoamingShown,
+        // if defined phone profile is offline.
+        EOfflineProfile
+        };
+private: 
+    // data
+    
+    /**
+     * UI controller
+     * Not own
+     */    
+    CXmlUiController& iUiCtl;
+    
+    /**
+    * Session to network handling engine.
+    * Own.
+    */
+   CNWSession* iSession;
+
+   /**
+   * Profile change handler.
+   * Own.
+   */   
+   CProfileChangeNotifyHandler* iHandler;
+
+   /**
+    * Cached network info structure.
+    */
+   TNWInfo iInfo;
+   
+   /**
+    * Previous network information.
+    */
+   TNWInfo iOldInfo;
+
+   /**
+    * Subset of sum of TNetInfoFlags.
+    */    
+   TUint iReceivedMessageFlags;
+   
+   /**
+    * Subset of sum of old TNetInfoFlags.
+    */    
+   TUint iOldReceivedMessageFlags;
+   
+   /**
+    * current state of network
+    */    
+   TNWRegistrationStatus iCurrentNwStatus;
+
+   /**
+    * Flags
+    */
+   TBitFlags32 iFlags;
+   
+   /**
+    * Network setting observer, owned
+    */
+   CCenRepObserver *iNwSettingObserver;
+  
+   /**
+    * Home network setting
+    */
+   TInt iHomeNetwork;
+   
+   /**
+     * Roaming network setting
+     */
+   TInt iRoamingNetwork;
+   
+   /**
+    * Global query handler, owned.
+    */
+   CGlobalQueryHandler* iGlobalQueryHandler;
+   
+   /**
+    * Global confirmation query, owned.
+    */
+   CAknGlobalConfirmationQuery* iGlobalConfirmationQuery;
+
+   };
+
+}// namespace AiXmlUiController
+#endif //ONLINEOFFLINEHELPER_H
+