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