satengine/satserver/SatInternalClient/inc/CSatCDisplayTextHandler.h
author hgs
Fri, 03 Sep 2010 13:59:20 +0300
changeset 46 2fa1fa551b0b
parent 33 8d5d7fcf9b59
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2008 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  This is the handler for the SIM Application Toolkit
hgs
parents:
diff changeset
    15
*                Display Text proactive command.
hgs
parents:
diff changeset
    16
*
hgs
parents:
diff changeset
    17
*/
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
#ifndef CSATCDISPLAYTEXTHANDLER_H
hgs
parents:
diff changeset
    22
#define CSATCDISPLAYTEXTHANDLER_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
//  INCLUDES
hgs
parents:
diff changeset
    25
#include <e32base.h>
hgs
parents:
diff changeset
    26
#include <etelsat.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
#include "SatSTypes.h"
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    31
class RSatUiSession;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
// CLASS DECLARATION
hgs
parents:
diff changeset
    34
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
 *  The active object handler for the Display Text command.
hgs
parents:
diff changeset
    37
 *  Processes the received data and passes it on to the session client.
hgs
parents:
diff changeset
    38
 *
hgs
parents:
diff changeset
    39
 *  @lib SatClient.lib
hgs
parents:
diff changeset
    40
 *  @since Series 60 2.6
hgs
parents:
diff changeset
    41
 */
hgs
parents:
diff changeset
    42
class CSatCDisplayTextHandler : public CActive
hgs
parents:
diff changeset
    43
    {
hgs
parents:
diff changeset
    44
    public: // Constructors and destructor
hgs
parents:
diff changeset
    45
hgs
parents:
diff changeset
    46
        /**
hgs
parents:
diff changeset
    47
         * Two-phased constructor.
hgs
parents:
diff changeset
    48
         * @param aSat A pointer to a session (does not take ownership).
hgs
parents:
diff changeset
    49
         */
hgs
parents:
diff changeset
    50
        static CSatCDisplayTextHandler* NewL( RSatUiSession* aSat );
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
        /**
hgs
parents:
diff changeset
    53
         * Destructor.
hgs
parents:
diff changeset
    54
         */
hgs
parents:
diff changeset
    55
        virtual ~CSatCDisplayTextHandler();
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    public: // New functions
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
        * Starts listening for the Sat command.
hgs
parents:
diff changeset
    61
        */
hgs
parents:
diff changeset
    62
        void Start();
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    protected:  // Functions from base classes
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
        /**
hgs
parents:
diff changeset
    67
         * From CActive
hgs
parents:
diff changeset
    68
         * Handles the request completion.
hgs
parents:
diff changeset
    69
         */
hgs
parents:
diff changeset
    70
        void RunL();
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
        /**
hgs
parents:
diff changeset
    73
         * From CActive
hgs
parents:
diff changeset
    74
         * Implements the cancel protocol.
hgs
parents:
diff changeset
    75
         */
hgs
parents:
diff changeset
    76
        void DoCancel();
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
    private: // Constructors
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
        /**
hgs
parents:
diff changeset
    81
         * C++ default constructor.
hgs
parents:
diff changeset
    82
         * @param aPriority The priority of this active object.
hgs
parents:
diff changeset
    83
         * @param aSat A pointer to a session (does not take ownership).
hgs
parents:
diff changeset
    84
         */
hgs
parents:
diff changeset
    85
        CSatCDisplayTextHandler(
hgs
parents:
diff changeset
    86
            TInt aPriority,
hgs
parents:
diff changeset
    87
            RSatUiSession* aSat );
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
    private: // New functions
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
        /**
hgs
parents:
diff changeset
    92
         * Examine the client response.
hgs
parents:
diff changeset
    93
         * @param sResponse response data
hgs
parents:
diff changeset
    94
         * @param aRequestedIconDisplayed Informs if icon is not used
hgs
parents:
diff changeset
    95
         */
hgs
parents:
diff changeset
    96
        void ExamineClientResponse(
hgs
parents:
diff changeset
    97
            TSatUiResponse sResponse,
hgs
parents:
diff changeset
    98
            TBool aRequestedIconDisplayed );
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
    private: // Data
hgs
parents:
diff changeset
   101
hgs
parents:
diff changeset
   102
        /**
hgs
parents:
diff changeset
   103
         * Reference to the Sat API
hgs
parents:
diff changeset
   104
         */
hgs
parents:
diff changeset
   105
        RSatUiSession* iSession;
hgs
parents:
diff changeset
   106
hgs
parents:
diff changeset
   107
        /**
hgs
parents:
diff changeset
   108
         * The data structure for the command data
hgs
parents:
diff changeset
   109
         */        
hgs
parents:
diff changeset
   110
        TSatDisplayTextV1 iDisplayTextData;
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
        /**
hgs
parents:
diff changeset
   113
         * The data package for IPC
hgs
parents:
diff changeset
   114
         */          
hgs
parents:
diff changeset
   115
        TSatDisplayTextV1Pckg iDisplayTextPckg;
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
        /**
hgs
parents:
diff changeset
   118
         * The response data structure
hgs
parents:
diff changeset
   119
         */          
hgs
parents:
diff changeset
   120
        RSat::TDisplayTextRspV1 iDisplayTextRsp;
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
        /**
hgs
parents:
diff changeset
   123
         * The response package for IPC
hgs
parents:
diff changeset
   124
         */          
hgs
parents:
diff changeset
   125
        RSat::TDisplayTextRspV1Pckg iDisplayTextRspPckg;
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
    };
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
#endif // CSATCDISPLAYTEXTHANDLER_H
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
// End of File