1 /*

     2 * Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

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

     6 * which accompanies this distribution, and is available

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

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:

    15 * Name        : CSatNotifyDisplayText.h

    16 * Part of     : Common SIM ATK TSY / commonsimatktsy

    17 * Specific notifications class

    18 * Version     : 1.0

    19 *

    20 */

    21 

    22 

    23 

    24 #ifndef CSATNOTIFYDISPLAYTEXT_H

    25 #define CSATNOTIFYDISPLAYTEXT_H

    26 

    27 

    28 //  INCLUDES

    29 #include <etelsat.h>

    30 #include "MSatNotificationsBase.h"

    31 

    32 // FORWARD DECLARATIONS

    33 class CSatDataPackage;

    34 class CSatNotificationsTsy;

    35 

    36 /**

    37 * DESCRIPTION

    38 * SAT Display Text notification class.

    39 * Created when client requests to be notified when Display Text

    40 * command arrives from SIM.

    41 *

    42 * This command instructs the SAT to display a text message.

    43 * It allows SIM to define the priority of that message, 

    44 * and the text string format.

    45 * @lib Commonsimatktsy

    46 * @since 3.1

    47 */

    48 NONSHARABLE_CLASS ( CSatNotifyDisplayText ) : public CBase,

    49                               public MSatNotificationsBase

    50     {

    51     public:  // Constructors and destructor

    52 

    53         /**

    54         * Two-phased constructor.

    55         * @param aNotificationsTsy: Pointer to NotificationsTsy

    56         * return CSatNotifyDisplayText*: created object 

    57         */

    58         static CSatNotifyDisplayText* NewL( 

    59         	CSatNotificationsTsy* aNotificationsTsy );

    60 

    61         /**

    62         * C++ Destructor.

    63         */

    64         ~CSatNotifyDisplayText();

    65 

    66 	private:

    67         /**

    68         * By default C++ constructor is private.

    69         * @param aNotificationsTsy: Pointer to NotificationsTsy

    70         * @return None

    71         */

    72         CSatNotifyDisplayText( CSatNotificationsTsy* aNotificationsTsy );

    73 

    74         /**

    75         * Class attributes are created in ConstructL. 

    76         * @param None

    77         * @return None

    78         */

    79         void ConstructL();

    80 

    81     public: // Functions from base classes

    82                 

    83         /**

    84         * Notification request received from client

    85         * @param aTsyReqHandle: request handle from ETel

    86         * @param aPackage: Packed data

    87         * @return KErrNone

    88         */

    89         TInt Notify( const TTsyReqHandle aTsyReqHandle,

    90             const TDataPackage& aPackage );

    91 

    92         /**

    93         * Cancels notification request about display text change.

    94         * @param aReqHandle notify request handle

    95         * @return KErrNone

    96         */

    97         TInt CancelNotification( const TTsyReqHandle aReqHandle );

    98         

    99         /**

   100         * Completes the notification request received from client

   101         * @param aDataPackage: Packaged return data

   102         * @param aErrorCode: Possible error code

   103         * @return KErrNone/ KErrCorrupt

   104         */

   105         TInt CompleteNotifyL( CSatDataPackage* aDataPackage, TInt aErrorCode );

   106 

   107         /**

   108         * Handles the Display text terminal response

   109         * @param aRsp: Response structure

   110         * @return KErrNone/ KErrCorrupt

   111         */

   112         TInt TerminalResponseL( TDes8* aRsp );

   113 

   114 	public: // New functions

   115 	

   116         /**

   117         * Create notification specific terminal response data

   118         * @param aPCmdNumber: Proactive command number

   119         * @param aGeneralResult: Result of the proactive command

   120         * @param aAdditionalInfo: Additional info for terminal response

   121         * @return Success/Failure value

   122         */

   123         TInt CreateTerminalRespL( TUint8 aPCmdNumber, TUint8 aGeneralResult,

   124                                  const TDesC16& aAdditionalInfo );

   125         

   126 

   127     private:    // Data

   128 

   129         // Package received from ETel, used by CSatNotifyDisplayText

   130         RSat::TDisplayTextV2Pckg* iDisplayTextV2Pckg;

   131         // Pointer to the notifications tsy class

   132         CSatNotificationsTsy* iNotificationsTsy;

   133 

   134     };

   135 

   136 #endif // CSATNOTIFYDISPLAYTEXT_H