/****************************************************************************

**

** Copyright (C) 2008-2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (developer.feedback@nokia.com)

**

** This file is part of the HbWidgets module of the UI Extensions for Mobile.

**

** GNU Lesser General Public License Usage

** This file may be used under the terms of the GNU Lesser General Public

** License version 2.1 as published by the Free Software Foundation and

** appearing in the file LICENSE.LGPL included in the packaging of this file.

** Please review the following information to ensure the GNU Lesser General

** Public License version 2.1 requirements will be met:

** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at developer.feedback@nokia.com.

**

****************************************************************************/

#include <hbsymbianvariant.h>

#include <hbdevicedialogsymbian.h>

#include "hbdevicenotificationdialogsymbian.h"

_LIT(KKeyTimeOut, "timeout");

_LIT(KKeyIconName, "iconName");

_LIT(KKeyText, "text");

_LIT(KKeyTitle, "title");

_LIT(KKeyTouchActivation, "touchActivation");

_LIT(KKeyActivated, "result");

_LIT(KKeyActivatedValue, "activated");

_LIT(KPluginIdentifier, "com.nokia.hb.devicenotificationdialog/1.0");

_LIT(KKeyTitleTextWrapping, "titleTextWrapping");

_LIT(KKeyAnimationDefinition, "animationDefinition");

_LIT(KKeyShowLevel, "showLevel");

NONSHARABLE_CLASS(CHbDeviceNotificationDialogSymbianPrivate) : public CBase,

                                                  public MHbDeviceDialogObserver

{

public:

    CHbDeviceNotificationDialogSymbianPrivate();

    virtual ~CHbDeviceNotificationDialogSymbianPrivate();

public:

    void ShowL();

    void UpdateL();

    void Close();

    void AddVariantL(const TDesC& aKey, const TAny* aData,

            CHbSymbianVariant::TType aDataType);

    const CHbSymbianVariant* Variant(const TDesC& aKey) const;

public: // MHbDeviceDialogObserver

    void DataReceived(CHbSymbianVariantMap& aData);

    void DeviceDialogClosed(TInt aCompletionCode);

    void ConstructL(CHbDeviceNotificationDialogSymbian* aDialog);

public:

    MHbDeviceNotificationDialogObserver* iObserver;

    CHbDeviceDialogSymbian *iDeviceDialog;

    CHbSymbianVariantMap* iVariantMap;

    CHbDeviceNotificationDialogSymbian* q; 

};

CHbDeviceNotificationDialogSymbianPrivate::CHbDeviceNotificationDialogSymbianPrivate()

    }

CHbDeviceNotificationDialogSymbianPrivate::~CHbDeviceNotificationDialogSymbianPrivate()

    {

    if (!iObserver && q->Timeout() != 0) {

        if (iDeviceDialog) {

            iDeviceDialog->SetObserver(NULL);

        }

    }

    delete iDeviceDialog;

    delete iVariantMap;

    }

void CHbDeviceNotificationDialogSymbianPrivate::ConstructL(CHbDeviceNotificationDialogSymbian* aDialog)

    {

    q = aDialog;

    iDeviceDialog = CHbDeviceDialogSymbian::NewL();

    iVariantMap = CHbSymbianVariantMap::NewL(); 

    }

void CHbDeviceNotificationDialogSymbianPrivate::ShowL()

    {

    }

    TInt error = iDeviceDialog->Show(KPluginIdentifier, *iVariantMap, this);

    if (error != KErrNone) {

        User::Leave(error); // error can be positive or negative

    }

    }

void CHbDeviceNotificationDialogSymbianPrivate::UpdateL()

    {

    TInt error = iDeviceDialog->Update(*iVariantMap);

    if (error != KErrNone) {

        User::Leave(error); // error can be positive or negative

    }

    }

void CHbDeviceNotificationDialogSymbianPrivate::Close()

    {

    iDeviceDialog->Cancel();

    }

void CHbDeviceNotificationDialogSymbianPrivate::AddVariantL(

    const TDesC& aKey, 

    const TAny* aData,

    CHbSymbianVariant::TType aDataType)

    {

    CHbSymbianVariant *variant = CHbSymbianVariant::NewL(aData, aDataType);

    CleanupStack::PushL(variant);

    User::LeaveIfError(iVariantMap->Add(aKey, variant));

    CleanupStack::Pop(variant);

    }

const CHbSymbianVariant* CHbDeviceNotificationDialogSymbianPrivate::Variant(

    const TDesC& aKey) const

    {              

    return iVariantMap->Get(aKey);

    }

void CHbDeviceNotificationDialogSymbianPrivate::DataReceived(CHbSymbianVariantMap& aData)

    {    

    const CHbSymbianVariant* variant = aData.Get(KKeyActivated);

    if (variant && variant->IsValid())

        {

        TPtrC p = *variant->Value<TDesC>();

        bool result = p.Compare(KKeyActivatedValue()) == 0;

        if (iObserver && result)

            {

            // Observer callback may delete this object. Don't touch it after.

            iObserver->NotificationDialogActivated(q);

            }

        }    

    }

void CHbDeviceNotificationDialogSymbianPrivate::DeviceDialogClosed(TInt aCompletionCode)

    {

    if (iObserver)

        {

        // Observer callback may delete this object. Don't touch it after.

        iObserver->NotificationDialogClosed(q, aCompletionCode);

        }

    }

// Set dialog show level

void SetShowLevel(CHbDeviceNotificationDialogSymbianPrivate *aDialog, TInt aLevel)

{

}

/*!

    \class MHbDeviceNotificationDialogObserver

    \brief MHbDeviceNotificationDialogObserver is an observer interface for observing CHbDeviceNotificationDialogSymbian.

*/

/*!

    \fn void MHbDeviceNotificationDialogObserver::NotificationDialogActivated(const CHbDeviceNotificationDialogSymbian* aDialog) = 0;

    This callback is called when notification dialog is activated.

*/

/*!

   \fn void MHbDeviceNotificationDialogObserver::NotificationDialogClosed(const CHbDeviceNotificationDialogSymbian* aDialog, TInt aCompletionCode) = 0;

*/

/*!

    \class CHbDeviceNotificationDialogSymbian

    \brief CHbDeviceNotificationDialogSymbian is a Symbian implementation of HbDeviceNotificationDialog.

    \code

    Following code snippet creates a device notification dialog containing title, text and icon.

    _LIT(KDialogText, "Dialog text");

    _LIT(KDialogTitle, "Dialog title");

    CHbDeviceNotificationDialogSymbian* dialog = CHbDeviceNotificationDialogSymbian::NewL();

    CleanupStack::PushL(dialog);

    dialog->SetTextL(KDialogText);

    dialog->SetTitleL(KDialogTitle);

    dialog->SetIconNameL(KDialogIcon);

    CleanupStack::PopAndDestroy(dialog);

    \endcode

    or equivalent dialog can be created using one of the provided convenience methods:

    \code

    _LIT(KDialogText, "Dialog text");

    _LIT(KDialogTitle, "Dialog title");

    CHbDeviceNotificationDialogSymbian::Notification(KDialogIcon, KDialogText, KDialogTitle);

    \endcode

    \code

    _LIT(KDialogText, "Dialog text");

    _LIT(KDialogTitle, "Dialog title");

    class DialogObserver : public MHbDeviceNotificationDialogObserver

    {

    public:

        DialogObserver() {}

        ~DialogObserver() { delete iDialog; }

        void ShowDialog();

    ...

    private:

        virtual void NotificationDialogActivated(const CHbDeviceNotificationDialogSymbian* aDialog);

        virtual void NotificationDialogClosed(const CHbDeviceNotificationDialogSymbian* aDialog, TInt aCompletionCode);

    private:

        CHbDeviceNotificationDialogSymbian* iDialog;

    };

    void DialogObserver::NotificationDialogActivated(const CHbDeviceNotificationDialogSymbian* aDialog)

    {

        CEikonEnv::Static()->InfoMsg(_L("Device notification dialog activated"));

        delete aDialog;

        aDialog = 0;

    }

    void NotificationDialogClosed(const CHbDeviceNotificationDialogSymbian* aDialog, TInt aCompletionCode)

    {

        CEikonEnv::Static()->InfoMsg(_L("Device notification dialog deactivated"));

        delete aDialog;

        aDialog = 0;

    }

    void DialogObserver::ShowDialog()

    {

        iDialog = CHbDeviceNotificationDialogSymbian::NewL(this);

        iDialog->SetTextL(KDialogText);

        iDialog->SetTitleL(KDialogTitle);

        iDialog->SetIconNameL(KDialogIcon);

        iDialog->ShowL();

    }

    \endcode

    \code

    Create an animation definition file.    

    <animations>

        <icon name="frame_anim_looping" playmode="loop">

            <frame duration="100">c:\icon1.svg</frame>

            <frame duration="200">c:\icon2.svg</frame>

            <frame duration="300">c:\icon3.svg</frame>

        </icon>

    </animations>   

    Create CHbDeviceNotificationDialogSymbian in a way described before and

    set definition file and animation's logical name.

    _LIT(KAnimationDefinitionXML, "C:\animation.axml"); 

    _LIT(KLogicalIconName, "frame_anim_looping");

    iDialog->SetAnimationDefinitionL(KAnimationDefinitionXML);

    iDialog->SetIconNameL(KLogicalIconName);

    iDialog->ShowL();       

    \endcode

*/

/*!

    Symbian two phase constructor. Returns a pointer to CHbDeviceNotificationDialogSymbian instance.

    \a aObserver Pointer to the observer.

*/

EXPORT_C CHbDeviceNotificationDialogSymbian* CHbDeviceNotificationDialogSymbian::NewL(

    MHbDeviceNotificationDialogObserver* aObserver)

    {

    CHbDeviceNotificationDialogSymbian* self = new (ELeave) CHbDeviceNotificationDialogSymbian();

    CleanupStack::PushL(self);

    self->ConstructL(aObserver);

    CleanupStack::Pop(self);

    return self;

    }

/*!

    Destructor.

*/

EXPORT_C CHbDeviceNotificationDialogSymbian::~CHbDeviceNotificationDialogSymbian()

    {

    delete d;

    }

/*!

    Convenience method for showing notification dialog with icon and title.

*/

EXPORT_C void CHbDeviceNotificationDialogSymbian::NotificationL(const TDesC& aIconName, const TDesC& aTitle)

    {

    CHbDeviceNotificationDialogSymbian* self = CHbDeviceNotificationDialogSymbian::NewL();

    CleanupStack::PushL(self);

    self->SetIconNameL(aIconName);

    self->SetTitleL(aTitle);

    self->ShowL();

    CleanupStack::PopAndDestroy(self);

    }

/*!

    Convenience method for showing notification dialog with icon, text and title.

*/

EXPORT_C void CHbDeviceNotificationDialogSymbian::NotificationL(const TDesC &aIconName, const TDesC& aText, const TDesC& aTitle)

    {

    CHbDeviceNotificationDialogSymbian* self = CHbDeviceNotificationDialogSymbian::NewL();

    CleanupStack::PushL(self);

    self->SetIconNameL(aIconName);

    self->SetTextL(aText);

    self->SetTitleL(aTitle);

    self->ShowL();

    CleanupStack::PopAndDestroy(self);

    }

/*!

    \param aIconName Icon name. Icon can be from Hb resources or themes. Or can be a file in

    a file system.

*/

EXPORT_C void CHbDeviceNotificationDialogSymbian::SetIconNameL(const TDesC& aIconName)

    {

    d->AddVariantL(KKeyIconName, &aIconName, CHbSymbianVariant::EDes);

    }

/*!

    \sa SetIconNameL

*/

EXPORT_C const TPtrC CHbDeviceNotificationDialogSymbian::IconName() const

    {    

    const CHbSymbianVariant* variant = d->Variant(KKeyIconName);

    if (variant && variant->IsValid())

        {

        return *variant->Value<TDesC>();

        }

    return TPtrC(KNullDesC());    

    }

/*!

*/

EXPORT_C void CHbDeviceNotificationDialogSymbian::SetAnimationDefinitionL(const TDesC& aAnimationDefinition)

{

    d->AddVariantL(KKeyAnimationDefinition, &aAnimationDefinition, CHbSymbianVariant::EDes);

}

/*!

    \sa SetAnimationDefinitionL()

*/

EXPORT_C TPtrC CHbDeviceNotificationDialogSymbian::AnimationDefinition() const

{

    const CHbSymbianVariant* variant = d->Variant(KKeyAnimationDefinition);

    if (variant && variant->IsValid())

        {

        return *variant->Value<TDesC>();

        }

    return TPtrC(KNullDesC());

}

/*!

*/

EXPORT_C void CHbDeviceNotificationDialogSymbian::SetTextL(const TDesC& aText)

    {

    d->AddVariantL(KKeyText, &aText, CHbSymbianVariant::EDes);

    }

/*!