60
|
1 |
/*
|
|
2 |
* Copyright (c) 2008-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: Navigational state of the app
|
|
15 |
*
|
|
16 |
*/
|
|
17 |
|
|
18 |
|
|
19 |
|
|
20 |
|
|
21 |
#include "glxnavigationalstate.h"
|
|
22 |
|
|
23 |
#include <glxassert.h>
|
|
24 |
#include <glxsingletonstore.h>
|
|
25 |
#include <mpxcollectionobserver.h>
|
|
26 |
#include <mpxcollectionmessage.h>
|
|
27 |
#include <mpxcollectionpath.h>
|
|
28 |
#include <mpxcollectionutility.h>
|
|
29 |
#include <mpxmessagegeneraldefs.h>
|
|
30 |
#include <mpxviewutility.h> // MMPXViewUtility
|
|
31 |
#include "mglxnavigationalstateobserver.h"
|
|
32 |
#include <eikappui.h>
|
|
33 |
#include <eikenv.h>
|
|
34 |
|
|
35 |
#include <glxtracer.h>
|
|
36 |
|
|
37 |
#include <glxlog.h>
|
|
38 |
|
|
39 |
/**
|
|
40 |
* CGlxNavigationalStateImp
|
|
41 |
*
|
|
42 |
* Implementation of navigational state
|
|
43 |
* Note: function entry-exit logging is in CGlxNavigationalState,
|
|
44 |
* not in CGlxNavigationalStateImp.
|
|
45 |
*
|
|
46 |
* @author Aki Vanhatalo
|
|
47 |
*/
|
|
48 |
class CGlxNavigationalStateImp : public CBase, public MMPXCollectionObserver
|
|
49 |
{
|
|
50 |
public:
|
|
51 |
/**
|
|
52 |
* Second-phase constructor
|
|
53 |
* inlined since used only once from CGlxNavigationalState
|
|
54 |
*/
|
|
55 |
inline void ConstructL()
|
|
56 |
{
|
|
57 |
iCollectionUtility = MMPXCollectionUtility::NewL( this );
|
|
58 |
iViewUtility = MMPXViewUtility::UtilityL();
|
|
59 |
iViewingMode = NGlxNavigationalState::EBrowse;
|
|
60 |
}
|
|
61 |
|
|
62 |
/** Destructor */
|
|
63 |
~CGlxNavigationalStateImp()
|
|
64 |
{
|
|
65 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalStateImp::~CGlxNavigationalStateImp");
|
|
66 |
if ( iCollectionUtility )
|
|
67 |
{
|
|
68 |
iCollectionUtility->Close();
|
|
69 |
}
|
|
70 |
|
|
71 |
if ( iViewUtility )
|
|
72 |
{
|
|
73 |
iViewUtility->Close();
|
|
74 |
}
|
|
75 |
// Log a warning if observers remaining; they should have been removed by the client
|
|
76 |
__ASSERT_DEBUG( !iObservers.Count(),
|
|
77 |
GLX_LOG_WARNING1( "CGlxNavigationalStateImp - %d observers not removed", iObservers.Count() ) );
|
|
78 |
|
|
79 |
iObservers.Close();
|
|
80 |
}
|
|
81 |
|
|
82 |
/**
|
|
83 |
* Add an observer
|
|
84 |
* inlined since used only once from CGlxNavigationalState
|
|
85 |
* @param aObserver Observer of changes to state
|
|
86 |
*/
|
|
87 |
inline void AddObserverL( MGlxNavigationalStateObserver& aObserver )
|
|
88 |
{
|
|
89 |
GLX_LOG_INFO1("CGlxNavigationalStateImp::AddObserverL %x", &aObserver);
|
|
90 |
__ASSERT_DEBUG( KErrNotFound == iObservers.Find( &aObserver ),
|
|
91 |
GLX_LOG_WARNING( "CGlxNavigationalStateImp - Observer already added" ) );
|
|
92 |
|
|
93 |
// Add the observer, unless already added
|
|
94 |
if ( KErrNotFound == iObservers.Find( &aObserver ) )
|
|
95 |
{
|
|
96 |
iObservers.AppendL( &aObserver );
|
|
97 |
}
|
|
98 |
}
|
|
99 |
|
|
100 |
/**
|
|
101 |
* Remove an observer
|
|
102 |
* inlined since used only once from CGlxNavigationalState
|
|
103 |
* @param aObserver Observer to remove
|
|
104 |
*/
|
|
105 |
inline void RemoveObserver( MGlxNavigationalStateObserver& aObserver )
|
|
106 |
{
|
|
107 |
GLX_LOG_INFO1("CGlxNavigationalStateImp::RemoveObserver %x", &aObserver);
|
|
108 |
|
|
109 |
// Remove the observer if exists
|
|
110 |
TInt index = iObservers.Find( &aObserver );
|
|
111 |
if ( KErrNotFound != index )
|
|
112 |
{
|
|
113 |
iObservers.Remove( index );
|
|
114 |
}
|
|
115 |
|
|
116 |
__ASSERT_DEBUG( KErrNotFound != index,
|
|
117 |
GLX_LOG_WARNING( "CGlxNavigationalStateImp - No such observer to remove" ) );
|
|
118 |
}
|
|
119 |
|
|
120 |
/**
|
|
121 |
* @return the current navigational state. Caller gets ownership.
|
|
122 |
*/
|
|
123 |
CMPXCollectionPath* StateLC() const
|
|
124 |
{
|
|
125 |
GLX_LOG_ENTRY_EXIT("CGlxNavigationalStateImp::StateLC");
|
|
126 |
|
|
127 |
// state is stored in the collection utility as a collection path
|
|
128 |
CMPXCollectionPath* state = Collection().PathL();
|
|
129 |
CleanupStack::PushL( state );
|
|
130 |
|
|
131 |
// go up one level in hierarchy, since the path contains also the
|
|
132 |
// currently open level, not only the nodes to the level
|
|
133 |
state->Back();
|
|
134 |
|
|
135 |
return state;
|
|
136 |
}
|
|
137 |
|
|
138 |
/**
|
|
139 |
* Navigate back in the UI hierarchy
|
|
140 |
* Does nothing, if currently at root.
|
|
141 |
*/
|
|
142 |
inline void NavigateToParentL()
|
|
143 |
{
|
|
144 |
TRACER("CGlxNavigationalStateImp::NavigateToParentL()");
|
|
145 |
if ( ViewingMode()== NGlxNavigationalState::EView )
|
|
146 |
{
|
|
147 |
GLX_LOG_INFO("CGlxNavigationalStateImp::NavigateToParentL() -1");
|
|
148 |
iViewingMode = NGlxNavigationalState::EBrowse;
|
|
149 |
NotifyObserversOfStateChange();
|
|
150 |
}
|
|
151 |
else
|
|
152 |
{
|
|
153 |
GLX_LOG_INFO("CGlxNavigationalStateImp::NavigateToParentL() -2");
|
|
154 |
Collection().BackL();
|
|
155 |
}
|
|
156 |
}
|
|
157 |
|
|
158 |
/**
|
|
159 |
* Navigate forward to provided item
|
|
160 |
* @param aItemToOpen Id of item to navigate to
|
|
161 |
*/
|
|
162 |
void NavigateToChildL( const TGlxMediaId& aItemIdToOpen )
|
|
163 |
{
|
|
164 |
// there is no way to open MPX collection utility's current state with
|
|
165 |
// and id of a child item, so create a full path object and add the
|
|
166 |
// requested item's id as the new level
|
|
167 |
iViewingMode = NGlxNavigationalState::EBrowse;
|
|
168 |
CMPXCollectionPath* state = StateLC();
|
|
169 |
state->AppendL( aItemIdToOpen.Value() );
|
|
170 |
|
|
171 |
NavigateToL( *state );
|
|
172 |
|
|
173 |
CleanupStack::PopAndDestroy( state );
|
|
174 |
}
|
|
175 |
|
|
176 |
/**
|
|
177 |
* Navigate to provided position in hierarchy
|
|
178 |
* @param aNewState Path object which describes the new position in hierarchy
|
|
179 |
*/
|
|
180 |
inline void NavigateToL( const CMPXCollectionPath& aNewState )
|
|
181 |
{
|
|
182 |
// (it does not matter that the root level is opened without
|
|
183 |
// gallery plugin filter (EGlxCollectionPluginGallery), as long as
|
|
184 |
// the root level is *rendered* with something that uses the filter,
|
|
185 |
// such as a media list)
|
|
186 |
if(!iIsNavigating)
|
|
187 |
{
|
|
188 |
iViewingMode = NGlxNavigationalState::EBrowse;
|
|
189 |
Collection().OpenL( aNewState );
|
|
190 |
iIsNavigating = ETrue;
|
|
191 |
}
|
|
192 |
}
|
|
193 |
|
|
194 |
// commented off by gopakumar , as this is no longer needed .
|
|
195 |
/**
|
|
196 |
* Set the ID of the view that will be activated if there are no other
|
|
197 |
* view's in the view history
|
|
198 |
*/
|
|
199 |
/*inline void SetFirstViewId( TVwsViewId aViewId )
|
|
200 |
{
|
|
201 |
// Save the view Id
|
|
202 |
iViewId = aViewId;
|
|
203 |
}*/
|
|
204 |
|
|
205 |
/**
|
|
206 |
* Activate previous view
|
|
207 |
*/
|
|
208 |
inline void ActivatePreviousViewL()
|
|
209 |
{
|
|
210 |
if (!iIsNavigating)
|
|
211 |
{
|
|
212 |
iViewingMode = NGlxNavigationalState::EBrowse;
|
|
213 |
//go back one view
|
|
214 |
if (iViewUtility->ViewHistoryDepth() > 1)
|
|
215 |
{
|
|
216 |
iViewUtility->ActivatePreviousViewL();
|
|
217 |
}
|
|
218 |
}
|
|
219 |
}
|
|
220 |
|
|
221 |
|
|
222 |
// From MMPXCollectionObserver
|
|
223 |
void HandleCollectionMessageL( const CMPXMessage& aMessage )
|
|
224 |
{
|
|
225 |
TRACER( "CGlxNavigationalStateImp::HandleCollectionMessageL" );
|
|
226 |
|
|
227 |
if ( IsPathChangedMessage( aMessage ) )
|
|
228 |
{
|
|
229 |
NotifyObserversOfStateChange();
|
|
230 |
iIsNavigating = EFalse;
|
|
231 |
}
|
|
232 |
}
|
|
233 |
|
|
234 |
// From MMPXCollectionObserver
|
|
235 |
void HandleOpenL( const CMPXMedia& /*aEntries*/, TInt /*aIndex*/,
|
|
236 |
TBool /*aComplete*/, TInt /*aError*/ )
|
|
237 |
{
|
|
238 |
// do nothing
|
|
239 |
}
|
|
240 |
|
|
241 |
// From MMPXCollectionObserver
|
|
242 |
void HandleOpenL( const CMPXCollectionPlaylist& /*aPlaylist*/, TInt /*aError*/ )
|
|
243 |
{
|
|
244 |
// do nothing
|
|
245 |
}
|
|
246 |
|
|
247 |
// From MMPXCollectionObserver
|
|
248 |
void HandleCollectionMediaL( const CMPXMedia& /*aMedia*/, TInt /*aError*/ )
|
|
249 |
{
|
|
250 |
// do nothing
|
|
251 |
}
|
|
252 |
void SetToViewMode()
|
|
253 |
{
|
|
254 |
iViewingMode = NGlxNavigationalState::EView;
|
|
255 |
// inform the observers( only appui ) that the mode is view
|
|
256 |
NotifyObserversOfStateChange();
|
|
257 |
|
|
258 |
}
|
|
259 |
NGlxNavigationalState::TViewingMode ViewingMode()
|
|
260 |
{
|
|
261 |
return iViewingMode;
|
|
262 |
}
|
|
263 |
|
|
264 |
private:
|
|
265 |
/** Notify observers of state change */
|
|
266 |
inline void NotifyObserversOfStateChange()
|
|
267 |
{
|
|
268 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalStateImp::NotifyObserversOfStateChange" );
|
|
269 |
// iObservers::Count() used in loop: ok, since unlikely to have many observers
|
|
270 |
for ( TInt i = 0; i < iObservers.Count(); i++ )
|
|
271 |
{
|
|
272 |
iObservers[ i ]->HandleNavigationalStateChangedL();
|
|
273 |
}
|
|
274 |
}
|
|
275 |
|
|
276 |
/** @return MPX collection */
|
|
277 |
inline MMPXCollection& Collection() const
|
|
278 |
{
|
|
279 |
return iCollectionUtility->Collection();
|
|
280 |
}
|
|
281 |
|
|
282 |
/**
|
|
283 |
* @param aMessage message to test
|
|
284 |
* @return ETrue if the message is a "path changed" message
|
|
285 |
*/
|
|
286 |
inline TBool IsPathChangedMessage( const CMPXMessage& aMessage )
|
|
287 |
{
|
|
288 |
// message is a "path changed" message if message id is KMPXMessageGeneral
|
|
289 |
// and KMPXMessageGeneralEvent attribute is EPathChanged
|
|
290 |
return ( aMessage.IsSupported(KMPXMessageGeneralId )
|
|
291 |
&& KMPXMessageGeneral == aMessage.ValueTObjectL<TInt>( KMPXMessageGeneralId )
|
|
292 |
&& aMessage.IsSupported( KMPXMessageGeneralEvent )
|
|
293 |
&& TMPXCollectionMessage::EPathChanged == aMessage.ValueTObjectL<TInt>( KMPXMessageGeneralEvent ) );
|
|
294 |
}
|
|
295 |
|
|
296 |
private:
|
|
297 |
/// Collection utility that stores the path to represent current navigational
|
|
298 |
/// state
|
|
299 |
MMPXCollectionUtility* iCollectionUtility;
|
|
300 |
MMPXViewUtility* iViewUtility;
|
|
301 |
NGlxNavigationalState::TViewingMode iViewingMode;
|
|
302 |
/// List of observers
|
|
303 |
RPointerArray< MGlxNavigationalStateObserver > iObservers;
|
|
304 |
|
|
305 |
TBool iIsNavigating; // If ETrue it means Navigating is already happening, so not allowed to navigate before current navigation Completes.
|
|
306 |
// If EFalse it means Navigation can happen
|
|
307 |
|
|
308 |
};
|
|
309 |
|
|
310 |
// -----------------------------------------------------------------------------
|
|
311 |
// InstanceL
|
|
312 |
// -----------------------------------------------------------------------------
|
|
313 |
//
|
|
314 |
EXPORT_C CGlxNavigationalState* CGlxNavigationalState::InstanceL()
|
|
315 |
{
|
|
316 |
GLX_LOG_INFO( "CGlxNavigationalState::InstanceL" );
|
|
317 |
return CGlxSingletonStore::InstanceL( &NewL );
|
|
318 |
}
|
|
319 |
|
|
320 |
// -----------------------------------------------------------------------------
|
|
321 |
// NewL
|
|
322 |
// -----------------------------------------------------------------------------
|
|
323 |
//
|
|
324 |
CGlxNavigationalState* CGlxNavigationalState::NewL()
|
|
325 |
{
|
|
326 |
GLX_LOG_INFO( "CGlxNavigationalState::NewL" );
|
|
327 |
CGlxNavigationalState* self = new ( ELeave ) CGlxNavigationalState;
|
|
328 |
CleanupStack::PushL( self );
|
|
329 |
|
|
330 |
// Construct implementation object
|
|
331 |
self->iImp = new ( ELeave ) CGlxNavigationalStateImp;
|
|
332 |
self->iImp->ConstructL();
|
|
333 |
|
|
334 |
CleanupStack::Pop( self );
|
|
335 |
return self;
|
|
336 |
}
|
|
337 |
|
|
338 |
|
|
339 |
// -----------------------------------------------------------------------------
|
|
340 |
// Destructor
|
|
341 |
// -----------------------------------------------------------------------------
|
|
342 |
//
|
|
343 |
CGlxNavigationalState::~CGlxNavigationalState()
|
|
344 |
{
|
|
345 |
delete iImp;
|
|
346 |
}
|
|
347 |
|
|
348 |
// -----------------------------------------------------------------------------
|
|
349 |
// Close a reference
|
|
350 |
// -----------------------------------------------------------------------------
|
|
351 |
//
|
|
352 |
EXPORT_C void CGlxNavigationalState::Close()
|
|
353 |
{
|
|
354 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalState::Close");
|
|
355 |
|
|
356 |
// Decrease reference count, and delete if last one
|
|
357 |
CGlxSingletonStore::Close( this );
|
|
358 |
// Member variable access not safe after CGlxSingletonStore::Close()
|
|
359 |
}
|
|
360 |
|
|
361 |
// -----------------------------------------------------------------------------
|
|
362 |
// Close a reference
|
|
363 |
// -----------------------------------------------------------------------------
|
|
364 |
//
|
|
365 |
EXPORT_C void CGlxNavigationalState::AddObserverL(
|
|
366 |
MGlxNavigationalStateObserver& aObserver )
|
|
367 |
{
|
|
368 |
GLX_LOG_INFO1( "CGlxNavigationalState::AddObserverL %x", &aObserver );
|
|
369 |
iImp->AddObserverL( aObserver );
|
|
370 |
}
|
|
371 |
|
|
372 |
// -----------------------------------------------------------------------------
|
|
373 |
// Close a reference
|
|
374 |
// -----------------------------------------------------------------------------
|
|
375 |
//
|
|
376 |
EXPORT_C void CGlxNavigationalState::RemoveObserver(
|
|
377 |
MGlxNavigationalStateObserver& aObserver )
|
|
378 |
{
|
|
379 |
GLX_LOG_INFO1( "CGlxNavigationalState::RemoveObserver %x", &aObserver );
|
|
380 |
iImp->RemoveObserver( aObserver );
|
|
381 |
}
|
|
382 |
|
|
383 |
// -----------------------------------------------------------------------------
|
|
384 |
// Close a reference
|
|
385 |
// -----------------------------------------------------------------------------
|
|
386 |
//
|
|
387 |
EXPORT_C CMPXCollectionPath* CGlxNavigationalState::StateLC() const
|
|
388 |
{
|
|
389 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalState::StateLC" );
|
|
390 |
return iImp->StateLC();
|
|
391 |
}
|
|
392 |
|
|
393 |
// -----------------------------------------------------------------------------
|
|
394 |
// Navigate to parent item
|
|
395 |
// -----------------------------------------------------------------------------
|
|
396 |
//
|
|
397 |
EXPORT_C void CGlxNavigationalState::NavigateToParentL()
|
|
398 |
{
|
|
399 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalState::NavigateToParentL" );
|
|
400 |
iImp->NavigateToParentL();
|
|
401 |
}
|
|
402 |
|
|
403 |
// -----------------------------------------------------------------------------
|
|
404 |
// Navigate to a child item
|
|
405 |
// -----------------------------------------------------------------------------
|
|
406 |
//
|
|
407 |
EXPORT_C void CGlxNavigationalState::NavigateToChildL(
|
|
408 |
const TGlxMediaId& aItemIdToOpen )
|
|
409 |
{
|
|
410 |
// GLX_LOG_INFO1( "CGlxNavigationalState::NavigateToChildL %d", aItemIdToOpen.Value() );
|
|
411 |
iImp->NavigateToChildL( aItemIdToOpen );
|
|
412 |
}
|
|
413 |
|
|
414 |
// -----------------------------------------------------------------------------
|
|
415 |
// Navigate to a path
|
|
416 |
// -----------------------------------------------------------------------------
|
|
417 |
//
|
|
418 |
EXPORT_C void CGlxNavigationalState::NavigateToL( const CMPXCollectionPath& aState )
|
|
419 |
{
|
|
420 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalState::NavigateToL");
|
|
421 |
iImp->NavigateToL( aState );
|
|
422 |
}
|
|
423 |
|
|
424 |
// -----------------------------------------------------------------------------
|
|
425 |
// Activate previous view
|
|
426 |
// -----------------------------------------------------------------------------
|
|
427 |
//
|
|
428 |
EXPORT_C void CGlxNavigationalState::ActivatePreviousViewL()
|
|
429 |
{
|
|
430 |
GLX_LOG_ENTRY_EXIT( "CGlxNavigationalState::ActivatePreviousViewL");
|
|
431 |
iImp->ActivatePreviousViewL();
|
|
432 |
}
|
|
433 |
|
|
434 |
// -----------------------------------------------------------------------------
|
|
435 |
// Set the ViewingMode
|
|
436 |
// -----------------------------------------------------------------------------
|
|
437 |
//
|
|
438 |
EXPORT_C void CGlxNavigationalState::SetToViewMode()
|
|
439 |
{
|
|
440 |
iImp->SetToViewMode();
|
|
441 |
// inform the observers( only appui ) that the mode is view
|
|
442 |
}
|
|
443 |
|
|
444 |
// -----------------------------------------------------------------------------
|
|
445 |
// Get the ViewingMode
|
|
446 |
// -----------------------------------------------------------------------------
|
|
447 |
//
|
|
448 |
EXPORT_C NGlxNavigationalState::TViewingMode CGlxNavigationalState::ViewingMode()
|
|
449 |
{
|
|
450 |
return iImp->ViewingMode();
|
|
451 |
}
|
|
452 |
// -----------------------------------------------------------------------------
|
|
453 |
// Set the BackExitStatus
|
|
454 |
// -----------------------------------------------------------------------------
|
|
455 |
//
|
|
456 |
EXPORT_C void CGlxNavigationalState::SetBackExitStatus(TBool aStatus)
|
|
457 |
{
|
|
458 |
iBackExitStatus = aStatus;
|
|
459 |
}
|
|
460 |
|
|
461 |
// -----------------------------------------------------------------------------
|
|
462 |
// Get the BackExitStatus
|
|
463 |
// -----------------------------------------------------------------------------
|
|
464 |
//
|
|
465 |
EXPORT_C TBool CGlxNavigationalState::BackExitStatus()
|
|
466 |
{
|
|
467 |
return iBackExitStatus;
|
|
468 |
}
|
|
469 |
|
|
470 |
// -----------------------------------------------------------------------------
|
|
471 |
// Set the Starting navigation Level
|
|
472 |
// -----------------------------------------------------------------------------
|
|
473 |
//
|
|
474 |
EXPORT_C void CGlxNavigationalState::SetStartingLevel(TInt aLevel)
|
|
475 |
{
|
|
476 |
iStartingLevel = aLevel;
|
|
477 |
}
|
|
478 |
|
|
479 |
// -----------------------------------------------------------------------------
|
|
480 |
// Get the Starting navigation Level
|
|
481 |
// -----------------------------------------------------------------------------
|
|
482 |
//
|
|
483 |
EXPORT_C TInt CGlxNavigationalState::StartingLevel()
|
|
484 |
{
|
|
485 |
return iStartingLevel;
|
|
486 |
}
|
|
487 |
|
|
488 |
// EOF
|
|
489 |
|