/*

* Copyright (c) 2008 - 2009 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:  handles interface to LIW and Content Publishing Service

*

*/

#ifndef CMAILCPSIF_H_

#define CMAILCPSIF_H_

// LIW interface

#include <liwservicehandler.h>

#include <liwvariant.h>

#include <liwgenericparam.h>

#include <fbs.h>

#include <data_caging_path_literals.hrh>

#include <hsccapiclient.h>

#include <hscontentcontrol.h>

#include <hscontentinfo.h>

#include <hscontentinfoarray.h>

#include "cmailcpshandler.h"

#include "cmailcpsifconsts.h"

/**

 *  CMail ContentPublishingService interface class

 *  Class implementing interface towards LIW FW and Content Publishing Service

 *

 *  @lib fsmailserver.exe

 *  @since S60 v5.1

 */

NONSHARABLE_CLASS( CMailCpsIf ) : public CBase,

                                  public MHsContentControl,

                                  public MLiwNotifyCallback

    {

public:

    /**

     * Two-phased constructor.

     */

    static CMailCpsIf* NewL( CMailCpsHandler* aMailCpsHandler );

    /**

    * Destructor.

    */

    ~CMailCpsIf();

    /**

     * Publishes setup text and action to launch setup wizard

     */

    void PublishSetupWizardL(TInt instance);

    /**

     * Publishes mailbox name to widget and action to launch CMail UI

     * @param aRowNumber specifies the row on widget UI

     * @param aMailboxName contains name of the mailbox

     */

    void PublishActiveMailboxNameL( const TInt aInstance, 

									const TInt aRowNumber, 

                                    const TDesC& aMailboxName);

    /**

     * Publishes mailbox name to widget and action related to widget

     * @param aInstance specifies the widget instance on homescreen

     * @param aMailboxName specifies the text to be published

     * @param aAction specifies the action identifier that will be sent back

     *        when user presses the widget

     */

    void PublishMailboxNameL(

        const TInt aInstance, 

        const TDesC& aMailboxName,

        const TDesC8& aAction );

    /**

     * Resets mailbox name from widget

     * @param aRowNumber specifies the row on widget UI

     */

//    void ResetActiveMailboxNameL( const TInt aRowNumber );

    /**

     * Publishes unseen or outbox icon

     */

    void PublishIndicatorIconL( const TInt aInstance, 

                                const TInt aRowNumber,

                                const TInt aIcon );

    /**

     * 

     */

    void PublishMailboxIconL( const TInt aInstance, const TInt aRowNumber, const TInt aIcon, TFSMailMsgId aMailBoxId );

    /**

     * Publishes mailbox icon based on given resource path

     * @param aInstance specifies the widget

     * @param aIconResourcePath specifies the icon resource

     *  (e.g. "mif(z:\\resource\\apps\\myemailplugin.mif 16384 16385)")

     */

    void PublishMailboxIconL( const TInt aInstance, const TDesC& aIconPath );

    /**

     * 

     */

    void PublishIconReferenceL(

        const TDesC& aContentId,

        const TDesC& aContentType,

        const TDesC8& aKey,

        const TDesC& aIconPath );

    /**

     * 

     */    

    void PublishMailDetailL(

            const TInt aInstance,

            const TInt aRowNumber, 

            const TDesC& aSender,

            TWidgetMailDetails aDetail);

    /**

     * Resets mail header data

     * @param aRowNumber specifies the row on widget UI

     */

    void ResetMessageL( TInt aRowNumber );

    /**

     * 

     */

	void PublisherRegisteryActionL();

    /**

     * 

     */	

    void RegisterForObserverL();

    /**

     * 

     */	

    void UnRegisterForObserverL();

    /**

     * 

     */	

	TInt HandleNotifyL(

        TInt aCmdId,

        TInt aEventId,

        CLiwGenericParamList& aEventParamList,

        const CLiwGenericParamList& aInParamList );

    /**

     * 

     */		

	TBool PublisherStatusL(const CLiwGenericParamList& aEventParamList);

    /**

     * 

     */

	TBool AllowedToPublish( TInt aWidgetInstance );

    /**

     * Sets configuration data to publisher interface

     * CpsIf uses this

     * @param aRowNumber specifies the row on widget UI

     */

	void SetConfiguration( const TInt32 aConfigData );

    /**

     * 

     */	

	TInt GetWidgetInstanceCount();

    /**

     * 

     */	

	void AddWidgetToHomescreenL( const TFSMailMsgId aMailbox );

private:

    CMailCpsIf( CMailCpsHandler* aMailCpsHandler );

    void ConstructL();

    /**

     * adds resource file

     */

    void AllocateResourcesL();

    /**

     * initializes the LIW IF

     * @return instance of LIW IF

     */

    MLiwInterface* GetMessagingInterfaceL( );

    /**

     * Gets published item's ID from LIW. Id is later used e.g. when reseting values 

     * @param aInParamList parameter list returned from LIW IF

     * @return Id

     */

    TUint ExtractItemId( const CLiwGenericParamList& aInParamList );

    /**

     * Publishes descriptor

     * @param aPublisherId id of the publisher

     * @param aContentType content type of the published data

     * @param aContentId content id of the published data

     * @param aTextToAdd data to be published

     * @param aKey key of the added descriptor

     * @param aTrigger optional trigger tag

     * @param aUid optional app uid (app to be launched)

     * @return Id

     */

    TUint PublishDescriptorL(

        const TDesC& aPublisherId, 

        const TDesC& aContentType, 

        const TDesC& aContentId, 

        const TDesC& aTextToAdd,

        const TDesC& aKey,

        const TDesC8& aTrigger);

    /**

     * Publishes image

     * @param aContentId

     * @param aResult

     * @param aBitmapId

     * @param aBitmapMaskId

     * @param aMailBoxId

     */

    void PublishImageL(

         const TDesC& aContentId,

         const TDesC& aContentType,

         const TDesC8& aKey,

         TInt aBitmapId,

         TInt aBitmapMaskId,

         TFSMailMsgId aMailBoxId,

         const TDesC& aBrandId );

    /**

     * Removes a published entity from Content Publishing Service

     * @param aId of the published data

     */

    void RemoveL( TUint aId );

    /**

     * Resets all the published content values on HomeScreen database

     */

    void ResetPublishedDataL( const TDesC& aContentId );

    //

    // -------------------------- from base classes-----------------------------

    //

    virtual void NotifyWidgetListChanged(); // MHsContentControl

    virtual void NotifyViewListChanged(); // MHsContentControl

    virtual void NotifyAppListChanged(); // MHsContentControl

public:

	//

private:

    // LIW IF

    // LIW Service handler

    // resource file offset

    TInt                    iResourceFileOffset;

    // UIDS of the published entities

    // message count of a mailbox

    // row count

    // message header details id

    // setup text and action id

	CHsCcApiClient*         iContentControlClient;

    };

#endif /*CMAILCPSIF_H_*/