1 /* |
|
2 * Copyright (c) 2002 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 the License "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: |
|
15 * Interface to Status Pane. |
|
16 * |
|
17 * |
|
18 */ |
|
19 |
|
20 |
|
21 #ifndef MDISPLAY_H |
|
22 #define MDISPLAY_H |
|
23 |
|
24 // INCLUDES |
|
25 #include <browser_platform_variant.hrh> |
|
26 |
|
27 // FORWARD DECLARATIONS |
|
28 |
|
29 class CAknNavigationControlContainer; |
|
30 class CEikStatusPane; |
|
31 |
|
32 // CLASS DECLARATION |
|
33 |
|
34 /** |
|
35 * Interface to GUI components. |
|
36 */ |
|
37 class MDisplay |
|
38 { |
|
39 public: // Status Pane / NaviPane handling |
|
40 |
|
41 /** |
|
42 * Return Status Pane. Can be NULL. |
|
43 * @return Status Pane. |
|
44 */ |
|
45 virtual CEikStatusPane* StatusPane() const = 0; |
|
46 |
|
47 // VAG 01.Feb.2002. |
|
48 // Please do not add Push/Pop-NaviDecoratorL methods. Ownership of |
|
49 // the decorator becomes problematic. The safe way is: |
|
50 // Create a decorator as an own member, push it to Navi Pane, and |
|
51 // simply delete that decorator in your destructor (deleting it pops |
|
52 // automatically). This cannot go wrong, and does not contain leaving |
|
53 // code in destructors. |
|
54 |
|
55 /** |
|
56 * Get Navi Pane; leave on error. |
|
57 * @return Navi Pane. Never NULL. |
|
58 */ |
|
59 virtual CAknNavigationControlContainer* NaviPaneL() const = 0; |
|
60 |
|
61 public: // TitlePane handling |
|
62 |
|
63 /** |
|
64 * Set title pane text. |
|
65 * @param aTitle Title text to be displayed. |
|
66 */ |
|
67 virtual void SetTitleL( const TDesC& aTitle ) = 0; |
|
68 |
|
69 /** |
|
70 * Set title pane text from resource. |
|
71 * @param aTitle Resource id of title text to be displayed. |
|
72 */ |
|
73 virtual void SetTitleL( TInt aResourceId ) = 0; |
|
74 |
|
75 public: // Animation in contextpane |
|
76 |
|
77 /** |
|
78 * Starts animation and progress indicator. |
|
79 * @param aBearerType Determines what is to be animated. |
|
80 */ |
|
81 virtual void StartProgressAnimationL() = 0; |
|
82 |
|
83 /** |
|
84 * Stops animation and progress indicator. |
|
85 */ |
|
86 virtual void StopProgressAnimationL() = 0; |
|
87 |
|
88 /** |
|
89 * Notify that new data has arrived to the loaders. |
|
90 * @since Series60_version 2.5 |
|
91 * @return none |
|
92 */ |
|
93 virtual void NotifyProgress() = 0; |
|
94 |
|
95 public: // Transaction |
|
96 |
|
97 /** |
|
98 * Adds transaction id |
|
99 * @param aId Transaction id |
|
100 */ |
|
101 virtual void AddTransActIdL( TUint16 aId ) const = 0; |
|
102 |
|
103 /** |
|
104 * Saves maximum and received data with a transction id. |
|
105 * @since Series60 1.2 |
|
106 * @param aId Id of the transaction |
|
107 * @param aRecvdData Amount of data we have received with current transaction Id |
|
108 * @param aMaxData Max size of the transaction |
|
109 */ |
|
110 virtual void AddProgressDataL( TUint16 aId, TUint32 aRecvdData, TUint32 aMaxData ) const = 0; |
|
111 |
|
112 /** |
|
113 * Marks particular transaction id to complete status |
|
114 * @since Series60 2.0 |
|
115 * @param aId Id of the transaction |
|
116 */ |
|
117 virtual void TransActIdComplete( TUint16 aId ) const = 0; |
|
118 |
|
119 public: // Secure indicator |
|
120 |
|
121 /** |
|
122 * Shows or hides secure indicator depending on aState. |
|
123 * @param aState EAknIndicatorStateOff/EAknIndicatorStateOn. |
|
124 */ |
|
125 virtual void UpdateSecureIndicatorL( const TInt aState ) = 0; |
|
126 |
|
127 /** |
|
128 * Sets GPRS indicator on for Full Screen Mode |
|
129 */ |
|
130 virtual void SetGPRSIndicatorOnL() = 0; |
|
131 |
|
132 /** |
|
133 * Starts the Wlan Indicator observer |
|
134 */ |
|
135 virtual void StartWlanObserverL() = 0; |
|
136 |
|
137 /** |
|
138 * Updates the Wlan Indicator to current value |
|
139 */ |
|
140 virtual void UpdateWlanIndicator( const TInt aWlanValue ) = 0; |
|
141 |
|
142 /** |
|
143 * Initialises Full Screen pane indicators |
|
144 */ |
|
145 |
|
146 virtual void FSPaneOnL( ) = 0; |
|
147 |
|
148 /** |
|
149 * Updates Full Screen progress indicator |
|
150 */ |
|
151 |
|
152 virtual void UpdateFSProgressIndicator(const TInt aMaxData, const TInt aReceivedData) = 0; |
|
153 |
|
154 /** |
|
155 * Starts Full Screen Wait indicator |
|
156 */ |
|
157 |
|
158 virtual void StartFSWaitIndicator() = 0; |
|
159 |
|
160 /** |
|
161 * Updates 'downloaded data amount' message on Full Screen pane |
|
162 */ |
|
163 |
|
164 virtual void UpdateFSProgressDataL(const TDesC16& aReceivedDataText) = 0; |
|
165 |
|
166 /** |
|
167 * Clears the Message Info indicator in the navipane |
|
168 */ |
|
169 virtual void ClearMessageInfo() = 0; |
|
170 |
|
171 /** |
|
172 * Sets formerly saved page title. SetTitleL's functionality moved here, because page title restoration is |
|
173 * necessary in Full Screen mode |
|
174 */ |
|
175 |
|
176 virtual void RestoreTitleL() = 0; |
|
177 |
|
178 /** |
|
179 * Updates initial download indicator on Full Screen pane |
|
180 */ |
|
181 |
|
182 virtual void UpdateFSDownloadInitialIndicator(const TBool aState) = 0; |
|
183 |
|
184 /** |
|
185 * Initializes Full Screen Indicators |
|
186 */ |
|
187 |
|
188 virtual void InitIndicatorsL() = 0; |
|
189 |
|
190 /** |
|
191 * Updates the Multiple Windows Indicator |
|
192 * @param aState Indicator On or Off |
|
193 * @param aWinCount The number of windows open |
|
194 * @since Series60 3.0 |
|
195 */ |
|
196 virtual void UpdateMultipleWindowsIndicatorL( |
|
197 const TBool aState, const TInt aNumWindows ) = 0; |
|
198 }; |
|
199 |
|
200 #endif |
|
201 |
|
202 // End of File |
|