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

**

** 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 HbInput 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 <QPixmap>

#include <QBitmap>

#include <QPainter>

#include <QGraphicsItemAnimation>

#include <QGraphicsSceneMouseEvent>

#include <QGraphicsProxyWidget>

#include <QTimeLine>

#include <QGraphicsGridLayout>

#include <QGraphicsScene>

#include <QGraphicsLinearLayout>

#include <hbapplication.h>

#include <hbmainwindow.h>

#include <hbaction.h>

#include <hbview.h>

#include <hbwidget.h>

#include <hbpushbutton.h>

#include <hbinputsettingproxy.h>

#include <hbdialog.h>

#include <hbeffect.h>

#include <hbstackedwidget.h>

#include <hbframedrawer.h>

#include <hbevent.h>

#include <hbinputmethod.h>

#include <hbinputsettingproxy.h>

#include <hbinpututils.h>

#include <hbinputdef.h>

#include <hbinputvkbhost.h>

#include <hbinputsettingdialog.h>

#include <hbinputcommondialogs.h>

#include <hbinputkeymap.h>

#include <hbinputkeymapfactory.h>

#include <hbwidgetfeedback.h>

#include <hbsmileyengine.h>

#include <hbinputpredictionfactory.h>

#include "hbinputvirtualrocker.h"

#include "hbinputvkbwidget.h"

#include "hbinputvkbwidget_p.h"

#include "hbinputtouchkeypadbutton.h"

#include "hbinputsettinglist.h"

#include "hbinputmodeindicator.h"

#include <hbfeedbackmanager.h>

#include "hbinputsmileypicker.h"

#include "hbinputscreenshotwidget.h"

const qreal HbMouseDragDelta = 0.4;

const qreal HbRockerWidth = 50.0;

const int MaxSweepTime = 500;

const int SweepLength = 150;

/*!

@proto

@hbinput

\class HbInputVkbWidget

\brief A base class for touch keypads.

This class implements default mechanisms for opening and closing touch keypads.

It know how to operate in landscape and in portait modes and it know how

implement split view -mechasnism for S60 QT UI's Hb library. It also implements

closing mechansim, where used is able to close the touch keypad by sliding it downwards

with a finger. This class also implements background drawing for touch keypads.

*/

/// @cond

inline HbWidget* hbwidget_cast(QGraphicsItem *item)

{

    if( item->isWidget() && static_cast<QGraphicsWidget*>(item)->inherits("HbWidget") ) {

        return static_cast<HbWidget*>(item);

    }

    return 0;

}

HbInputVkbWidgetPrivate::HbInputVkbWidgetPrivate()

: mOwner(0),

mMode(EModeAbc),

mKeymap(0),

mModifiers(0),

mInputModeIndicator(0),

mApplicationButton(0),

mSettingsButton(0),

mSettingList(0),

mButtonLayout(0),

mRocker(0),

mBackgroundDrawer(0),

mIconDrawer(0),

mMainWinConnected(false),

mShowRocker(false),

mLayout(0),

mCurrentHost(0),

mDrawbackground(true),

mMouseButtonPressedDown(false),

mFlickDirection(HbInputVkbWidget::HbFlickDirectionNone),

mSmileyPicker(0),

mScreenshotWidget(0),

mScreenshotTimeLine(250),

mMostRecentlyAccessedButton(0),

mMostRecentlyClickedLocation(0.0,0.0),

mFocusedObject(0),

mFlickAnimation(false),

mSettingsListOpen(false),

mAnimateWhenDialogCloses(false),

mKeyboardSize(HbQwerty4x10),

mCloseHandleHeight(0),

mCloseHandle(NULL),

mKeyboardDimmed(false)

{

}

HbInputVkbWidgetPrivate::~HbInputVkbWidgetPrivate()

{

    delete mSettingList;

    delete mBackgroundDrawer;

    delete mIconDrawer;

    delete mSmileyPicker;

    delete mScreenshotWidget;

}

void HbInputVkbWidgetPrivate::init()

{

    Q_Q(HbInputVkbWidget);

    mRocker = new HbInputVirtualRocker(q);

    mRocker->setObjectName("VirtualRocker");

    QSizeF rockerSize(HbRockerWidth, HbRockerWidth);

    mRocker->resize(rockerSize);

    mRocker->setMinimumSize(HbRockerWidth, HbRockerWidth);

    mRocker->setMaximumSize(HbRockerWidth*20, HbRockerWidth*20);

    QObject::connect(mRocker, SIGNAL(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)),

        q, SIGNAL(rockerDirection(int, HbInputVirtualRocker::RockerSelectionMode)));

    mRocker->setVisible(false);

    mBackgroundDrawer = new HbFrameDrawer();

    mBackgroundDrawer->setFrameGraphicsName(backgroundGraphics);

    mBackgroundDrawer->setFrameType(HbFrameDrawer::ThreePiecesVertical);

    mBackgroundDrawer->setFillWholeRect(true);

    mBackgroundDrawer->setBorderWidths(0.0, HbCloseHandleHeight, 0.0, HbCloseHandleHeight);

    mIconDrawer = new HbFrameDrawer();

    mIconDrawer->setFrameType(HbFrameDrawer::OnePiece);

    mIconDrawer->setFrameGraphicsName(HbInputVkbHandleIcon);

    mReleaseMapper = new QSignalMapper(q);

    mPressMapper = new QSignalMapper(q);

    mActionMapper = new QSignalMapper(q);

}

// re-implemented by inherited keyboards

int HbInputVkbWidgetPrivate::keyCode(int buttonId)

{

    Q_UNUSED(buttonId);

    return -1;

}

// re-implemented by inherited keyboards

int HbInputVkbWidgetPrivate::keyCode(HbTouchKeypadButton *button)

{

    Q_UNUSED(button);

    return -1;

}

void HbInputVkbWidgetPrivate::handleStandardButtonPress(int buttonid)

{

    int keycode = buttonid;

    if (buttonid >= 0) {

        keycode = keyCode(buttonid);

    }

    QKeyEvent event(QEvent::KeyPress, keycode, Qt::NoModifier);

    if (mOwner) {

        mOwner->filterEvent(&event);

    }

}

void HbInputVkbWidgetPrivate::handleStandardButtonRelease(int buttonid)

{

    int keycode = buttonid;

    if (buttonid >= 0) {

        keycode = keyCode(buttonid);

    }

    QKeyEvent event(QEvent::KeyRelease, keycode, Qt::NoModifier);

    if (mOwner) {

        mOwner->filterEvent(&event);

    }

}

void HbInputVkbWidgetPrivate::addCustomButtonToLayout( HbTouchKeypadButton* button,

                                                       int index)

{

    Q_UNUSED(button);

    Q_UNUSED(index);

}

void HbInputVkbWidgetPrivate::redirectMousePressEvent(QGraphicsSceneMouseEvent *aEvent)

{

    q_ptr->mousePressEvent(aEvent);

}

void HbInputVkbWidgetPrivate::redirectMouseReleaseEvent(QGraphicsSceneMouseEvent *aEvent)

{

    q_ptr->mouseReleaseEvent(aEvent);

}

void HbInputVkbWidgetPrivate::applyEditorConstraints() {

    // no default implementaiton as of now.

}

void HbInputVkbWidgetPrivate::setRockerPosition()

{

    Q_Q(HbInputVkbWidget);

    // Set rocker position.

    QSizeF padArea = q->keypadButtonAreaSize();

    QPointF point((padArea.width() * 0.5) - (mRocker->size().width() * 0.5),

        (padArea.height() * 0.5) - (mRocker->size().height() * 0.5));

    point.setY(point.y() + mCloseHandleHeight);

    if (q->keypadLayout() && q->keypadLayout()->geometry().height()) {

        point.setX(((padArea.width() * 0.5) - (mRocker->size().width() * 0.5)));

        point.setY(((q->keypadLayout()->geometry().height() * 0.5) - (mRocker->size().height() * 0.5) + mCloseHandleHeight));

    }

    mRocker->setPos(point);

}

void HbInputVkbWidgetPrivate::captureScreenshot()

{

    Q_Q(HbInputVkbWidget);

    if (!mScreenshotWidget) {

        mScreenshotWidget = new HbInputScreenshotWidget();

        mScreenshotWidget->setGeometry(q->geometry());

        q->mainWindow()->scene()->addItem(mScreenshotWidget);

    }

    QPointF position = q->pos();

    QRectF rect = QRectF(position.x(), position.y()+ mCloseHandleHeight, q->boundingRect().width(), q->boundingRect().height()- mCloseHandleHeight);

    QTransform rotateTrans;

    rotateTrans = q->mainWindow()->viewportTransform();

    QRectF transRect = rotateTrans.mapRect(rect);

    QPixmap pixmap;

    pixmap = QPixmap::grabWidget(q->mainWindow(), (int)transRect.x(), (int)transRect.y(), (int)transRect.width(), (int)transRect.height());

    pixmap = pixmap.transformed(rotateTrans.inverted());

    mScreenshotWidget->setScreenshot(pixmap);

}

void HbInputVkbWidgetPrivate::updateMouseHitItem(HbTouchKeypadButton *button, QPointF position)

{

    mMostRecentlyAccessedButton = button;

    mMostRecentlyClickedLocation = position;

}

void HbInputVkbWidgetPrivate::normalizeProbabilities(QList<HbKeyPressProbability> &allProbableKeys)

{

    qreal sum = 0.0;

    foreach (HbKeyPressProbability key, allProbableKeys) {

        sum += key.probability;

    }

    for (int count=0;count<allProbableKeys.size();count++) {

        allProbableKeys[count].probability = allProbableKeys[count].probability / sum;

    }

}

bool HbInputVkbWidgetPrivate::isKeyboardDimmed()

{

    return mKeyboardDimmed;

}

bool HbInputVkbWidgetPrivate::isSmileysEnabled()

{

    bool ret = false;

    if (!mOwner || !mOwner->focusObject()) {

        return ret;

    }

    if (mOwner->focusObject()->editorInterface().editor()->inherits("HbAbstractEdit")) {

        if (!mOwner->focusObject()->editorInterface().smileyTheme().isNull()) {

            ret = true;

        }		

    }	else {

        HbSmileyEngine smileyEngine;

        if (!smileyEngine.defaultTheme().isNull()) {

            ret = true;

        }	

    }	

    return ret;	

}

/// @endcond

/*!

Costructs the object.

*/

HbInputVkbWidget::HbInputVkbWidget(QGraphicsItem* parent)

    : HbWidget(*new HbInputVkbWidgetPrivate, parent)

{

    Q_D(HbInputVkbWidget);

    d->q_ptr = this;

    d->init();

    setFocusPolicy(Qt::ClickFocus);

    setPos(QPointF(0,0));

#ifdef HB_EFFECTS

    HbEffect::disable(this);

#endif // HB_EFFECTS

#if QT_VERSION >= 0x040600

    // Make sure the keypad never steals focus.

    setFlag(QGraphicsItem::ItemIsPanel, true);

    setActive(false);

#endif

}

/*!

Constructs the object.

*/

HbInputVkbWidget::HbInputVkbWidget(HbInputVkbWidgetPrivate& dd, QGraphicsItem* parent)

  : HbWidget(dd, parent)

{

    Q_D(HbInputVkbWidget);

    d->q_ptr = this;

    d->init();

    setFocusPolicy(Qt::ClickFocus);

    setPos(QPointF(0,0));

#ifdef HB_EFFECTS

    HbEffect::disable(this);

#endif // HB_EFFECTS

#if QT_VERSION >= 0x040600

    // Make sure the keypad never steals focus.

    setFlag(QGraphicsItem::ItemIsPanel, true);

    setActive(false);

#endif

}

/*!

Destructs the object.

*/

HbInputVkbWidget::~HbInputVkbWidget()

{

}

/*!

Vkb host calls this handler when the keypad open animation finishes.

*/

void HbInputVkbWidget::keyboardOpened(HbVkbHost *host)

{

    Q_D(HbInputVkbWidget);

    d->mCurrentHost = host;

    d->mRocker->setVisible(d->mShowRocker);

    d->setRockerPosition();

}

/*!

Vkb host calls this handler when the keyboard close animation has finished.

\sa HbVkbHost

*/

void HbInputVkbWidget::keyboardClosed(HbVkbHost *host)

{

    Q_UNUSED(host);

    Q_D(HbInputVkbWidget);

    d->mRocker->setVisible(false);

}

/*!

Vkb host calls this handler when the keyboard minimize animation has finished.

\sa HbVkbHost

*/

void HbInputVkbWidget::keyboardMinimized(HbVkbHost *host)

{

    Q_UNUSED(host);

}

/*!

handles mouse press event.

*/

void HbInputVkbWidget::mousePressEvent(QGraphicsSceneMouseEvent* event)

{

    Q_D(HbInputVkbWidget);

    Q_UNUSED(event);

    if (!d->mMouseButtonPressedDown) {

        d->mMouseButtonPressedDown = true;

        d->mMousePressTime.start();

    }

}

/*!

Handles mouse release event.

*/

void HbInputVkbWidget::mouseReleaseEvent(QGraphicsSceneMouseEvent* event)

{

    Q_D(HbInputVkbWidget);

    d->mFlickDirection = HbFlickDirectionNone;

    d->mMouseButtonPressedDown = false;

    QPointF mouseDownpoint = event->buttonDownScenePos(Qt::LeftButton);

    if (d->mCurrentHost && d->mCurrentHost->keypadStatus() != HbVkbHost::HbVkbStatusOpened &&

        d->mCurrentHost->activeKeypad() && d->mOwner) {

        HbWidgetFeedback::triggered(this, Hb::InstantFlicked);

        d->mCurrentHost->openKeypad(d->mCurrentHost->activeKeypad(), d->mOwner);

    } else if (d->mMousePressTime.elapsed() < MaxSweepTime || mouseDownpoint.y() <= scenePos().y() + d->mCloseHandleHeight) {

        QPointF delta = event->scenePos() - mouseDownpoint;

        qreal height;

        if (HbInputSettingProxy::instance()->screenOrientation() == Qt::Horizontal) {

            height = geometry().height() * 0.5;

        } else {

            // For ITU-T, 40% of the scene height is considered.

            height = 0.4 * geometry().height();

        }

        // If the user drags the mouse on keypad and the

        // delta is greater than 10% of the height, keypad is closed

        height = HbMouseDragDelta * height;

        if (delta.y() > height) {

            HbWidgetFeedback::triggered(this, Hb::InstantFlicked);

            d->mFlickDirection = HbFlickDirectionDown;

            emit keypadCloseEventDetected(HbVkbCloseMethodButtonDrag);

        }

        if (qAbs(delta.x()) > SweepLength) {

            d->mFlickDirection = delta.x()>0 ? HbFlickDirectionRight : HbFlickDirectionLeft;

            if (d->mFlickAnimation){

                HbWidgetFeedback::triggered(this, Hb::InstantFlicked);

                animKeyboardChange();

            }

            emit flickEvent(d->mFlickDirection);

        }

    }

}

/*!

Handles virtual key press

*/

void HbInputVkbWidget::mappedKeyPress(int buttonid)

{

    Q_D(HbInputVkbWidget);

    d->handleStandardButtonPress(buttonid);

}

/*!

Handles virtual key release

*/

void HbInputVkbWidget::mappedKeyRelease(int buttonid)

{

    Q_D(HbInputVkbWidget);

    d->handleStandardButtonRelease(buttonid);

}

/*!

The paint method. Draws the widget.

*/

void HbInputVkbWidget::paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget)

{

    Q_UNUSED(option);

    Q_UNUSED(widget);

    Q_D(HbInputVkbWidget);

    QRectF rect = boundingRect();

    if (d->mDrawbackground) {

        d->mBackgroundDrawer->paint(painter, rect);

    }

    rect.setLeft(rect.width()/2 - d->mCloseHandleHeight*3);

    rect.setWidth(d->mCloseHandleHeight*6);

    rect.setHeight(d->mCloseHandleHeight);

    d->mIconDrawer->paint(painter, rect);

}

/*!

Sets virtual rocker visibility.

*/

void HbInputVkbWidget::setRockerVisible(bool visible)

{

    Q_D(HbInputVkbWidget);

    d->mShowRocker = visible;

}

/*!

Returns true if virtual rocker is allowed to be visible.

*/

bool HbInputVkbWidget::isRockerVisible() const

{

    Q_D(const HbInputVkbWidget);

    if (d->mShowRocker) {

        return d->mRocker->isVisible();