homescreenpluginsrv/hspsmanager/inc/hspsmaintenancehandler.h
changeset 4 1a2a00e78665
parent 0 79c6a41cd166
child 14 15e4dd19031c
equal deleted inserted replaced
3:ff572005ac23 4:1a2a00e78665
   264          * SetServerSession.
   264          * SetServerSession.
   265          * @since S60 5.0
   265          * @since S60 5.0
   266          * @param @param aServerSession Pointer to owning server session
   266          * @param @param aServerSession Pointer to owning server session
   267          */
   267          */
   268         void SetServerSession( ChspsThemeServerSession* aServerSession );
   268         void SetServerSession( ChspsThemeServerSession* aServerSession );
       
   269 
       
   270         /**  
       
   271          * ServiceRestoreConfigurationsL
       
   272          * @since S60 5.2
       
   273          * @param aMessage contains the data received from the client
       
   274          */
       
   275         void ServiceRestoreConfigurationsL( const RMessage2& aMessage );                        
   269         
   276         
   270   public: // Functions from base classes
   277   public: // Functions from base classes
   271 
   278 
   272         /** 
   279         /** 
   273         * From MhspsMaintenanceService hspsGetListHeaders
   280         * From MhspsMaintenanceService hspsGetListHeaders
   573                 TInt& aLastConfId,
   580                 TInt& aLastConfId,
   574                 TInt& aLastPluginId 
   581                 TInt& aLastPluginId 
   575                 );
   582                 );
   576 
   583 
   577         /**
   584         /**
       
   585          * Checks if the provided plugin configuration is a collection of plugin
       
   586          * configurations, e.g. view configuration.
       
   587          * Alternatively, we could check the type from header cache
       
   588          * @since S60 5.2
       
   589          * @param aPluginNode Plugin node
       
   590          * @return True if it is a view configuration
       
   591          */
       
   592         TBool IsViewConfiguration(
       
   593                 ChspsDomNode& aPluginNode );
       
   594                 
       
   595         /**
   578          * Removes an plugin instance from the provided application configuration
   596          * Removes an plugin instance from the provided application configuration
   579          * @since S60 5.0
   597          * @since S60 5.0
   580          * @param aAppODT is an instance of the the application configuration         
   598          * @param aAppODT is an instance of the the application configuration         
   581          * @param aPluginId is an ID of the plugin instance to be removed
   599          * @param aPluginId is an ID of the plugin instance to be removed
   582          * @return KErrNone if succeeded
   600          * @return KErrNone if succeeded
   583          */
   601          */
   584         TInt RemoveConfigurationL(
   602         TInt RemoveConfigurationL(
   585                 ChspsODT& aAppODT,
   603                 ChspsODT& aAppODT,
   586                 const TInt aPluginId );
   604                 const TInt aPluginId );                
       
   605         
       
   606         /**
       
   607          * Removes an plugin instance from the provided application configuration
       
   608          * @since S60 5.0
       
   609          * @param aAppODT is an instance of the the application configuration         
       
   610          * @param aPluginNode is a node of the plugin instance to be removed
       
   611          * @return KErrNone if succeeded
       
   612          */
       
   613         TInt RemoveConfigurationL(
       
   614                 ChspsODT& aAppODT,
       
   615                 ChspsDomNode& aPluginNode );
   587         
   616         
   588         /**
   617         /**
   589          * Finds a plugin node with the provided id which is also a children of 
   618          * Finds a plugin node with the provided id which is also a children of 
   590          * the provided plugins node
   619          * the provided plugins node
   591          * @since S60 5.0
   620          * @since S60 5.0
   794         void AddErrorConfigurationL(
   823         void AddErrorConfigurationL(
   795                 ChspsDomDocument& aAppDom,
   824                 ChspsDomDocument& aAppDom,
   796                 ChspsDomNode& aMissingPluginNode,
   825                 ChspsDomNode& aMissingPluginNode,
   797                 const TInt aPluginUid );
   826                 const TInt aPluginUid );
   798 
   827 
       
   828         /**
       
   829          * Removes all plugins from the plugins node and related 
       
   830          * resources from the resource array.
       
   831          * @since S60 5.2
       
   832          * @param aAppODT Application configuration
       
   833          * @return error code
       
   834          */
       
   835         TInt RestoreActiveViewL(
       
   836                 ChspsODT& aAppODT );
       
   837         
       
   838         /**
       
   839          * Finds a plugin node which is the active view configuration.
       
   840          * @since S60 5.2
       
   841          * @param aAppODT Application configuration
       
   842          * @return Active plugin node or NULL
       
   843          */
       
   844         ChspsDomNode* FindActiveView(
       
   845                 ChspsODT& aAppODT );
       
   846         
       
   847         /**
       
   848          * Removes all plugin configurations from the provided
       
   849          * plugin node (view configuration).
       
   850          * @since S60 5.2         
       
   851          * @param aAppODT Application configuration
       
   852          * @param aActivePluginNode Plugin node to be modified
       
   853          * @return error code 
       
   854          */
       
   855         TInt RemovePluginConfigurationsL(
       
   856                 ChspsODT& aAppODT, 
       
   857                 ChspsDomNode& aActivePluginNode );
       
   858         
       
   859         /**
       
   860          * Removes all unlocked views and reset the active view.
       
   861          * Can leave if DOM is corrupted (objects are not found) or in OOM cases.
       
   862          * @since S60 5.2   
       
   863          * @param aAppODT Application configuration
       
   864          */
       
   865         void RemoveUnlockedViewsL(
       
   866                 ChspsODT& aAppODT );
       
   867         
       
   868         /**
       
   869          * Checks whether the plugin configuration was locked.
       
   870 		 * @since S60 5.2   
       
   871          * @param aConfNode Configuration node
       
   872 		 * @return True if it was locked
       
   873          */
       
   874         TBool IsConfigurationLocked(
       
   875                 ChspsDomNode& aConfNode );
       
   876         
   799     private:   // Data
   877     private:   // Data
   800         RMessagePtr2 iMessagePtr;
   878         RMessagePtr2 iMessagePtr;
   801         ChspsResult* iResult;
   879         ChspsResult* iResult;
   802         TBuf8<KMaxResultDataLength8> iResultData;
   880         TBuf8<KMaxResultDataLength8> iResultData;
   803         ThspsServiceRequestMessage iRequestMessage;     
   881         ThspsServiceRequestMessage iRequestMessage;