satengine/satserver/SatInternalClient/inc/CSatCCommandProcessor.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 file contains the client command processor class that is
hgs
parents:
diff changeset
    15
*                responsible for the active objects needed to maintain that
hgs
parents:
diff changeset
    16
*                connection.
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
hgs
parents:
diff changeset
    22
#ifndef CSATCCOMMANDPROCESSOR_H
hgs
parents:
diff changeset
    23
#define CSATCCOMMANDPROCESSOR_H
hgs
parents:
diff changeset
    24
hgs
parents:
diff changeset
    25
//  INCLUDES
hgs
parents:
diff changeset
    26
#include <e32base.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
#include "CSatCDisplayTextHandler.h"
hgs
parents:
diff changeset
    29
#include "CSatCGetInkeyHandler.h"
hgs
parents:
diff changeset
    30
#include "CSatCGetInputHandler.h"
hgs
parents:
diff changeset
    31
#include "CSatCSetUpMenuHandler.h"
hgs
parents:
diff changeset
    32
#include "CSatCSelectItemHandler.h"
hgs
parents:
diff changeset
    33
#include "CSatCPlayToneHandler.h"
hgs
parents:
diff changeset
    34
#include "CSatCActiveCommandHandler.h"
hgs
parents:
diff changeset
    35
#include "CSatCEventHandler.h"
hgs
parents:
diff changeset
    36
#include "CSatCQueryHandler.h"
hgs
parents:
diff changeset
    37
#include "CSatCNotifyHandler.h"
hgs
parents:
diff changeset
    38
hgs
parents:
diff changeset
    39
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    40
class RSatUiSession;
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
// CLASS DECLARATION
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
/**
hgs
parents:
diff changeset
    45
 *  This class is the container for all command handlers.
hgs
parents:
diff changeset
    46
 *  The class, owned by the session objects, initializes and starts all
hgs
parents:
diff changeset
    47
 *  of the active objects which are part of the Sat Client API.
hgs
parents:
diff changeset
    48
 *
hgs
parents:
diff changeset
    49
 *  @lib SatClient.lib
hgs
parents:
diff changeset
    50
 *  @since Series 60 2.6
hgs
parents:
diff changeset
    51
 */
hgs
parents:
diff changeset
    52
class CSatCCommandProcessor : public CBase
hgs
parents:
diff changeset
    53
    {
hgs
parents:
diff changeset
    54
    public: // Constructors and destructor
hgs
parents:
diff changeset
    55
hgs
parents:
diff changeset
    56
        /**
hgs
parents:
diff changeset
    57
         * Two-phased constructor.
hgs
parents:
diff changeset
    58
         * @param aSession A pointer to a session (does not take ownership).
hgs
parents:
diff changeset
    59
         */
hgs
parents:
diff changeset
    60
        static CSatCCommandProcessor* NewL( RSatUiSession* aSession );
hgs
parents:
diff changeset
    61
hgs
parents:
diff changeset
    62
        /**
hgs
parents:
diff changeset
    63
         * Destructor.
hgs
parents:
diff changeset
    64
         */
hgs
parents:
diff changeset
    65
        virtual ~CSatCCommandProcessor();
hgs
parents:
diff changeset
    66
hgs
parents:
diff changeset
    67
    public:  // New functions
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
        /**
hgs
parents:
diff changeset
    70
         * Starts the active objects.
hgs
parents:
diff changeset
    71
         */
hgs
parents:
diff changeset
    72
        void Start();
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
         * Returns a pointer to the object that implements set up menu command
hgs
parents:
diff changeset
    76
         * handler object.
hgs
parents:
diff changeset
    77
         * @return The set up menu command handler object pointer.
hgs
parents:
diff changeset
    78
         */
hgs
parents:
diff changeset
    79
        CSatCSetUpMenuHandler* SetUpMenuHandler();
hgs
parents:
diff changeset
    80
hgs
parents:
diff changeset
    81
        /**
hgs
parents:
diff changeset
    82
         * Returns a pointer to a active command handler object.
hgs
parents:
diff changeset
    83
         * @return The active command handler object pointer.
hgs
parents:
diff changeset
    84
         */
hgs
parents:
diff changeset
    85
        CSatCActiveCommandHandler* ActiveCommandHandler();
hgs
parents:
diff changeset
    86
hgs
parents:
diff changeset
    87
    private: // Constructors
hgs
parents:
diff changeset
    88
hgs
parents:
diff changeset
    89
        /**
hgs
parents:
diff changeset
    90
         * C++ default constructor.
hgs
parents:
diff changeset
    91
         * @param aSession A pointer to a session (does not take ownership).
hgs
parents:
diff changeset
    92
         */
hgs
parents:
diff changeset
    93
        CSatCCommandProcessor( RSatUiSession* aSession );
hgs
parents:
diff changeset
    94
hgs
parents:
diff changeset
    95
        /**
hgs
parents:
diff changeset
    96
         * By default Symbian OS constructor is private.
hgs
parents:
diff changeset
    97
         */
hgs
parents:
diff changeset
    98
        void ConstructL();
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
         * The Sat Client Session.
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 Display Text command handler.
hgs
parents:
diff changeset
   109
         */          
hgs
parents:
diff changeset
   110
        CSatCDisplayTextHandler* iDisplayTextHandler;
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
        /**
hgs
parents:
diff changeset
   113
         * The Get Inkey command handler.
hgs
parents:
diff changeset
   114
         */          
hgs
parents:
diff changeset
   115
        CSatCGetInkeyHandler* iGetInkeyHandler;
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
        /**
hgs
parents:
diff changeset
   118
         * The Get Input command handler.
hgs
parents:
diff changeset
   119
         */          
hgs
parents:
diff changeset
   120
        CSatCGetInputHandler* iGetInputHandler;
hgs
parents:
diff changeset
   121
 
hgs
parents:
diff changeset
   122
        /**
hgs
parents:
diff changeset
   123
         * The Set Up Menu command handler.
hgs
parents:
diff changeset
   124
         */          
hgs
parents:
diff changeset
   125
        CSatCSetUpMenuHandler* iSetUpMenuHandler;
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
        /**
hgs
parents:
diff changeset
   128
         * The Select Item command handler.
hgs
parents:
diff changeset
   129
         */          
hgs
parents:
diff changeset
   130
        CSatCSelectItemHandler* iSelectItemHandler;
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
        /**
hgs
parents:
diff changeset
   133
         * The Play Tone command handler.
hgs
parents:
diff changeset
   134
         */          
hgs
parents:
diff changeset
   135
        CSatCPlayToneHandler* iPlayToneHandler;
hgs
parents:
diff changeset
   136
hgs
parents:
diff changeset
   137
        /**
hgs
parents:
diff changeset
   138
         * Handler for various server-side events.
hgs
parents:
diff changeset
   139
         */          
hgs
parents:
diff changeset
   140
        CSatCEventHandler* iEventHandler;
hgs
parents:
diff changeset
   141
hgs
parents:
diff changeset
   142
        /**
hgs
parents:
diff changeset
   143
         * Handler for various end-user queries.
hgs
parents:
diff changeset
   144
         */          
hgs
parents:
diff changeset
   145
        CSatCQueryHandler* iQueryHandler;
hgs
parents:
diff changeset
   146
hgs
parents:
diff changeset
   147
        /**
hgs
parents:
diff changeset
   148
         * Notification handler
hgs
parents:
diff changeset
   149
         */          
hgs
parents:
diff changeset
   150
        CSatCNotifyHandler* iNotifyHandler;
hgs
parents:
diff changeset
   151
hgs
parents:
diff changeset
   152
        /**
hgs
parents:
diff changeset
   153
         * The handler for all user-initiated commands.
hgs
parents:
diff changeset
   154
         */          
hgs
parents:
diff changeset
   155
        CSatCActiveCommandHandler* iActiveCommandHandler;
hgs
parents:
diff changeset
   156
hgs
parents:
diff changeset
   157
    };
hgs
parents:
diff changeset
   158
hgs
parents:
diff changeset
   159
#endif // CSATCCOMMANDPROCESSOR_H
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
// End of File