satengine/SatServer/Commands/DisplayTextCmd/inc/CClearScreenHandler.h
changeset 46 2fa1fa551b0b
parent 42 35488577e233
child 48 78df25012fda
equal deleted inserted replaced
42:35488577e233 46:2fa1fa551b0b
     1 /*
       
     2 * Copyright (c) 2002-2006 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:  ClearScreen handler is responsible for clearing screen when
       
    15 *                DisplayText has sent immediate response and it is still active
       
    16 *                when any other command starts to execute.
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 #ifndef CCLEARSCREENHANDLER_H
       
    23 #define CCLEARSCREENHANDLER_H
       
    24 
       
    25 //  INCLUDES
       
    26 #include <e32base.h>
       
    27 #include "MSatEventObserver.h"
       
    28 
       
    29 // CONSTANTS
       
    30 
       
    31 // FORWARD DECLARATIONS
       
    32 class MSatUtils;
       
    33 
       
    34 // CLASS DECLARATION
       
    35 
       
    36 /**
       
    37 *  CClearScreenHandler for ClearScreen event
       
    38 *
       
    39 *  @lib DisplayTextCmd.lib
       
    40 *  @since Series 60 3.0
       
    41 */
       
    42 class CClearScreenHandler : public CBase,
       
    43                             public MSatEventObserver
       
    44     {
       
    45     public:  // Constructors and destructor
       
    46 
       
    47         /**
       
    48         * Two-phased constructor.
       
    49         * @param aUtils SAT Utils interface
       
    50         */
       
    51         static CClearScreenHandler* NewL( MSatUtils& aUtils );
       
    52 
       
    53         /**
       
    54         * Destructor.
       
    55         */
       
    56         virtual ~CClearScreenHandler();
       
    57 
       
    58     public: // New functions
       
    59 
       
    60         /**
       
    61         * Updates immediate response state to ETrue or EFalse
       
    62         * @param aState new state
       
    63         */
       
    64         void UpdateImmediateState( TBool aState );
       
    65 
       
    66     public: // From MSatEventObserver
       
    67 
       
    68         /**
       
    69         * Notification of event.
       
    70         * @param aEvent Identifies the event.
       
    71         */
       
    72         void Event( TInt aEvent );
       
    73 
       
    74     private:
       
    75 
       
    76         /**
       
    77         * C++ default constructor.
       
    78         * @param aUtils SAT Utils interface
       
    79         */
       
    80         CClearScreenHandler( MSatUtils& aUtils );
       
    81 
       
    82         /**
       
    83         * By default Symbian 2nd phase constructor is private.
       
    84         */
       
    85         void ConstructL();
       
    86 
       
    87         /**
       
    88         * Sends the request for clear screen.
       
    89         */
       
    90         void ClearScreen();
       
    91 
       
    92     private:    // Data
       
    93 
       
    94         // Holds immediate response's status.
       
    95         TBool iImmediateResponse;
       
    96 
       
    97         // Utils interface
       
    98         MSatUtils& iUtils;
       
    99 
       
   100     };
       
   101 
       
   102 #endif      // CCLEARSCREENHANDLER_H
       
   103 
       
   104 // End of File