diff -r 15e4dd19031c -r a0713522ab97 idlefw/plugins/wrtdataplugin/inc/wrtdata.h --- a/idlefw/plugins/wrtdataplugin/inc/wrtdata.h Wed Mar 31 22:04:35 2010 +0300 +++ b/idlefw/plugins/wrtdataplugin/inc/wrtdata.h Wed Apr 14 16:16:44 2010 +0300 @@ -32,6 +32,7 @@ class CLiwServiceHandler; class CWrtDataObserver; class CWrtDataPlugin; +class MAiCpsCommandBuffer; /** * @ingroup group_wrtdataplugin @@ -43,221 +44,203 @@ NONSHARABLE_CLASS( CWrtData ) : public CBase { public: - // constructor and destructor - - static CWrtData* NewL( CWrtDataPlugin* aPlugin ); - - ~CWrtData(); - - public : - /** - * Configures the subscriber and data to subscribe. - * - * @param aConfigurations Information about the subscriber - * and the data to subscribe. - * @return void - */ - void ConfigureL(RAiSettingsItemArray& aConfigurations); - - /** - * Checks is this menu item is supported by the publisher - * - * @param aMenuItem menu item name. - * @return boolean (ETrue/EFalse) - */ - TBool HasMenuItem(const TDesC16& aMenuItem ); + /** + * Part of the two phased constuction + * + * @param none + * @return none + */ + static CWrtData* NewL( CWrtDataPlugin* aPlugin ); + + /* + * Destructor + */ + ~CWrtData(); + +private : - /** - * Register to CPS for all (add/delete/update/execute) action - * - * @param none - * @return void - */ - void RegisterL(); - - /** - * Update the publisher status - * - * @param None - * @return void - */ - void UpdatePublisherStatusL(); - - /** - * Publish updated data for all the items in the widget - * - * @param aObserver to publish data - * @return void - */ - void PublishDefaultImageL( MAiContentObserver* aObserver ); - - /** - * Publish the updated data - * - * @param aObserver to publish data - * @param aDataMap data map - * @return void - */ - void PublishL( MAiContentObserver* aObserver, CLiwDefaultMap* aDataMap ); - - /** - * Called by the observer to refresh the changed content - * - * @param aContentId content Id. - * @param aOperation operation (add/delete/update/execute). - * @param aDataMap data map. - * @return void - */ - void RefreshL( TDesC& aContentId, TDesC& aOperation, CLiwDefaultMap* aDataMap ); - - /** - * Tigger for execution of a action for a specific content id. - * - * @param aObjectId object Id. - * @param aTrigger name of the trigger. - * @return void - */ - void ExecuteActionL(const TDesC& aObjectId, const TDesC& aTrigger); - - /** - * Is the pugin is active to publish the data. - * - * @param None - * @return boolean (ETrue/EFalse). - */ - TBool IsPluginActive(); + /** + * Default Constructor + * + */ + CWrtData(); + + /** + * Part of the two phased construction + * + * @param aPlugin reference of the plugin + * @return void + */ + void ConstructL(CWrtDataPlugin* aPlugin); + +public : + // new functions + + /** + * Configures the subscriber and data to subscribe. + * + * @param aConfigurations Information about the subscriber + * and the data to subscribe. + * @return void + */ + void ConfigureL(RAiSettingsItemArray& aConfigurations); + + /** + * Checks is this menu item is supported by the publisher + * + * @param aMenuItem menu item name. + * @return boolean (ETrue/EFalse) + */ + TBool HasMenuItem(const TDesC16& aMenuItem ); - /** - * Activate the publisher - * - * @param None - * @return void - */ - void ActivateL(); - - /** - * Resume the publisher - * - * @param None - * @return void - */ - void ResumeL(); - - /** - * Suspend the publisher - * - * @param None - * @return void - */ - void SuspendL(); - - /** - * Deactivate the publisher - * - * @param None - * @return void - */ - void DeActivateL(); - - /** - * OnLineL - * - * @param None - * @return void - */ - void OnLineL(); - - /** - * OffLineL - * - * @param None - * @return void - */ - void OffLineL(); + /** + * Register to CPS for all (add/delete/update/execute) action + * + * @param none + * @return void + */ + void RegisterL(); + + /** + * Update the publisher status + * + * @param None + * @return void + */ + void UpdatePublisherStatusL(); + + /** + * Publish updated data for all the items in the widget + * + * @param aObserver to publish data + * @return void + */ + void PublishDefaultImageL( MAiContentObserver* aObserver ); + + /** + * Publish the updated data + * + * @param aObserver to publish data + * @param aDataMap data map + * @return void + */ + void PublishL( MAiContentObserver* aObserver, CLiwDefaultMap* aDataMap ); + + /** + * Called by the observer to refresh the changed content + * + * @param aContentId content Id. + * @param aOperation operation (add/delete/update/execute). + * @param aDataMap data map. + * @return void + */ + void RefreshL( TDesC& aContentId, TDesC& aOperation, CLiwDefaultMap* aDataMap ); + + /** + * Tigger for execution of a action for a specific content id. + * + * @param aObjectId object Id. + * @param aTrigger name of the trigger. + * @return void + */ + void ExecuteActionL(const TDesC& aObjectId, const TDesC& aTrigger); - private : + /** + * Is the pugin is active to publish the data. + * + * @param None + * @return boolean (ETrue/EFalse). + */ + TBool IsPluginActive(); + + /** + * Notify the status to the publisher + * + * @param aStatus new status of the publisher + * @return void + */ + void NotifyPublisherL(const TDesC8& aStatus); - /** - * Default Constructor - * - */ - CWrtData(); - - /** - * Part of the two phased construction - * - * @param aPlugin reference of the plugin - * @return void - */ - void ConstructL(CWrtDataPlugin* aPlugin); - - /** - * Createts the filter map - * - * @return filter map - */ - CLiwDefaultMap* CreateFilterLC( ); - - /** - * Execute the command to get the data from CPS - * - * @param aInFilter input filter for the command - * @param aOutDataMap output data map - * @param aRegistry type of registry (publisher/cp_data) - * @return void - */ - void ExecuteCommandL(CLiwDefaultMap* aInFilter, - CLiwDefaultMap* aOutDataMap, const TDesC16& aRegistry ); - + /** + * Sets property value. + * + * @since S60 5.2 + * @param aAny - contains pointer to command buffer. + * @param aNameSpace - plugin name space id + */ + void SetCommandBuffer(TAny* aAny, const TDesC8& aNameSpace); + +private: + // new functions + + /** + * Createts the filter map + * + * @return filter map + */ + CLiwDefaultMap* CreateFilterLC( ); + + /** + * Execute the command to get the data from CPS + * + * @param aInFilter input filter for the command + * @param aOutDataMap output data map + * @param aRegistry type of registry (publisher/cp_data) + * @return void + */ + void ExecuteCommandL(CLiwDefaultMap* aInFilter, + CLiwDefaultMap* aOutDataMap, const TDesC16& aRegistry ); + + /** + * Gets the menu item from the publisher + * + * @param none + * @return void + */ + void GetMenuItemsL(); + + /** + * Gets the widgent name and uid + * + * @param aName - widget name + * @param aAppUID - widget uid + * @return void + */ + void GetWidgetNameAndUidL(TDes& aName, TDes& aAppUID ); + + /** + * Resolves the Uid from the string + * + * @param aUidDes - uid in string + * @param aUid - uid + * @return ETure/EFalse + */ + TBool ResolveUid(const TDesC& aUidDes, TUid& aUid ); + + /** + * Creates icon from the uid + * + * @param aHandle - icon handle + * @param aMaskHandle - mask handle + * @param aAppUid - application uid + * @return ETure/EFalse + */ + void CreateIconFromUidL(TInt& aHandle, TInt& aMaskHandle, const TUid& aAppUid ); - /** - * Change the publisher status - * - * @param aStatus new status of the publisher - * @return void - */ - void ChangePublisherStatusL(const TDesC& aStatus); - - /** - * Gets the menu item from the publisher - * - * @param none - * @return void - */ - void GetMenuItemsL(); - - /** - * Gets the widgent name and uid - * - * @param aName - widget name - * @param aAppUID - widget uid - * @return void - */ - void GetWidgetNameAndUidL(TDes& aName, TDes& aAppUID ); - - /** - * Resolves the Uid from the string - * - * @param aUidDes - uid in string - * @param aUid - uid - * @return ETure/EFalse - */ - TBool ResolveUid(const TDesC& aUidDes, TUid& aUid ); - - /** - * Creates icon from the uid - * - * @param aHandle - icon handle - * @param aMaskHandle - mask handle - * @param aAppUid - application uid - * @return ETure/EFalse - */ - void CreateIconFromUidL(TInt& aHandle, TInt& aMaskHandle, const TUid& aAppUid ); - - private : + /** + * Resend the the current plugin status to publisher + * + * @param aActionsList new list of status for the publisher + * @return void + */ + void ReSendNotificationL(CLiwDefaultList* aActionsList); + +private : // data - + TBuf iPluginId; + /** CPS Command Buffer Interface, Not Owned */ + MAiCpsCommandBuffer* iCpsExecute; /** Subscriber interface, owned */ MLiwInterface* iInterface; /** Data Observer to CPS, owned */