25
|
1 |
/*
|
|
2 |
* Copyright (c) 2007 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: Main class for Control Bar component.
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
#ifndef C_FSCONTROLBAR_H
|
|
20 |
#define C_FSCONTROLBAR_H
|
|
21 |
|
|
22 |
//<cmail> SF
|
|
23 |
#include <alf/alfcontrol.h>
|
|
24 |
#include <alf/alfenv.h>
|
|
25 |
//</cmail>
|
|
26 |
|
|
27 |
#include "fscontrolbuttonobserver.h"
|
|
28 |
#include "fscontrolbarobserver.h"
|
|
29 |
#include "fscontrolbuttonconst.h"
|
|
30 |
|
|
31 |
class MFsControlButtonInterface;
|
|
32 |
class CFsControlButton;
|
|
33 |
class CFsControlBarModel;
|
|
34 |
class CFsControlBarVisualiser;
|
|
35 |
class CAlfTexture;
|
|
36 |
class CAlfBrush;
|
|
37 |
class CFsTextStyleManager;
|
|
38 |
|
|
39 |
/** default value for focusing control bar */
|
|
40 |
const TInt KFocusFirstFocusableButton = -1;
|
|
41 |
|
|
42 |
/** value for current focused button - no button is focused */
|
|
43 |
const TInt KNoButtonFocused = -1;
|
|
44 |
|
|
45 |
|
|
46 |
/**
|
|
47 |
* Main class for ControlBar component
|
|
48 |
* Control class of ControlBar component.
|
|
49 |
*
|
|
50 |
* @code
|
|
51 |
*
|
|
52 |
* @endcode
|
|
53 |
*
|
|
54 |
* @lib fs_generic.lib
|
|
55 |
*/
|
|
56 |
NONSHARABLE_CLASS( CFsControlBar ) :
|
|
57 |
public CAlfControl,
|
|
58 |
public MFsControlButtonObserver,
|
|
59 |
public MAlfActionObserver
|
|
60 |
{
|
|
61 |
|
|
62 |
public:
|
|
63 |
|
|
64 |
/**
|
|
65 |
* Two-phased constructor.
|
|
66 |
*
|
|
67 |
* @param aEnv huitk environment instance.
|
|
68 |
*/
|
|
69 |
IMPORT_C static CFsControlBar* NewL( CAlfEnv& aEnv );
|
|
70 |
|
|
71 |
/**
|
|
72 |
* Two-phased constructor.
|
|
73 |
*
|
|
74 |
* @param aEnv huitk environment instance.
|
|
75 |
*/
|
|
76 |
IMPORT_C static CFsControlBar* NewLC( CAlfEnv& aEnv );
|
|
77 |
|
|
78 |
/**
|
|
79 |
* Destructor
|
|
80 |
*/
|
|
81 |
virtual ~CFsControlBar();
|
|
82 |
|
|
83 |
/**
|
|
84 |
* Adds button with specified id and layout to control bar.
|
|
85 |
*
|
|
86 |
* @param aId unique id of button.
|
|
87 |
* @param aType type of button.
|
|
88 |
*/
|
|
89 |
IMPORT_C void AddButtonL( TInt aId, TFsControlButtonType aType );
|
|
90 |
|
|
91 |
/**
|
|
92 |
* Adds button with specified layout to control bar and return id.
|
|
93 |
*
|
|
94 |
* @param aType type of button.
|
|
95 |
* @return unique id of button.
|
|
96 |
*/
|
|
97 |
IMPORT_C TInt AddButtonL( TFsControlButtonType aType );
|
|
98 |
|
|
99 |
/**
|
|
100 |
* Removes button with specified button (and all data it contains)
|
|
101 |
* from control bar
|
|
102 |
*
|
|
103 |
* @param aId id of button to be removed.
|
|
104 |
* @return KErrNotFound if button's id doesn't exist, otherwise KErrNone.
|
|
105 |
*/
|
|
106 |
IMPORT_C TInt RemoveButtonL( TInt aId );
|
|
107 |
|
|
108 |
/**
|
|
109 |
* Retrieves button with specified id from control bar.
|
|
110 |
*
|
|
111 |
* @param aId id of button to be retrieved.
|
|
112 |
* @return button with specified id.
|
|
113 |
*/
|
|
114 |
IMPORT_C MFsControlButtonInterface* ButtonById( TInt aId );
|
|
115 |
|
|
116 |
/**
|
|
117 |
* Change focused state.
|
|
118 |
* When focus is gained it is set to the first focusable button.
|
|
119 |
*
|
|
120 |
* @param aFocused ETrue to set the focus to the first button otherwise
|
|
121 |
* EFalse to lose the focus.
|
|
122 |
*/
|
|
123 |
IMPORT_C void SetFocusL( TBool aFocused = ETrue );
|
|
124 |
|
|
125 |
/**
|
|
126 |
* Sets focus to specified button.
|
|
127 |
*
|
|
128 |
* @param aButtonId id of button to set focus on.
|
|
129 |
*/
|
|
130 |
IMPORT_C void SetFocusByIdL( TInt aButtonId );
|
|
131 |
|
|
132 |
/**
|
|
133 |
* Gets focused button or NULL if not focused.
|
|
134 |
*
|
|
135 |
* @return focused button or NULL if bar not focused.
|
|
136 |
*/
|
|
137 |
IMPORT_C MFsControlButtonInterface* GetFocusedButton() const;
|
|
138 |
|
|
139 |
/**
|
|
140 |
* Set position and size
|
|
141 |
*/
|
|
142 |
virtual void SetRectL( const TRect& aRect );
|
|
143 |
|
|
144 |
/**
|
|
145 |
* Sets height of the bar in pixels.
|
|
146 |
*
|
|
147 |
* @param aHeight new height of the bar.
|
|
148 |
*/
|
|
149 |
IMPORT_C void SetHeightL( TInt aHeight );
|
|
150 |
|
|
151 |
/**
|
|
152 |
* Retrieves height of the bar in pixels.
|
|
153 |
*
|
|
154 |
* @return height of the bar in pixels.
|
|
155 |
*/
|
|
156 |
IMPORT_C TInt Height() const;
|
|
157 |
|
|
158 |
/**
|
|
159 |
* Sets width of the bar in pixels.
|
|
160 |
*
|
|
161 |
* @param aWidth new width of the bar.
|
|
162 |
*/
|
|
163 |
IMPORT_C void SetWidthL( TInt aWidth );
|
|
164 |
|
|
165 |
/**
|
|
166 |
* Retrieves width of the bar in pixels.
|
|
167 |
*
|
|
168 |
* @return width of the bar in pixels.
|
|
169 |
*/
|
|
170 |
IMPORT_C TInt Width() const;
|
|
171 |
|
|
172 |
/**
|
|
173 |
* Sets controlbar's background color.
|
|
174 |
*
|
|
175 |
* @param aColor color of background.
|
|
176 |
*/
|
|
177 |
IMPORT_C void SetBackgroundColor( const TRgb& aColor );
|
|
178 |
|
|
179 |
/**
|
|
180 |
* Clear controlbar's background color. It becomes transparent.
|
|
181 |
*/
|
|
182 |
IMPORT_C void ClearBackgroundColor();
|
|
183 |
|
|
184 |
/**
|
|
185 |
* Sets bar's background image.
|
|
186 |
*
|
|
187 |
* @param aImage background image.
|
|
188 |
*/
|
|
189 |
IMPORT_C void SetBackgroundImageL( CAlfTexture& aImage );
|
|
190 |
|
|
191 |
/**
|
|
192 |
* Clears bar's background image.
|
|
193 |
*/
|
|
194 |
IMPORT_C void ClearBackgroundImage();
|
|
195 |
|
|
196 |
/**
|
|
197 |
* Adds additional observer for the bar events.
|
|
198 |
*
|
|
199 |
* @param aObserver observer of bar's events.
|
|
200 |
*/
|
|
201 |
IMPORT_C void AddObserverL( MFsControlBarObserver& aObserver );
|
|
202 |
|
|
203 |
/**
|
|
204 |
* Removes specified observer from the bar events.
|
|
205 |
*
|
|
206 |
* @param aObserver observer to be removed.
|
|
207 |
*/
|
|
208 |
IMPORT_C void RemoveObserver( MFsControlBarObserver& aObserver );
|
|
209 |
|
|
210 |
/**
|
|
211 |
* Sets transition time for selector.
|
|
212 |
*
|
|
213 |
* @param aTransitionTime transition time in miliseconds.
|
|
214 |
*/
|
|
215 |
IMPORT_C void SetSelectorTransitionTimeL( TInt aTransitionTime );
|
|
216 |
|
|
217 |
/**
|
|
218 |
* Sets selector's image and opacity.
|
|
219 |
* Ownership of the brush is gained.
|
|
220 |
*
|
|
221 |
* @param aSelectorBrush New selector brush.
|
|
222 |
* @param aOpacity Selector's opacity.
|
|
223 |
*/
|
|
224 |
IMPORT_C void SetSelectorImageL(
|
|
225 |
CAlfBrush* aSelectorBrush, TReal32 aOpacity = 1.0 );
|
|
226 |
|
|
227 |
/**
|
|
228 |
* Retrieves amount of space in pixels from specified point to the end
|
|
229 |
* of the screen.
|
|
230 |
*
|
|
231 |
* @return Controlbar visual.
|
|
232 |
*/
|
|
233 |
IMPORT_C CAlfVisual* Visual();
|
|
234 |
|
|
235 |
/**
|
|
236 |
* Resolve the area reserved for requested layout slot.
|
|
237 |
*
|
|
238 |
* @param aIndex Index of requested layout slot. Indexing starts from one.
|
|
239 |
* @return Size and position of requested layout item.
|
|
240 |
*/
|
|
241 |
static TRect GetLayoutRect( TInt aIndex );
|
|
242 |
|
|
243 |
// <cmail> Touch
|
|
244 |
/**
|
|
245 |
* Disable or enable touch input
|
|
246 |
*/
|
|
247 |
IMPORT_C void EnableTouch(TBool aEnabled);
|
|
248 |
// </cmail>
|
|
249 |
|
|
250 |
/**
|
|
251 |
* Hides or shows selector.
|
|
252 |
* NOTE: Do not change focus.
|
|
253 |
*
|
|
254 |
* @param aShow if ETrue selector is shown.
|
|
255 |
* @param aFromTouch if method is called after touch event.
|
|
256 |
*/
|
|
257 |
IMPORT_C void MakeSelectorVisible( TBool aShow, TBool aFromTouch = EFalse );
|
|
258 |
|
|
259 |
// from base class MAlfActionObserver
|
|
260 |
|
|
261 |
/**
|
|
262 |
* From MAlfActionObserver.
|
|
263 |
* Called by the scheduler when an action command is executed.
|
|
264 |
*
|
|
265 |
* @param aActionCommand The command that is being executed.
|
|
266 |
*/
|
|
267 |
virtual void HandleActionL( const TAlfActionCommand& aActionCommand );
|
|
268 |
|
|
269 |
protected:
|
|
270 |
|
|
271 |
// from base class CAlfControl
|
|
272 |
|
|
273 |
/**
|
|
274 |
* From CAlfControl.
|
|
275 |
* Notifies the owner that the layout of a visual has been recalculated.
|
|
276 |
* Called only when the EAlfVisualFlagLayoutUpdateNotification flag has
|
|
277 |
* been set for the visual.
|
|
278 |
*
|
|
279 |
* @param aVisual Visual that has been laid out.
|
|
280 |
*/
|
|
281 |
virtual void VisualLayoutUpdated( CAlfVisual& aVisual );
|
|
282 |
|
|
283 |
/**
|
|
284 |
* From CAlfControl.
|
|
285 |
* Called when an input event is being offered to the control.
|
|
286 |
*
|
|
287 |
* @param aEvent Event to be handled.
|
|
288 |
* @return <code>ETrue</code>, if the event was handled. Otherwise
|
|
289 |
* <code>EFalse</code>.
|
|
290 |
*/
|
|
291 |
virtual TBool OfferEventL( const TAlfEvent& aEvent );
|
|
292 |
|
|
293 |
// from base class MFsControlButtonObserver
|
|
294 |
|
|
295 |
/**
|
|
296 |
* From MFsControlButtonObserver.
|
|
297 |
* Invoked when one of button from control bar is pressed.
|
|
298 |
*
|
|
299 |
* @param aEvent event type from button.
|
|
300 |
* @param aButtonId pressed button id.
|
|
301 |
*/
|
|
302 |
virtual TBool HandleButtonEvent(
|
|
303 |
TFsControlButtonEvent aEvent, TInt aButtonId );
|
|
304 |
|
|
305 |
private:
|
|
306 |
|
|
307 |
/**
|
|
308 |
* Constructor.
|
|
309 |
*
|
|
310 |
* @param aEnv huitk environment instance.
|
|
311 |
* @param aParent parent control to which events will be sent.
|
|
312 |
*/
|
|
313 |
CFsControlBar();
|
|
314 |
|
|
315 |
/**
|
|
316 |
* Constructs and initializes bar control.
|
|
317 |
*/
|
|
318 |
void ConstructL( CAlfEnv& aEnv );
|
|
319 |
|
|
320 |
/**
|
|
321 |
* Sends event to observers.
|
|
322 |
*
|
|
323 |
* @param aEvent event sent to observers
|
|
324 |
* @param aData additional data sent with event
|
|
325 |
*/
|
|
326 |
void NotifyObservers(
|
|
327 |
MFsControlBarObserver::TFsControlBarEvent aEvent,
|
|
328 |
TInt aData = -1 );
|
|
329 |
|
|
330 |
/**
|
|
331 |
* Changes focus to another button or looses focus from control bar.
|
|
332 |
*
|
|
333 |
* @param aButton pointer to button which schould be focused.
|
|
334 |
* If NULL focus is lost by the control bar.
|
|
335 |
*/
|
|
336 |
void ChangeFocusL(
|
|
337 |
CFsControlButton* aButton, TBool aMakeSelectorVisible = EFalse );
|
|
338 |
|
|
339 |
/**
|
|
340 |
* Sets needed variables when bar loses focus.
|
|
341 |
*
|
|
342 |
* @param aLooseFocusEvent cause of focus lost.
|
|
343 |
*/
|
|
344 |
void LooseFocus(
|
|
345 |
MFsControlBarObserver::TFsControlBarEvent aLooseFocusEvent );
|
|
346 |
|
|
347 |
private: // data
|
|
348 |
|
|
349 |
/**
|
|
350 |
* Control bar's model
|
|
351 |
* Own.
|
|
352 |
*/
|
|
353 |
CFsControlBarModel* iModel;
|
|
354 |
|
|
355 |
/**
|
|
356 |
* Control bar's visualiser
|
|
357 |
* Own.
|
|
358 |
*/
|
|
359 |
CFsControlBarVisualiser* iVisualiser;
|
|
360 |
|
|
361 |
/**
|
|
362 |
* Selected button index.
|
|
363 |
*/
|
|
364 |
TInt iSelectedButton;
|
|
365 |
|
|
366 |
/**
|
|
367 |
* Collection of additional Observers.
|
|
368 |
*/
|
|
369 |
RPointerArray< MFsControlBarObserver > iObservers;
|
|
370 |
|
|
371 |
/**
|
|
372 |
* Last screen width.
|
|
373 |
*/
|
|
374 |
TInt iLastScreenWidth;
|
|
375 |
|
|
376 |
/**
|
|
377 |
* Text style manager.
|
|
378 |
* Own.
|
|
379 |
*/
|
|
380 |
CFsTextStyleManager* iTextStyleManager;
|
|
381 |
|
|
382 |
// <cmail> Touch
|
|
383 |
/**
|
|
384 |
* Control touch
|
|
385 |
*/
|
|
386 |
TBool iTouchEnabled;
|
|
387 |
TBool iTouchWasEnabled;
|
|
388 |
// </cmail>
|
|
389 |
|
|
390 |
|
|
391 |
};
|
|
392 |
|
|
393 |
|
|
394 |
#endif // C_FSCONTROLBAR_H
|