|
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 UI Proxy |
|
15 * interface. |
|
16 * |
|
17 */ |
|
18 |
|
19 #ifndef UIENVPROXY_H_ |
|
20 #define UIENVPROXY_H_ |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32base.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 // None |
|
39 |
|
40 // CLASS DECLARATION |
|
41 |
|
42 // DESCRIPTION |
|
43 // Interface class for the proxy betweene testscripter and AppUi. |
|
44 class CUiEnvProxy: public CBase |
|
45 { |
|
46 public: // Enumerations |
|
47 // None |
|
48 |
|
49 private: // Enumerations |
|
50 // None |
|
51 |
|
52 public: // Constructors and destructor |
|
53 // None |
|
54 |
|
55 public: // New functions |
|
56 /** |
|
57 * Parses key code. |
|
58 */ |
|
59 virtual TInt ParseKeyCode( const TDesC& aKeyCodeName, TUint& aKeyCode ) const = 0; |
|
60 |
|
61 /** |
|
62 * Parses key scan code. |
|
63 */ |
|
64 virtual TInt ParseKeyScanCode( const TDesC& aKeyScanCodeName, TInt& aKeyScanCode ) const = 0; |
|
65 |
|
66 /** |
|
67 * Parses key modifier. |
|
68 */ |
|
69 virtual TInt ParseModifier( const TDesC& aModifierName, TUint& aModifier ) const = 0; |
|
70 |
|
71 /** |
|
72 * Parse pointer event type |
|
73 */ |
|
74 virtual TInt ParsePointerEventType( const TDesC& aPointerEventTypeName, TUint& aPointerEventType ) const = 0; |
|
75 |
|
76 /** |
|
77 * Brings UI control container to foreground. |
|
78 */ |
|
79 virtual void BringToForeground() = 0; |
|
80 |
|
81 /** |
|
82 * Sends UI control container to background. |
|
83 */ |
|
84 virtual void SendToBackground() = 0; |
|
85 |
|
86 /** |
|
87 * Sends local key event to UI control. |
|
88 */ |
|
89 virtual void PressKeyL( TRequestStatus* aStatus, TUint aKeyCode, TInt aKeyScanCode = 0, |
|
90 TUint aKeyModifiers = 0, TInt keyRepeats = 0 ) = 0; |
|
91 |
|
92 /** |
|
93 * Sends local key event to UI control. |
|
94 */ |
|
95 virtual void PressKeyL( TUint aKeyCode, TInt aKeyScanCode = 0, |
|
96 TUint aKeyModifiers = 0, TInt keyRepeats = 0 ) = 0; |
|
97 |
|
98 /** |
|
99 * Sends text to UI control. |
|
100 */ |
|
101 virtual void TypeTextL( TRequestStatus* aStatus, const TDesC& aText ) = 0; |
|
102 |
|
103 /** |
|
104 * Sends text to UI control. |
|
105 */ |
|
106 virtual void TypeTextL( const TDesC& aText ) = 0; |
|
107 |
|
108 /** |
|
109 * Send pointer event |
|
110 */ |
|
111 virtual void SendPointerEventL( TUint aType, const TPoint& aPosition ) = 0; |
|
112 |
|
113 /** |
|
114 * Send local pointer event |
|
115 */ |
|
116 virtual void SendPointerEventL( TRequestStatus* aStatus, TUint aType, const TPoint& aPosition ) = 0; |
|
117 |
|
118 public: // Functions from base classes |
|
119 // None |
|
120 |
|
121 protected: // New functions |
|
122 // None |
|
123 |
|
124 protected: // Functions from base classes |
|
125 // None |
|
126 |
|
127 private: // New functions |
|
128 // None |
|
129 |
|
130 public: //Data |
|
131 // None |
|
132 |
|
133 protected: // Data |
|
134 // None |
|
135 |
|
136 private: // Data |
|
137 // None |
|
138 |
|
139 public: // Friend classes |
|
140 // None |
|
141 |
|
142 protected: // Friend classes |
|
143 // None |
|
144 |
|
145 private: // Friend classes |
|
146 // None |
|
147 }; |
|
148 |
|
149 #endif // UIENVPROXY_H_ |
|
150 |
|
151 // End of File |