66
|
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: Provides a way to invoke some functionality
|
|
15 |
* which can run in LCDUI ES thread only
|
|
16 |
*
|
|
17 |
*/
|
|
18 |
|
|
19 |
|
|
20 |
#ifndef CMIDTOLCDUIOBSERVER_H
|
|
21 |
#define CMIDTOLCDUIOBSERVER_H
|
|
22 |
|
|
23 |
// Using RPointerArray
|
|
24 |
#include <e32std.h>
|
|
25 |
// Using RMsgQueue
|
|
26 |
#include <e32msgqueue.h>
|
|
27 |
|
|
28 |
#include "lcdui.h"
|
|
29 |
|
|
30 |
// Forward declarations
|
|
31 |
class MUiEventConsumer;
|
|
32 |
class CCoeControl;
|
|
33 |
|
|
34 |
/**
|
|
35 |
* Provides a way to make calls to functions which are able
|
|
36 |
* to run in LCDUI Event Server thread only and
|
|
37 |
* which may origin in non-lcdui thread (MMAPI for instance).
|
|
38 |
*
|
|
39 |
* The calls are kept in queue and processed serially.
|
|
40 |
*
|
|
41 |
* If the call works with some CCoeControl instance,
|
|
42 |
* ther control must be registered by RegisterControl().
|
|
43 |
*
|
|
44 |
* Some events may invoke a callback into specified callback interface.
|
|
45 |
* The receiver of this callback must not be deleted if there is
|
|
46 |
* a possibility of having some events, which will call this, in queue.
|
|
47 |
*
|
|
48 |
* The callback receiver can for example implement
|
|
49 |
* its instance deletion via event using this observer,
|
|
50 |
* so this deletion event will be the last one for that receiver.
|
|
51 |
*
|
|
52 |
* @lib lcdui.dll
|
|
53 |
* @since S60 v5.0
|
|
54 |
*/
|
|
55 |
class CMIDToLcduiObserver : public CActive, public MMIDToLcduiObserver
|
|
56 |
{
|
|
57 |
public:
|
|
58 |
/**
|
|
59 |
* Constructor.
|
|
60 |
*/
|
|
61 |
CMIDToLcduiObserver();
|
|
62 |
|
|
63 |
/**
|
|
64 |
* Destructor.
|
|
65 |
*/
|
|
66 |
~CMIDToLcduiObserver();
|
|
67 |
|
|
68 |
// from base MMIDToLcduiObserver
|
|
69 |
|
|
70 |
/**
|
|
71 |
* From MMIDToLcduiObserver.
|
|
72 |
* Allows a control to be used during event processing.
|
|
73 |
*
|
|
74 |
* @since S60 5.0
|
|
75 |
* @param aControl Control to be registered.
|
|
76 |
* @param aCallbackContainer MDirectContainer that is nofied in LCDUI thread
|
|
77 |
* about added MDirectContent. NULL, if notification
|
|
78 |
* is not needed.
|
|
79 |
*/
|
|
80 |
#ifdef RD_JAVA_NGA_ENABLED
|
|
81 |
virtual void RegisterControl(CCoeControl& aControl,
|
|
82 |
MDirectContainer* aCallbackContainer = NULL);
|
|
83 |
#else
|
|
84 |
virtual void RegisterControl(CCoeControl& aControl);
|
|
85 |
#endif
|
|
86 |
|
|
87 |
/**
|
|
88 |
* From MMIDToLcduiObserver.
|
|
89 |
* Removes a control from the list of controls allowed
|
|
90 |
* to be used in event processing.
|
|
91 |
* Events which works with this control will be ignored.
|
|
92 |
*
|
|
93 |
* @since S60 5.0
|
|
94 |
* @param aControl Control to be unregistered.
|
|
95 |
*/
|
|
96 |
virtual void UnregisterControl(CCoeControl& aControl);
|
|
97 |
|
|
98 |
/**
|
|
99 |
* From MMIDToLcduiObserver.
|
|
100 |
* Flushes the control's graphics content on screen.
|
|
101 |
* The call may origin in other than LCDUI ES thread.
|
|
102 |
*
|
|
103 |
* @since S60 5.0
|
|
104 |
* @param aControl Control used to get DSA resources from.
|
|
105 |
* @param aRect An area of the control to flush.
|
|
106 |
*/
|
|
107 |
virtual void FlushControl(CCoeControl& aControl, const TRect &aRect);
|
|
108 |
|
|
109 |
/**
|
|
110 |
* From MMIDToLcduiObserver.
|
|
111 |
* Invokes aConsumer->MdcDSAResourcesCallback from LCDUI ES thread.
|
|
112 |
* The call may origin in other than LCDUI ES thread.
|
|
113 |
*
|
|
114 |
* @since S60 5.0
|
|
115 |
* @param aControl Control used to get DSA resources from.
|
|
116 |
* @param aConsumer Consumer of the callback. The instance
|
|
117 |
* must not be deleted before the event processed.
|
|
118 |
*/
|
|
119 |
void InvokeDSAResourcesCallback(
|
|
120 |
CCoeControl& aControl,
|
|
121 |
MUiEventConsumer& aConsumer);
|
|
122 |
|
|
123 |
/**
|
|
124 |
* From MMIDToLcduiObserver.
|
|
125 |
* Invokes aConsumer->MdcUICallback( aCallbackId ) from LCDUI ES thread.
|
|
126 |
* The call may origin in other than LCDUI ES thread.
|
|
127 |
*
|
|
128 |
* @since S60 5.0
|
|
129 |
* @param aConsumer Consumer of the callback.
|
|
130 |
* @param aCallbackId Id which is provided to the callback
|
|
131 |
*/
|
|
132 |
void InvokeUICallback(MUiEventConsumer& aConsumer, TInt aCallbackId);
|
|
133 |
|
|
134 |
/**
|
|
135 |
* Invokes MDirectContainer::InvokeLcduiEvent in UI thread.
|
|
136 |
*
|
|
137 |
* @since S60 9.2
|
|
138 |
* @param aControl CCoeControl pointer needed for checking that registered
|
|
139 |
* control has not unregistered yet.
|
|
140 |
* @param aContainer The container to be notifed.
|
|
141 |
*/
|
|
142 |
void InvokeLcduiEvent(
|
|
143 |
MMIDLcduiEventConsumer& aConsumer,
|
|
144 |
TInt aCallbackId);
|
|
145 |
|
|
146 |
private:
|
|
147 |
/** CMIDToLcduiObserver event datatype */
|
|
148 |
enum TToLcduiEventType
|
|
149 |
{
|
|
150 |
EFlushEvent,
|
|
151 |
EDSAResourcesCallbackEvent,
|
|
152 |
EUICallbackEvent
|
|
153 |
#ifdef RD_JAVA_NGA_ENABLED
|
|
154 |
,ENotifyContentAdded
|
|
155 |
#endif
|
|
156 |
,ELcduiEvent
|
|
157 |
};
|
|
158 |
|
|
159 |
/** CMIDToLcduiObserver event content datatype */
|
|
160 |
struct TToLcduiEventData
|
|
161 |
{
|
|
162 |
TToLcduiEventType iType;
|
|
163 |
CCoeControl* iControl;
|
|
164 |
TRect iRect;
|
|
165 |
void* iConsumer;
|
|
166 |
TInt iId;
|
|
167 |
#ifdef RD_JAVA_NGA_ENABLED
|
|
168 |
MDirectContainer* iContainer;
|
|
169 |
#endif
|
|
170 |
};
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Redraws area on component.
|
|
174 |
*
|
|
175 |
* @since S60 5.0
|
|
176 |
* @param aControl Control to redraw.
|
|
177 |
* Must be registered by RegisterControl.
|
|
178 |
* @param aRect Area to redraw.
|
|
179 |
*/
|
|
180 |
void DoFlushControl(CCoeControl* aControl, const TRect& aRect);
|
|
181 |
|
|
182 |
/**
|
|
183 |
* Invokes callback aConsumer->MdcDSAResourcesCallback.
|
|
184 |
*
|
|
185 |
* @since S60 5.0
|
|
186 |
* @param aControl Control used to get DSA resources from.
|
|
187 |
* Must be registered by RegisterControl.
|
|
188 |
* @param aConsumer Consumer of the callback.
|
|
189 |
*/
|
|
190 |
void DoInvokeDSAResourcesCallback(
|
|
191 |
CCoeControl* aControl,
|
|
192 |
MUiEventConsumer *aConsumer);
|
|
193 |
|
|
194 |
/**
|
|
195 |
* Invokes callback aConsumer->HandleLcduiEvent(aCallbackId)
|
|
196 |
*
|
|
197 |
* @since S60 9.2
|
|
198 |
* @param aConsumer Consumer of the callback.
|
|
199 |
* @param aCallbackId Id which is provided to the callback
|
|
200 |
*/
|
|
201 |
void DoInvokeLcduiEvent(
|
|
202 |
MMIDLcduiEventConsumer *aConsumer,
|
|
203 |
TInt aCallbackId);
|
|
204 |
|
|
205 |
/**
|
|
206 |
* Invokes callback aConsumer->MdcUICallback
|
|
207 |
*
|
|
208 |
* @since S60 5.0
|
|
209 |
* @param aConsumer Consumer of the callback.
|
|
210 |
* @param aCallbackId Id which is provided to the callback
|
|
211 |
*/
|
|
212 |
void DoInvokeUICallback(
|
|
213 |
MUiEventConsumer *aConsumer,
|
|
214 |
TInt aCallbackId);
|
|
215 |
|
|
216 |
|
|
217 |
#ifdef RD_JAVA_NGA_ENABLED
|
|
218 |
/**
|
|
219 |
* Invokes MDirectContainer::MdcNotifyContentAdded in UI thread.
|
|
220 |
*
|
|
221 |
* @since S60 9.2
|
|
222 |
* @param aControl CCoeControl pointer needed for checking that registered
|
|
223 |
* control has not unregistered yet.
|
|
224 |
* @param aContainer The container to be notifed.
|
|
225 |
*/
|
|
226 |
void DoInvokeNotifyContentAdded(
|
|
227 |
CCoeControl* aControl,
|
|
228 |
MDirectContainer *aContainer);
|
|
229 |
#endif
|
|
230 |
|
|
231 |
// from base class CActive
|
|
232 |
|
|
233 |
/**
|
|
234 |
* From CActive.
|
|
235 |
* Handles an active object’s request completion event.
|
|
236 |
* Processes the first available event in queue.
|
|
237 |
*
|
|
238 |
* @since S60 5.0
|
|
239 |
*/
|
|
240 |
virtual void RunL();
|
|
241 |
|
|
242 |
/**
|
|
243 |
* From CActive.
|
|
244 |
* Implements cancellation of an outstanding request.
|
|
245 |
*
|
|
246 |
* @since S60 5.0
|
|
247 |
*/
|
|
248 |
virtual void DoCancel();
|
|
249 |
|
|
250 |
private:
|
|
251 |
/**
|
|
252 |
* Event queue to store the call requests
|
|
253 |
* Own.
|
|
254 |
*/
|
|
255 |
RMsgQueue<TToLcduiEventData> iEventQueue;
|
|
256 |
|
|
257 |
/**
|
|
258 |
* List of controls registered to allowed its usage
|
|
259 |
* during event processing.
|
|
260 |
* Controls are not owned.
|
|
261 |
* Own.
|
|
262 |
*/
|
|
263 |
RPointerArray<CCoeControl> iRegisteredControls;
|
|
264 |
};
|
|
265 |
|
|
266 |
|
|
267 |
#endif // CMIDTOLCDUIOBSERVER_H
|