stifui/uitestserverstarter/inc/AknUiEnvProxy.h
branchRCL_3
changeset 9 404ad6c9bc20
parent 8 87e9ebfbe96a
child 11 454d022d514b
equal deleted inserted replaced
8:87e9ebfbe96a 9:404ad6c9bc20
     1 /*
       
     2 * Copyright (c) 2009 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 header file of the Akn UI 
       
    15 * Proxy class implementations.
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef AKNUIENVPROXY_H_
       
    20 #define AKNUIENVPROXY_H_
       
    21 
       
    22 //  INCLUDES
       
    23 #include <stifinternal/UiEnvProxy.h>
       
    24 
       
    25 // CONSTANTS
       
    26 // None
       
    27 
       
    28 // MACROS
       
    29 // None
       
    30 
       
    31 // DATA TYPES
       
    32 // None
       
    33 
       
    34 // FUNCTION PROTOTYPES
       
    35 // None
       
    36 
       
    37 // FORWARD DECLARATIONS
       
    38 class CUITestServerStarterAppUi;
       
    39 
       
    40 // CLASS DECLARATION
       
    41 
       
    42 // DESCRIPTION
       
    43 // Akn implementation of UI Proxy interface.
       
    44 class CAknUiEnvProxy: public CUiEnvProxy
       
    45 	{
       
    46 	public: // Enumerations
       
    47 	    // None
       
    48 	
       
    49 	private: // Enumerations
       
    50 	    // None
       
    51 	
       
    52 	public:  // Constructors and destructor
       
    53 	    /**
       
    54 	    * C++ destructor.
       
    55 	    */
       
    56 	    ~CAknUiEnvProxy();
       
    57 	
       
    58 	public: // New functions
       
    59 	    /**
       
    60 	    * NewL is first phase of two-phased constructor.
       
    61 	    */		
       
    62 		static CAknUiEnvProxy* NewL( CUITestServerStarterAppUi* aAppUi );
       
    63 		
       
    64     public: // Functions from base classes
       
    65 
       
    66 		/**
       
    67 		 * Parses key code.
       
    68 		 */
       
    69 		virtual TInt ParseKeyCode( const TDesC& aKeyCodeName, TUint& aKeyCode ) const;
       
    70 	
       
    71 		/**
       
    72 		 * Parses key scan code.
       
    73 		 */
       
    74 		virtual TInt ParseKeyScanCode( const TDesC& aKeyScanCodeName, TInt& aKeyScanCode ) const;
       
    75 	
       
    76 		/**
       
    77 		 * Parses key modifier.
       
    78 		 */
       
    79 		virtual TInt ParseModifier( const TDesC& aModifierName, TUint& aModifier ) const;
       
    80 	    
       
    81 		/**
       
    82 		 * Parse pointer event type
       
    83 		 */
       
    84 		virtual TInt ParsePointerEventType( const TDesC& aPointerEventTypeName, TUint& aPointerEventType ) const;
       
    85 
       
    86 		/**
       
    87 		 * Brings UI control container to foreground.
       
    88 		 */
       
    89 		virtual void BringToForeground();
       
    90 
       
    91 		/**
       
    92 		 * Sends UI control container to background.
       
    93 		 */
       
    94 		virtual void SendToBackground();
       
    95 
       
    96 		/**
       
    97 		 * Sends local key event to UI control.
       
    98 		 */
       
    99 		virtual void PressKeyL( TRequestStatus* aStatus, TUint aKeyCode, TInt aKeyScanCode = 0, 
       
   100 				   TUint aKeyModifiers = 0, TInt aKeyRepeats = 0 );
       
   101 
       
   102 		/**
       
   103 		 * Sends global key event to UI control.
       
   104 		 */
       
   105 		virtual void PressKeyL( TUint aKeyCode, TInt aKeyScanCode = 0, 
       
   106 				   TUint aKeyModifiers = 0, TInt aKeyRepeats = 0 );
       
   107 
       
   108 		/**
       
   109 		 * Sends text to UI control.
       
   110 		 */
       
   111 		virtual void TypeTextL( TRequestStatus* aStatus, const TDesC& aText );
       
   112 
       
   113 		/**
       
   114 		 * Sends global text to UI control.
       
   115 		 */
       
   116 		virtual void TypeTextL( const TDesC& aText );
       
   117 		
       
   118 		/**
       
   119 		 * Send pointer event
       
   120 		 */
       
   121 		virtual void SendPointerEventL( TUint aType, const TPoint& aPosition );		
       
   122 		
       
   123 		/**
       
   124 		 * Send local pointer event
       
   125 		 */
       
   126 		virtual void SendPointerEventL( TRequestStatus* aStatus, TUint aType, const TPoint& aPosition );
       
   127 		
       
   128     protected:	// New functions
       
   129         // None
       
   130         
       
   131     protected:	// Functions from base classes
       
   132         // None
       
   133         
       
   134     private:	// New functions
       
   135 	    /**
       
   136 	    * C++ default constructor.
       
   137 	    */
       
   138 		CAknUiEnvProxy();
       
   139     
       
   140 	    /**
       
   141 	    * By default Symbian OS constructor is private.
       
   142 	    */
       
   143     	void ConstructL( CUITestServerStarterAppUi* aAppUi );
       
   144     
       
   145 	public:		//Data
       
   146 	    // None
       
   147         
       
   148 	protected:	// Data
       
   149         // None
       
   150         
       
   151     private:	// Data
       
   152     	CUITestServerStarterAppUi* iAppUi;	// Pointer to AppUi
       
   153 		
       
   154     public:		// Friend classes
       
   155         // None
       
   156 
       
   157     protected:	// Friend classes
       
   158         // None
       
   159 
       
   160     private:	// Friend classes
       
   161         // None
       
   162 };
       
   163 
       
   164 #endif // AKNUIENVPROXY_H_
       
   165 
       
   166 // End of File