satengine/SatServer/inc/MSatUiSession.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002-2005 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:  Interface for Ui sessions
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MSATUISESSION_H
       
    21 #define MSATUISESSION_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <e32std.h>
       
    25 #include <etelsat.h>
       
    26 #include "SatSOpcodes.h"
       
    27 
       
    28 // FORWARD DECLARATION
       
    29 class MSatCommand;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34 *  Ui sub session interface for commands.
       
    35 *
       
    36 *  @lib SatEngine.lib
       
    37 *  @since Series 60 3.0
       
    38 */
       
    39 class MSatUiSession
       
    40     {
       
    41     protected:  // Constructors and destructor
       
    42 
       
    43         /**
       
    44         * C++ default constructor.
       
    45         */
       
    46         MSatUiSession() {};
       
    47 
       
    48         /**
       
    49         * Destructor.
       
    50         */
       
    51         virtual ~MSatUiSession() {};
       
    52 
       
    53     public: // New functions
       
    54 
       
    55         /**
       
    56         * Closes the ui session.
       
    57         */
       
    58         virtual void CloseUiSession() = 0;
       
    59 
       
    60         /**
       
    61         * Clears the screen.
       
    62         */
       
    63         virtual void ClearScreen() = 0;
       
    64         
       
    65         /**
       
    66         * Ui Event
       
    67         */
       
    68         virtual void UiEventNotification( 
       
    69             TInt aEventId,
       
    70             TInt aEventStatus,
       
    71             TInt aEventError ) = 0;
       
    72 
       
    73         /**
       
    74         * Notification that command data is available.
       
    75         * @param aCmdData Data to be sent to client.
       
    76         * @param aCmdRsp Response from Client is written to this.
       
    77         * @param aRequest Request, where the data is sent.
       
    78         */
       
    79         virtual void SendCommand(
       
    80             TDesC8* aCmdData,
       
    81             TDes8* aCmdRsp,
       
    82             TSatServerRequest aRequest ) = 0;
       
    83 
       
    84     private:
       
    85 
       
    86         // Prohibit copy constructor if not deriving from CBase.
       
    87         MSatUiSession( const MSatUiSession& );
       
    88 
       
    89         // Prohibit assigment operator if not deriving from CBase.
       
    90         MSatUiSession& operator=( const MSatUiSession& );
       
    91 
       
    92     };
       
    93 
       
    94 #endif      // MSATUISESSION_H
       
    95 
       
    96 // End of File