/*
* Copyright (c) 2005-2007 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: Plug-in main class
*
*/
#ifndef SAPIDATA_H
#define SAPIDATA_H
// System includes
#include <liwcommon.h>
#include <AknsItemID.h>
// User includes
#include <hscontentpublisher.h>
#include "sapidatapluginconst.h"
// Forward declarations
class MLiwInterface;
class CLiwServiceHandler;
class CSapiDataObserver;
class CSapiDataPlugin;
class MAiContentObserver;
class MAiCpsCommandBuffer;
/**
* @ingroup group_sapidataplugin
*
* Content item
*
* @since S60 5.0
*/
NONSHARABLE_CLASS( CContentItem ) : public CBase
{
public:
/**
* Part of the two phased constuction
*
* @param none
* @return none
*/
static CContentItem* NewL();
/*
* Destructor
*/
~CContentItem();
private:
/*
* Constructor
*/
CContentItem();
/**
* Part of the two phased construction
*
* @param none
* @return void
*/
void ConstructL();
public:
TInt iId;
/* item id */
HBufC* iName;
/* type (image/text) */
HBufC* iType;
HBufC* iContentType;
};
/**
* @ingroup group_sapidataplugin
*
* Sapi data
*
* @since S60 5.0
*/
NONSHARABLE_CLASS( CSapiData ) : public CBase
{
public:
// constructor and destructor
/**
* Part of the two phased construction
*
* @param aPlugin refrence of the plugin
* @return none
*/
static CSapiData* NewL(CSapiDataPlugin* aPlugin);
/**
* Destructor
*
* @param none
* @return none
*/
~CSapiData();
private:
// constructors
/**
* Constructor
*
* @param none
* @return none
*/
CSapiData();
/**
* Part of the two phased construction
*
* @param aPlugin reference of the plugin
* @return void
*/
void ConstructL(CSapiDataPlugin* aPlugin);
public:
// new functions
/**
* Change the publisher status
*
* @param aStatus new status of the publisher
* @return void
*/
void ChangePublisherStatusL(const TDesC8& aStatus);
/**
* Triggers active event with KNoNotification option.
* Notification is not send to observer, action handler
* plug-ins are executed
*
* @return void
*/
void TriggerActiveL();
/**
* Configures the subscriber and data to subscribe.
*
* @param aConfigurations Information about the subscriber
* and the data to subscribe.
* @return void
*/
void ConfigureL(RAiSettingsItemArray& aConfigurations);
/**
* Sets content id
*
* @param aId Content id
*/
void SetContentIdL(const TDesC8& aId);
/**
* Sets startup reason, which will be communicated to CPS client
* in the case of late registration.
*
* @param aStartupReason A reason
*/
void SetStartupReasonL(const TDesC8& aStartupReason);
/**
* Execute the command to get the data from CPS
*
* @param aRegistry type of registry (publisher/cp_data)
* @param aInFilter input filter for the command
* @param outParamList output data map
* @return void
*/
void ExecuteCommandL(const TDesC& aRegistry ,
CLiwDefaultMap* aInFilter, CLiwGenericParamList* outParamList );
/**
* Checks Can Update for this publisher
*
* @param aPublisher publisher.
* @param aContentType content type.
* @param aContentId content Id.
* @return bool
*/
TBool CanUpdate( TDesC& aPublisher, TDesC& aContentType, TDesC& aContentId );
/**
* Removes all the data from the widget which matches to
* this publisher, contentype, contentid values
*
* @param aObserver to publish data
* @param aContentType content type
* @return void
*/
void RemoveL( MAiContentObserver* aObserver, TDesC& aContentType );
/**
* Checks is this menu item is supported by the publisher
*
* @param aMenuItem menu item name.
* @return boolean (ETrue/EFalse)
*/
TBool HasMenuItem(const TDesC& aMenuItem );
/**
* Publish the data to widget.
*
* @param aObserver to publish data
* @param aContentType content type
* @return void
*/
void PublishL( MAiContentObserver* aObserver, const TDesC& aContentType );
/**
* Publish the updated data to widget.
*
* @param aObserver to publish data
* @param aDataMap data map with updated data
* @return void
*/
void PublishDataL(MAiContentObserver* aObserver, 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);
/**
* Register to publisher registry for all (update) action
*
* @param none
* @return void
*/
void RegisterPublisherObserverL();
/**
* Register to content registry for all (add/delete/update) action
*
* @param none
* @return void
*/
void RegisterContentObserverL();
/**
* Called by the observer to refresh the changed content
*
* @param aPublisher publisher.
* @param aContentType content type.
* @param aContentId content Id.
* @param aOperation operation (add/delete/update/execute).
* @param aDataMap data map if available. Can be NULL.
* Ownership NOT transferred.
*
* @return void
*/
void RefreshL( TDesC& aPublisher,
TDesC& aContentType,
TDesC& aContentId,
TDesC& aOperation,
CLiwDefaultMap* aDataMap );
/**
* Createts the filter map and push it in the stack
*
* @return filter map
*/
CLiwDefaultMap* CreateFilterLC();
/**
* Createts the filter map and push it in the stack
*
* @param aConType content type
* @return filter map
*/
CLiwDefaultMap* CreateFilterLC(const TDesC& aConType);
/**
* Createts the filter map and push it in the stack
*
* @param aConType content type
* @param aContentId cotent Id
* @return filter map
*/
CLiwDefaultMap* CreateFilterLC(const TDesC& aContentType,
const TDesC& aContentId);
/**
* Is the pugin is active to publish the data.
*
* @param None
* @return boolean (ETrue/EFalse).
*/
TBool IsPluginActive();
/**
* Update the publisher status
*
* @param aPublisher publisher name
* @return void
*/
void UpdatePublisherStatusL(TDesC& aPublisher);
/**
* Resolves skin item id and Mif id from pattern
* skin( <majorId> <minorId> (<colourGroupId>)
* mif(<MifFileName.mif> <bitmapId> <maskId>)
*
* @param aPath skin pattern / mif pattern value
* @param aItemId skin item id
* @param aMifId mif id
* @param aMaskId mask id
* @param aFilename mif file name
* @return boolean (ETrue/EFalse)
*/
TBool ResolveSkinIdAndMifId( const TDesC& aPath, TAknsItemID& aItemId,
TInt& aMifId, TInt& aMaskId, TDes& aFilename );
/**
* Sets the on resume update needed status
*
* @param aStatus update needed status (ETrue/EFalse)
* @return void
*/
void SetUpdateNeeded(TBool aStatus);
/**
* Sets property value.
*
* @since S60 5.2
* @param aAny - contains pointer to command buffer.
*/
void SetCommandBuffer(TAny* aAny);
private:
// new functions
/**
* Gets the menu item from the publisher
*
* @param none
* @return void
*/
void GetMenuItemsL();
/**
* Change the publisher status with list of actions
*
* @param aActionsList new list of status for the publisher
* @return void
*/
void ChangePublisherStatusL(CLiwDefaultList* aActionsList);
private:
// data
/** CPS Command Buffer Interface, Not Owned */
MAiCpsCommandBuffer* iCpsExecute;
/** Subscriber interface, Not owned */
MLiwInterface* iInterface;
/** Service handler, Not owned */
CLiwServiceHandler* iServiceHandler;
/** Data Observer to CPS content registry, owned */
CSapiDataObserver* iContentObserver;
/** Data Observer to CPS publisher registry, owned */
CSapiDataObserver* iPubObserver;
/** Array of configurations, owned */
RPointerArray<CContentItem> iItemList;
/** Number of configurations */
TInt iItemCount;
/** publisher id, owned */
HBufC* iPublisher;
/** content id, owned */
HBufC* iContentId;
/** Startup reason, owned */
HBufC8* iStartupReason;
/** Reference of the sapi data plugin, not owned */
CSapiDataPlugin* iPlugin;
/** Menu item names, owned */
RPointerArray<HBufC> iMenuItems;
/** Trigger names for the menu items, owned */
RPointerArray<HBufC8> iMenuTriggers;
/** Store the status of update needed on resume */
TBool iUpdateNeeded;
// Is Menu item read.
TBool iGetMenuItems;
};
#endif // SAPIDATA_H
// End of file