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