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

**

** 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 "hbdevicenotificationdialog_p.h"

#include "hbdevicenotificationdialog.h"

#include <hbdevicedialog.h>

#include <hbdevicedialogtrace_p.h>

#include <QTimer>

#include <QTimerEvent>

/*!

    @stable

    @hbwidgets

    \class HbDeviceNotificationDialog

    Use cases in this section:

    - \ref _uc2

    - \ref _uc2_001

    - \ref _uc2_002

    \subsection _uc2 Creating a device notification dialog

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

    \code

    HbDeviceNotificationDialog notificationDialog;

    notificationDialog.setTitle("Title");

    notificationDialog.setText("Text");

    notificationDialog.show();

    \endcode

    or equivalent dialog can be created using convenience method:

    \code

    \endcode

    When using convenience methods, it is not possible to receive user interaction events,

    because the HbDeviceNotificationDialog instance is destroyed when the call returns. Ownership

    and handling of the dialog is transferred to HbDeviceDialog framework. In this case the dialog

    can neither be closed nor updated programmatically.

    \subsection _uc2_001 Receiving user interactions events

    Below is an example of receiving user interaction events from device notification dialog. With

    \code

    mNotificationDialog = new HbDeviceNotificationDialog;

    connect(mNotificationDialog, SIGNAL(activated()), this, SLOT(popupActivated()));

    connect(mNotificationDialog, SIGNAL(aboutToClose()), this, SLOT(release()));

    mNotificationDialog->enableTouchActivation(true);

    mNotificationDialog->setTitle("Title");

    mNotificationDialog->setText("Text");

    mNotificationDialog->show();

    \endcode

    \subsection _uc2_002 Using animations in a device notification dialog

    \code

    <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>

    \endcode

    set the definition file and the logical name of the animation:

    \code

    QString animationDefinitionXML("c:\animation.axml");

    QString logicalIconName("frame_anim_looping");

    mNotificationDialog->setAnimationDefinition(animationDefinitionXML);

    mNotificationDialog->setIconName(logicalIconName);

    \endcode

*/

/*!

    \fn void HbDeviceNotificationDialog::aboutToClose();

 */

/*!

    \fn void HbDeviceNotificationDialog::activated();

*/

HbDeviceNotificationDialogPrivate::HbDeviceNotificationDialogPrivate()

: QObject(), mDeviceDialog(0), mUpdateTimerId(0), mShowing(false)

{

    TRACE_ENTRY

    mData.clear();

    TRACE_EXIT

}

HbDeviceNotificationDialogPrivate::~HbDeviceNotificationDialogPrivate()

{

    TRACE_ENTRY

    // If no signals of notification dialog are connected, disconnect device dialog client signals.

    // This keeps server from deleting the device dialog when client is deleted.

    if (q_ptr->receivers(SIGNAL(aboutToClose())) == 0 &&

        q_ptr->receivers(SIGNAL(activated())) == 0) {

        mDeviceDialog->disconnect();

        if (mUpdateTimerId != 0) {

            // There's a pending update

            update(); // this also kills the timer

        }

    }

    delete mDeviceDialog;

    TRACE_EXIT

}

void HbDeviceNotificationDialogPrivate::init(const QVariantMap &map)

{

    TRACE_ENTRY

    mDeviceDialog = new HbDeviceDialog;

    mData = map;

    TRACE_EXIT

}

void HbDeviceNotificationDialogPrivate::show()

{

    TRACE_ENTRY

    Q_ASSERT(mDeviceDialog);

    killTimer(mUpdateTimerId);

    mUpdateTimerId = 0;

    connect(mDeviceDialog, SIGNAL(deviceDialogClosed()), this, SLOT(deviceDialogClosed()));

        connect(mDeviceDialog, SIGNAL(dataReceived(QVariantMap)), this, SLOT(dataReceived(QVariantMap)));

    }

    if (!mDeviceDialog->show("com.nokia.hb.devicenotificationdialog/1.0", mData)) {

        // Failed to show the device dialog. Start a one shot to emit aboutToClose() signal.

        QTimer::singleShot(0, this, SLOT(deviceDialogClosed()));

    }

    mShowing = true;

    TRACE_EXIT

}

void HbDeviceNotificationDialogPrivate::cancel()

{

    TRACE_ENTRY

    Q_ASSERT(mDeviceDialog);

    mDeviceDialog->cancel();

    mData.clear();

    TRACE_EXIT

}

void HbDeviceNotificationDialogPrivate::update()

{

    TRACE_ENTRY

    Q_ASSERT(mDeviceDialog);

    killTimer(mUpdateTimerId);

    mUpdateTimerId = 0;

    mDeviceDialog->update(mData);

    TRACE_EXIT

}

// Schedule event to update changed properties to device dialog server. update() is not

// called after each time a property is set. Instead an event is scheduled in order to

// update all changed properties in one shot.

void HbDeviceNotificationDialogPrivate::scheduleUpdateEvent()

{

    if (mShowing && mUpdateTimerId == 0) {

        mUpdateTimerId = startTimer(0);

    }

}

void HbDeviceNotificationDialogPrivate::timerEvent(QTimerEvent *event)

{

    if (event->timerId() == mUpdateTimerId) {

        update();

    }

}

void HbDeviceNotificationDialogPrivate::dataReceived(QVariantMap data)

{

    TRACE_ENTRY

    QString temp = data.value("result").toString();

    if (!temp.isEmpty()) {

        emit q_func()->activated();

    }

    TRACE_EXIT

}

void HbDeviceNotificationDialogPrivate::deviceDialogClosed()

{

    TRACE_ENTRY

    mShowing = false;

    emit q_func()->aboutToClose();

    TRACE_EXIT

}

/*!

    Constructor.

*/

HbDeviceNotificationDialog::HbDeviceNotificationDialog(QObject *parent)

: QObject(parent), d_ptr(new HbDeviceNotificationDialogPrivate)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->q_ptr = this;

    QVariantMap data;

    d->init(data);

    TRACE_EXIT

}

/*!

    Destructor.

*/

HbDeviceNotificationDialog::~HbDeviceNotificationDialog()

{

    TRACE_ENTRY

    delete d_ptr;

    TRACE_EXIT

}

/*!

    Convenience method for showing notification dialog with text and title.

*/

void HbDeviceNotificationDialog::notification(const QString &iconName, const QString& title)

{

    TRACE_STATIC_ENTRY

    HbDeviceNotificationDialog *self = new HbDeviceNotificationDialog;

    self->setIconName(iconName);

    self->setTitle(title);

    self->show();

    self->deleteLater();

    self = 0;

    TRACE_EXIT

}

/*!

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

*/

void HbDeviceNotificationDialog::notification(const QString &iconName, const QString &text, const QString &title)

{

    TRACE_STATIC_ENTRY

    HbDeviceNotificationDialog *self = new HbDeviceNotificationDialog;

    self->setIconName(iconName);

    self->setText(text);

    self->setTitle(title);

    self->show();

    self->deleteLater();

    self = 0;

    TRACE_EXIT

}

/*!

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

    a file system.

*/

void HbDeviceNotificationDialog::setIconName(const QString &iconName)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::setText(const QString &text)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::setTitle(const QString &title)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::enableTouchActivation(bool enable)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::setTimeout(int timeout)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::setTitleTextWrapping(Hb::TextWrapping wrapping)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

void HbDeviceNotificationDialog::setAnimationDefinition(QString &animationDefinition)

{

    TRACE_ENTRY

    Q_D(HbDeviceNotificationDialog);

    d->scheduleUpdateEvent();

    TRACE_EXIT

}

/*!

*/

QString HbDeviceNotificationDialog::iconName() const

{

    TRACE_ENTRY

    Q_D(const HbDeviceNotificationDialog);

    TRACE_EXIT

}

/*!

    \sa setText()

*/

QString HbDeviceNotificationDialog::text() const

{

    TRACE_ENTRY

    Q_D(const HbDeviceNotificationDialog);

    TRACE_EXIT

}