mpx/tsrc/public/basic/common/testviewframework/inc/consolemain.h
author hgs
Tue, 21 Sep 2010 11:25:55 -0500
changeset 62 b276843a15ba
permissions -rw-r--r--
201037
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
62
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 - 2007 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:  console manipulation
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
#ifndef CCONSOLEMAIN_H
hgs
parents:
diff changeset
    19
#define CCONSOLEMAIN_H
hgs
parents:
diff changeset
    20
hgs
parents:
diff changeset
    21
// INCLUDE FILES
hgs
parents:
diff changeset
    22
#include <aknlists.h>
hgs
parents:
diff changeset
    23
#include <e32cons.h>
hgs
parents:
diff changeset
    24
#include <apaflrec.h>
hgs
parents:
diff changeset
    25
#include <e32base.h>
hgs
parents:
diff changeset
    26
#include <e32def.h>
hgs
parents:
diff changeset
    27
hgs
parents:
diff changeset
    28
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    29
class CTestBaseView;
hgs
parents:
diff changeset
    30
class CScrollerTimer;
hgs
parents:
diff changeset
    31
class CConsoleReader;
hgs
parents:
diff changeset
    32
hgs
parents:
diff changeset
    33
/**
hgs
parents:
diff changeset
    34
*  console manipulation class 
hgs
parents:
diff changeset
    35
*
hgs
parents:
diff changeset
    36
*  @lib TestViewFramework.lib
hgs
parents:
diff changeset
    37
*/
hgs
parents:
diff changeset
    38
class CConsoleMain :public CBase
hgs
parents:
diff changeset
    39
    {
hgs
parents:
diff changeset
    40
    public:  
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
        /**
hgs
parents:
diff changeset
    43
        * Two-phased constructor
hgs
parents:
diff changeset
    44
        * @return object of CConsoleMain
hgs
parents:
diff changeset
    45
        */
hgs
parents:
diff changeset
    46
        IMPORT_C static CConsoleMain* NewL(CActiveScheduler* aScheduler);
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
        /**
hgs
parents:
diff changeset
    49
        * Destructor of CConsoleMain
hgs
parents:
diff changeset
    50
        */
hgs
parents:
diff changeset
    51
        virtual ~CConsoleMain();
hgs
parents:
diff changeset
    52
        
hgs
parents:
diff changeset
    53
        /**
hgs
parents:
diff changeset
    54
        * Start
hgs
parents:
diff changeset
    55
        * @param aView, activate a root view in console
hgs
parents:
diff changeset
    56
        */
hgs
parents:
diff changeset
    57
        IMPORT_C void ActivateL( CTestBaseView* aRootView );
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
        * Stop ScrollerTimer and ConsoleReader
hgs
parents:
diff changeset
    61
        */
hgs
parents:
diff changeset
    62
        IMPORT_C void Stop();
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
        /**
hgs
parents:
diff changeset
    65
        * Reads user input into the start of the descriptor aDes
hgs
parents:
diff changeset
    66
        * @param aDes, descriptor to store input string
hgs
parents:
diff changeset
    67
        */
hgs
parents:
diff changeset
    68
        IMPORT_C void ReadString( TDes& aDes );
hgs
parents:
diff changeset
    69
hgs
parents:
diff changeset
    70
        
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    public: // New functions
hgs
parents:
diff changeset
    73
		
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
        * Return current menu
hgs
parents:
diff changeset
    76
        * @return reference of current shown menu
hgs
parents:
diff changeset
    77
        */
hgs
parents:
diff changeset
    78
        CTestBaseView* CurrentView();
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
        /**
hgs
parents:
diff changeset
    81
        * Return pointer to console
hgs
parents:
diff changeset
    82
        * @return reference to console
hgs
parents:
diff changeset
    83
        */
hgs
parents:
diff changeset
    84
        CConsoleBase* GetConsole();
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
        /**
hgs
parents:
diff changeset
    87
        * Called from timer to perform scrolling
hgs
parents:
diff changeset
    88
        */
hgs
parents:
diff changeset
    89
        void TimerUpdate();
hgs
parents:
diff changeset
    90
hgs
parents:
diff changeset
    91
        /**
hgs
parents:
diff changeset
    92
        * Process keystokes.
hgs
parents:
diff changeset
    93
        */
hgs
parents:
diff changeset
    94
        void KeyPressedL();
hgs
parents:
diff changeset
    95
hgs
parents:
diff changeset
    96
    private:  //Friend class
hgs
parents:
diff changeset
    97
        friend class CTestBaseView;
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
    private:
hgs
parents:
diff changeset
   100
hgs
parents:
diff changeset
   101
        /** 
hgs
parents:
diff changeset
   102
        * C++ default constructor.
hgs
parents:
diff changeset
   103
        */
hgs
parents:
diff changeset
   104
        CConsoleMain(CActiveScheduler* aScheduler);
hgs
parents:
diff changeset
   105
hgs
parents:
diff changeset
   106
        /**
hgs
parents:
diff changeset
   107
        * the second phase constructor ConstructL to safely construct things 
hgs
parents:
diff changeset
   108
        * that can leave 
hgs
parents:
diff changeset
   109
        */
hgs
parents:
diff changeset
   110
        void ConstructL();
hgs
parents:
diff changeset
   111
        
hgs
parents:
diff changeset
   112
        /**
hgs
parents:
diff changeset
   113
        * Call by CTestBaseView
hgs
parents:
diff changeset
   114
        * Actiavte the child view
hgs
parents:
diff changeset
   115
        * @param aChild, a new child view 
hgs
parents:
diff changeset
   116
        */
hgs
parents:
diff changeset
   117
        void NextViewL(CTestBaseView* aChild);
hgs
parents:
diff changeset
   118
        
hgs
parents:
diff changeset
   119
        /**
hgs
parents:
diff changeset
   120
        * Call by CTestBaseView
hgs
parents:
diff changeset
   121
        * Indicate the current is done, go back parent view
hgs
parents:
diff changeset
   122
        */
hgs
parents:
diff changeset
   123
        void CurrentViewDoneL();
hgs
parents:
diff changeset
   124
        
hgs
parents:
diff changeset
   125
    private:    // Data
hgs
parents:
diff changeset
   126
        CConsoleBase*       iConsole;       // Pointer to console
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
        CTestBaseView*      iCurrentView;   // Current view
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
        CScrollerTimer*     iScroller;      // Scroll text
hgs
parents:
diff changeset
   131
        
hgs
parents:
diff changeset
   132
        CConsoleReader*     iReader;        // Console reader
hgs
parents:
diff changeset
   133
        
hgs
parents:
diff changeset
   134
        CActiveScheduler*   iScheduler;     // Uses an active scheduler   
hgs
parents:
diff changeset
   135
    
hgs
parents:
diff changeset
   136
    	TBool				iSchedulerStarted;
hgs
parents:
diff changeset
   137
    };
hgs
parents:
diff changeset
   138
hgs
parents:
diff changeset
   139
#endif