telephonyserverplugins/simatktsy/inc/CSatNotifySetUpMenu.h
changeset 0 3553901f7fa8
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/telephonyserverplugins/simatktsy/inc/CSatNotifySetUpMenu.h	Tue Feb 02 01:41:59 2010 +0200
@@ -0,0 +1,145 @@
+/*
+* 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 "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:
+* Name        : CSatNotifySetUpMenu.h
+* Part of     : Common SIM ATK TSY / commonsimatktsy
+* Specific notifications class
+* Version     : 1.0
+*
+*/
+
+
+
+#ifndef CSATNOTIFYSETUPMENU_H
+#define CSATNOTIFYSETUPMENU_H
+
+
+//  INCLUDES
+#include <etelsat.h>
+#include "MSatNotificationsBase.h"
+
+// FORWARD DECLARATIONS
+class CSatDataPackage;
+class CSatNotificationsTsy;
+
+/**
+* DESCRIPTION
+* SAT Setup Menu notification class.
+* Created when client requests to be notified when Setup Menu
+* command arrives from SIM.
+*
+* The SIM shall supply a set of menu items, which shall be used as
+* a main menu in SAT application. The user has then the opportunity
+* to choose one of these menu items at his own discretion.
+* Each item comprises a short identifier (used to indicate the selection)
+* and a text string. Also an Alpha identifier is supplied which acts as
+* a title for the list of menu items.
+* @lib Commonsimatktsy
+* @since 3.1
+*/
+NONSHARABLE_CLASS ( CSatNotifySetUpMenu ) : public CBase,
+                           public MSatNotificationsBase
+    {
+    public:   // Constructors and destructor
+        
+        /**
+        * Two-phased constructor.
+        * @param aNotificationsTsy: Pointer to NotificationsTsy
+        * return CSatNotifySetUpMenu*: created object 
+        */
+        static CSatNotifySetUpMenu* NewL( 
+        	CSatNotificationsTsy* aNotificationsTsy );
+
+        /**
+        * C++ Destructor.
+        */
+        ~CSatNotifySetUpMenu();
+
+	private:
+        /**
+        * By default C++ constructor is private.
+        * @param aNotificationsTsy: Pointer to NotificationsTsy
+        * @return None
+        */
+        CSatNotifySetUpMenu( CSatNotificationsTsy* aNotificationsTsy );
+
+        /**
+        * Class attributes are created in ConstructL. 
+        * @param None
+        * @return None
+        */
+        void ConstructL();
+
+    public: // Functions from base classes
+
+        /**
+        * Set Up Menu Notification request received from client
+        * @param aTsyReqHandle: request handle from ETel
+        * @param aPackage: Packed data
+        * @return KErrNone
+        */
+        TInt Notify( const TTsyReqHandle aTsyReqHandle,
+            const TDataPackage& aPackage );
+
+        /**
+        * Cancels notification request for Set Up Menu.
+        * @param aReqHandle notify request handle
+        * @return KErrNone
+        */
+        TInt CancelNotification( const TTsyReqHandle aReqHandle );
+                 
+        /**
+        * Completes Set Up Menu message to client
+        * @param aDataPackage: Packaged return data
+        * @param aErrorCode: Possible error code
+        * @return KErrNone/ KErrCorrupt
+        */
+        TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );
+
+
+        /**
+        * From CSatNotificationsBase handles Set Up Menu terminal response 
+        * coming from client.
+        * @param aRsp: Response structure
+        * @return KErrNone/ KErrCorrupt
+        */
+        TInt TerminalResponseL( TDes8* aRsp );
+
+	public: // New functions        
+	
+        /**
+        * Create notification specific terminal response data
+        * @param aPCmdNumber: Proactive command number
+        * @param aGeneralResult: Result of the proactive command
+        * @param aAdditionalInfo: Additional info for terminal response
+        * @return Success/Failure value
+        */
+        TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,
+            					 const TDesC16& aAdditionalInfo );  
+
+    private: // Data
+
+        // Package received from ETel
+        RSat::TSetUpMenuV2Pckg*     iSetUpMenuV2Pckg;
+        // Toolkit name
+        TBuf<RSat::KAlphaIdMaxSize> iToolKitName;
+        // Pointer to the notifications tsy class
+        CSatNotificationsTsy* iNotificationsTsy;
+        // Flag for items next indicator    
+        TBool iItemsNextIndicatorRemoved;
+
+    };
+
+
+#endif // CSATNOTIFYSETUPMENU_H
\ No newline at end of file