satengine/SatServer/SatInternalClient/inc/CSatCDisplayTextHandler.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002-2008 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:  This is the handler for the SIM Application Toolkit
       
    15 *                Display Text proactive command.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 
       
    21 #ifndef CSATCDISPLAYTEXTHANDLER_H
       
    22 #define CSATCDISPLAYTEXTHANDLER_H
       
    23 
       
    24 //  INCLUDES
       
    25 #include <e32base.h>
       
    26 #include <etelsat.h>
       
    27 
       
    28 #include "SatSTypes.h"
       
    29 
       
    30 // FORWARD DECLARATIONS
       
    31 class RSatUiSession;
       
    32 
       
    33 // CLASS DECLARATION
       
    34 
       
    35 /**
       
    36  *  The active object handler for the Display Text command.
       
    37  *  Processes the received data and passes it on to the session client.
       
    38  *
       
    39  *  @lib SatClient.lib
       
    40  *  @since Series 60 2.6
       
    41  */
       
    42 class CSatCDisplayTextHandler : public CActive
       
    43     {
       
    44     public: // Constructors and destructor
       
    45 
       
    46         /**
       
    47          * Two-phased constructor.
       
    48          * @param aSat A pointer to a session (does not take ownership).
       
    49          */
       
    50         static CSatCDisplayTextHandler* NewL( RSatUiSession* aSat );
       
    51 
       
    52         /**
       
    53          * Destructor.
       
    54          */
       
    55         virtual ~CSatCDisplayTextHandler();
       
    56 
       
    57     public: // New functions
       
    58 
       
    59         /**
       
    60         * Starts listening for the Sat command.
       
    61         */
       
    62         void Start();
       
    63 
       
    64     protected:  // Functions from base classes
       
    65 
       
    66         /**
       
    67          * From CActive
       
    68          * Handles the request completion.
       
    69          */
       
    70         void RunL();
       
    71 
       
    72         /**
       
    73          * From CActive
       
    74          * Implements the cancel protocol.
       
    75          */
       
    76         void DoCancel();
       
    77 
       
    78     private: // Constructors
       
    79 
       
    80         /**
       
    81          * C++ default constructor.
       
    82          * @param aPriority The priority of this active object.
       
    83          * @param aSat A pointer to a session (does not take ownership).
       
    84          */
       
    85         CSatCDisplayTextHandler(
       
    86             TInt aPriority,
       
    87             RSatUiSession* aSat );
       
    88 
       
    89     private: // New functions
       
    90 
       
    91         /**
       
    92          * Examine the client response.
       
    93          * @param sResponse response data
       
    94          * @param aRequestedIconDisplayed Informs if icon is not used
       
    95          */
       
    96         void ExamineClientResponse(
       
    97             TSatUiResponse sResponse,
       
    98             TBool aRequestedIconDisplayed );
       
    99 
       
   100     private: // Data
       
   101 
       
   102         /**
       
   103          * Reference to the Sat API
       
   104          */
       
   105         RSatUiSession* iSession;
       
   106 
       
   107         /**
       
   108          * The data structure for the command data
       
   109          */        
       
   110         TSatDisplayTextV1 iDisplayTextData;
       
   111 
       
   112         /**
       
   113          * The data package for IPC
       
   114          */          
       
   115         TSatDisplayTextV1Pckg iDisplayTextPckg;
       
   116 
       
   117         /**
       
   118          * The response data structure
       
   119          */          
       
   120         RSat::TDisplayTextRspV1 iDisplayTextRsp;
       
   121 
       
   122         /**
       
   123          * The response package for IPC
       
   124          */          
       
   125         RSat::TDisplayTextRspV1Pckg iDisplayTextRspPckg;
       
   126 
       
   127     };
       
   128 
       
   129 #endif // CSATCDISPLAYTEXTHANDLER_H
       
   130 
       
   131 // End of File