1 /*

     2 * Copyright (c) 2008 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:

    15 * Management of views in UiEngine

    16 *

    17 */

    18 

    19 #ifndef XNVIEWMANAGER_H

    20 #define XNVIEWMANAGER_H

    21 

    22 // System includes

    23 #include <e32base.h>

    24 #include <babitflags.h>

    25 

    26 // Forward declarations

    27 class CXnUiEngine;

    28 class CXnComposer;

    29 class CXnODTParser;

    30 class CXnEditor;

    31 class CXnEcomHandler;

    32 class CXnRootData;

    33 class CXnViewData;

    34 class CXnPluginData;

    35 class CXnNode;

    36 class CXnODT;

    37 class CXnResource;

    38 class CXnControlAdapter;

    39 class CXnAppUiAdapter;

    40 class CHsContentInfo;

    41 class CXnViewAdapter;

    42 class CXnOomSysHandler;

    43 

    44 namespace hspswrapper

    45     {

    46     class CHspsWrapper;

    47     }

    48 

    49 using namespace hspswrapper;

    50 

    51 // Classe declaration

    52 /**

    53  * Notifies view changes

    54  *

    55  * @ingroup group_xnlayoutengine

    56  * @lib xn3layoutengine.lib

    57  * @since S60 5.0

    58  */

    59 NONSHARABLE_CLASS( MXnViewObserver )

    60     {

    61 public:

    62     // new functions

    63     virtual void NotifyViewActivatedL( const CXnViewData& aViewData ) = 0;

    64 

    65     virtual void NotifyViewDeactivatedL( const CXnViewData& aViewData ) = 0;

    66 

    67     virtual void NotifyConfigureWidgetL(

    68         const CHsContentInfo& aContentInfo,

    69         CXnPluginData& aPluginData ) = 0;

    70 

    71     virtual void NotifyWidgetAdditionL( const CXnPluginData& aPluginData ) = 0;

    72 

    73     virtual void NotifyWidgetRemovalL( const CXnPluginData& aPluginData ) = 0;

    74     

    75     virtual void NotifyViewAdditionL( const CXnPluginData& aPluginData ) = 0;

    76 

    77     virtual void NotifyViewRemovalL( const CXnPluginData& aPluginData ) = 0;

    78     };

    79 

    80 /**

    81  * Manages views in UiEngine.

    82  *

    83  * @ingroup group_xnlayoutengine

    84  * @lib xn3layoutengine.lib

    85  * @since S60 5.0

    86  */

    87 NONSHARABLE_CLASS( CXnViewManager ) : public CBase

    88     {

    89     // Friend classes

    90     friend class CXnViewAdapter;    

    91 public:

    92     /**

    93      * Two-phased constructor.

    94      */

    95     static CXnViewManager* NewL(

    96         CXnAppUiAdapter& aAdapter );

    97         

    98     static CXnViewManager* NewLC(

    99         CXnAppUiAdapter& aAdapter );        

   100 

   101     ~CXnViewManager();

   102 

   103 private:

   104     CXnViewManager( CXnAppUiAdapter& aAdapter );

   105     void ConstructL();

   106 

   107 public:

   108     // New functions

   109 

   110     inline void SetUiEngine( CXnUiEngine& aUiEngine );

   111 

   112     inline CXnUiEngine& UiEngine() const;

   113 

   114     inline CXnComposer& Composer() const;

   115 

   116     inline CXnEditor& Editor() const;

   117 

   118     inline CXnAppUiAdapter& AppUiAdapter() const;

   119            

   120     CXnODT* ODT() const;

   121 

   122     CXnNode* RootNode() const;

   123 

   124     CXnNode* ViewNode() const;

   125     

   126     CXnODTParser& Parser() const;

   127 

   128     CXnEcomHandler& EcomHandler() const;

   129     

   130     const RPointerArray< CXnControlAdapter >& Controls() const;

   131 

   132     RPointerArray< CXnNode >& PluginNodes() const;

   133     

   134     void PluginDataL( RPointerArray< CXnPluginData >& aList, 

   135         TBool aGlobal = EFalse ) const;

   136 

   137     RPointerArray< CXnNode >& AppearanceNodes() const;

   138 

   139     CArrayPtrSeg< CXnResource >& Resources() const ;

   140            

   141     void LoadUiL();

   142 

   143     void ReloadUiL();

   144 

   145     TInt LoadWidgetToPluginL(

   146         CHsContentInfo& aContentInfo,

   147         CXnPluginData& aPluginData );

   148 

   149     TInt UnloadWidgetFromPluginL(

   150         CXnPluginData& aPluginData );

   151         

   152     TInt ReplaceWidgetToPluginL(

   153         CHsContentInfo& aContentInfo,

   154         CXnPluginData& aPluginData,

   155         TBool aUseHsps = ETrue );

   156 

   157     void ActivateNextViewL();

   158 

   159     void ActivatePreviousViewL();

   160 

   161     TInt AddViewL( CHsContentInfo& aInfo );

   162     

   163     void AddViewL();

   164     

   165     TInt RemoveViewL( const CHsContentInfo& aInfo );

   166 

   167     void RemoveViewL();

   168     

   169     void AddObserver( const MXnViewObserver& aObserver );

   170 

   171     void RemoveObserver( const MXnViewObserver& aObserver );

   172 

   173     CXnRootData& ActiveAppData() const;

   174     

   175     CXnViewData& ActiveViewData() const;

   176 

   177     void SetFirstPassDrawCompleteL();

   178 

   179     void SetDataPluginLoadCompleteL( const CXnPluginData& aPluginData );

   180 

   181     void UpdatePluginStateL( CXnPluginData& aPluginData );

   182        

   183     TInt ActivateAppL( const TDesC8& aPluginUid );

   184     TInt ActivateViewL( const TDesC8& aPluginId );    

   185     

   186     TInt ViewAmount() const;

   187 

   188     TInt ViewIndex() const;

   189 

   190     CXnOomSysHandler& OomSysHandler() const;

   191     

   192     /**

   193      * Get maximum pages allowed

   194      * 

   195      * @return number of pages allowed

   196      */

   197     TInt32 MaxPages();    

   198 

   199 private:

   200     void NotifyContainerChangedL( CXnViewData& aViewToActivate );       

   201 

   202     void NotifyViewActivatedL( const CXnViewData& aViewData );

   203 

   204     void NotifyViewDeactivatedL( const CXnViewData& aViewData );

   205 

   206     void NotifyViewAdditionL( const CXnViewData& aViewData );

   207    

   208     void NotifyViewRemovalL( const CXnViewData& aViewData );

   209 

   210     void NotifyConfigureWidgetL(

   211         const CHsContentInfo& aContentInfo,

   212         CXnPluginData& aPluginData );

   213 

   214     void NotifyWidgetAdditionL( const CXnPluginData& aPluginData );

   215 

   216     void NotifyWidgetRemovalL( const CXnPluginData& aPluginData );

   217 

   218     CXnViewData* ViewData( CXnNode& aNode ) const;

   219 

   220     CXnViewData& PreviousViewData() const;

   221 

   222     CXnViewData& NextViewData() const;

   223 

   224     void UpdateCachesL();

   225 

   226     void ValidateActiveViewL();

   227     

   228     void InvalidateActiveView();

   229 

   230     void ReportWidgetAmountL( const CXnViewData& aViewData );

   231     

   232     void ShowDiskFullMessageL() const;

   233        

   234 public:

   235     void UpdatePageManagementInformationL();

   236 

   237 #if 0 // MSK icon change

   238 private:

   239     TInt ResolveIconIndex( TInt aPageCount, TInt aPageNum ) const;

   240 #endif // MSK icon change

   241         

   242 private:

   243     // data

   244 

   245     /**

   246      * AppUi adapter.

   247      * Not own.

   248      */

   249     CXnAppUiAdapter& iAppUiAdapter;

   250 

   251     /**

   252      * Application uid

   253      */

   254     TUid iApplicationUid;

   255     

   256     /**

   257      * HSPS wrapper. 

   258      * Not own.

   259      */

   260     CHspsWrapper* iHspsWrapper;

   261 

   262     /**

   263      * UiEngine.

   264      * Not own.

   265      */

   266     CXnUiEngine* iUiEngine;

   267 

   268     /**

   269      * Comopser.

   270      * Own.

   271      */

   272     CXnComposer* iComposer;

   273 

   274     /**

   275      * Editor.

   276      * Own.

   277      */

   278     CXnEditor* iEditor;

   279     

   280     /**

   281      * Application configuration root data.

   282      * Own.

   283      */

   284     CXnRootData* iRootData;

   285     

   286     /**

   287      * Widget amount trigger.

   288      * Own.

   289      */

   290     CXnNode* iWidgetAmountTrigger;

   291     

   292     /**

   293      * Resources for current view.

   294      * Own.

   295      */

   296     mutable CArrayPtrSeg< CXnResource >* iResources;

   297 

   298     /**

   299      * Controls for current view.

   300      * Own.

   301      */

   302     mutable RPointerArray< CXnControlAdapter > iControls;

   303 

   304     /**

   305      * Appearance nodes. This array needs to be updated when UI furniture

   306      * is changed.

   307      * Own.

   308      */

   309     mutable RPointerArray< CXnNode > iAppearanceNodes;

   310 

   311     /**

   312      * View observers.

   313      * Own.

   314      */

   315     RPointerArray< MXnViewObserver > iObservers;

   316 

   317     /**

   318      * Failed plugins.

   319      * Own.

   320      */    

   321     RPointerArray< CXnPluginData > iFailedPlugins;

   322     

   323     /**

   324      * Flags

   325      */

   326     TBitFlags32 iFlags;

   327 

   328     /**

   329      * OOM system handler. Owned.

   330      */

   331     CXnOomSysHandler* iOomSysHandler;    

   332     };

   333 

   334 // Inline functions

   335 #include "xnviewmanager.inl"

   336 

   337 #endif