/****************************************************************************
**
** 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 HbPlugins 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 <QTimer>
#include <QGraphicsScene>
#include <hbinputmethod.h>
#include <hbinputkeymapfactory.h>
#include <hbinputpredictionengine.h>
#include <hbinputsettingproxy.h>
#include <hbinputvkbhost.h>
#include <hbinputdialog.h>
#include <hbaction.h>
#include <hbmainwindow.h>
#include <hbinstance.h>
#include <hbeffect.h>
#include <hbinputbutton.h>
#include "virtual12key.h"
#include "hbinputprediction12keyhandler.h"
#include "hbinputpredictionhandler_p.h"
#include "hbinputabstractbase.h"
#include "hbinputprediction12keyhandler_p.h"
#define HbDeltaHeight 3.0
#define MAXUDBWORDSIZE 64
HbInputSpellQuery::HbInputSpellQuery(HbInputPrediction12KeyHandlerPrivate *owner) : mOwner(owner), mPrimaryAction(0)
{
}
void HbInputSpellQuery::launch(QString editorText)
{
HbInputFocusObject *focusObject = mOwner->mInputMethod->focusObject();
if (!focusObject) {
return;
}
mSavedState = mOwner->mInputMethod->inputState();
mOwner->mEngine->clear();
mOwner->mCanContinuePrediction = true;
// close the keypad before showing the spell dialog
HbVkbHost *vkbHost = focusObject->editorInterface().vkbHost();
if (vkbHost && vkbHost->keypadStatus() != HbVkbHost::HbVkbStatusClosed) {
vkbHost->closeKeypad();
}
setInputMode(HbInputDialog::TextInput);
setPromptText(tr("Spell:"));
setValue(QVariant(editorText));
//set the spell dialog position
QSizeF newSize;
QPointF newPos;
QRectF newGeometry;
getPositionAndSize(newPos, newSize, newGeometry);
newGeometry.setHeight(newSize.height());
newGeometry.setWidth(newSize.width());
setGeometry(newGeometry);
setPos(newPos);
// change the focus to spell dialog editor
HbLineEdit *spellEdit = lineEdit();
if (spellEdit) {
spellEdit->setMaxLength(MAXUDBWORDSIZE);
spellEdit->setSmileysEnabled(false);
HbEditorInterface eInt(spellEdit);
// we don't want prediction and automatic textcase in spell query dialog
spellEdit->setInputMethodHints(spellEdit->inputMethodHints() | Qt::ImhNoPredictiveText | Qt::ImhNoAutoUppercase);
eInt.setLastFocusedState(mSavedState);
spellEdit->setFocus();
}
// execute the spell dialog
mSavedFocusObject = focusObject->object();
mSavedEditorText = editorText;
//setAttribute(Qt::WA_DeleteOnClose);
mDidHandleFinish = false;
open(this,SLOT(dialogClosed(HbAction*)));
mPrimaryAction = qobject_cast<HbAction*>(actions().first());
}
void HbInputSpellQuery::dialogClosed(HbAction* action)
{
//There are multiple dialog closed event received. This will make sure we handle finish
//only once
if(mDidHandleFinish) {
return;
} else {
mDidHandleFinish = true;
}
bool isOk = false;
bool isCancel = false;
bool isExternalClose = false;
// action is null when input query is closed externally , for example by calling
// HbDialog::close() function.
if (action) {
isOk = mPrimaryAction == action ? true : false;
isCancel = mPrimaryAction != action ? true : false;
} else {
isExternalClose = true;
}
//Need to disable effects as asynchronous hide will commit the word otherwise.
HbEffect::disable(this);
hide();
HbEffect::enable(this);
HbInputFocusObject *newFocusObject = new HbInputFocusObject(mSavedFocusObject);
newFocusObject->releaseFocus();
newFocusObject->setFocus();
HbAbstractEdit *abstractEdit = qobject_cast<HbAbstractEdit*>(mSavedFocusObject);
if(abstractEdit) {
abstractEdit->setCursorPosition(abstractEdit->cursorPosition());
}
mOwner->mInputMethod->setFocusObject(newFocusObject);
mOwner->mInputMethod->focusObject()->editorInterface().setTextCase(mSavedState.textCase());
if (isOk) {
mOwner->commit(value().toString(), true, true);
} else if (isCancel) {
//update the editor with pre-edit text
mOwner->mEngine->setWord(mSavedEditorText);
bool used = false;
mOwner->mEngine->updateCandidates(mOwner->mBestGuessLocation, used);
mOwner->mShowTail = false;
mOwner->updateEditor();
} else if (isExternalClose) {
mOwner->commit(mSavedEditorText, true, true);
}
mSavedEditorText.clear();
}
void HbInputSpellQuery::getPositionAndSize(QPointF &pos,QSizeF &size, QRectF &geom)
{
pos = HbInputDialog::pos();
size = HbInputDialog::size();
geom = HbInputDialog::geometry();
QRectF cursorRect = mOwner->mInputMethod->focusObject()->microFocus(); // from the top of the screen
pos = QPointF(cursorRect.bottomLeft().x(),cursorRect.bottomLeft().y());
qreal heightOfTitlebar = 80.0; // Using magic number for now...
qreal screenHeight = (qreal)HbDeviceProfile::current().logicalSize().height();
if( ((screenHeight - cursorRect.bottomLeft().y()) > (cursorRect.y() - heightOfTitlebar))
|| ((screenHeight - cursorRect.bottomLeft().y() + HbDeltaHeight ) > geom.height()) ) {
// this means there is amore space below inline text than at the top or we can fit spell Dialog
// below inline text
pos.setY(cursorRect.bottomLeft().y() + HbDeltaHeight);
size.setHeight(screenHeight - pos.y());
} else {
// this means there is amore space above inline text than below it
pos.setY(cursorRect.y() - geom.height() - HbDeltaHeight);
if (pos.y() < heightOfTitlebar) {
// this means that spell dialog can not be fit in from top of inline text, we need to trim it
pos.setY(heightOfTitlebar);
}
size.setHeight(cursorRect.y() - heightOfTitlebar - HbDeltaHeight);
}
if ( size.height() > geom.height()) {
size.setHeight(geom.height());
}
if ((pos.x() + size.width()) > (qreal)HbDeviceProfile::current().logicalSize().width()) {
// can not fit spell dialog to the right side of inline edit text.
pos.setX((qreal)HbDeviceProfile::current().logicalSize().width()- size.width());
}
}
HbInputPrediction12KeyHandlerPrivate::HbInputPrediction12KeyHandlerPrivate()
:mLastKey(0),
mButtonDown(false),
mCurrentChar(0),
mLongPressHappened(false),
mShiftKeyDoubleTap(false),
mInputSpellQuery(NULL)
{
}
HbInputPrediction12KeyHandlerPrivate::~HbInputPrediction12KeyHandlerPrivate()
{
delete mInputSpellQuery;
mInputSpellQuery = 0;
}
void HbInputPrediction12KeyHandlerPrivate::chopQMarkAndUpdateEditor()
{
if(!mCanContinuePrediction && (*mCandidates)[mBestGuessLocation].endsWith('?')) {
(*mCandidates)[mBestGuessLocation].chop(1);
updateEditor();
mCanContinuePrediction = true;
}
}
bool HbInputPrediction12KeyHandlerPrivate::buttonPressed(const QKeyEvent *keyEvent)
{
Q_Q(HbInputPrediction12KeyHandler);
mLongPressHappened = false;
HbInputFocusObject *focusObject = 0;
focusObject = mInputMethod->focusObject();
if (!focusObject) {
return false;
}
int buttonId = keyEvent->key();
if (keyEvent->isAutoRepeat() && mLastKey == buttonId) {
if (buttonId == HbInputButton::ButtonKeyCodeAsterisk) {
if (!mCanContinuePrediction) {
mInputMethod->switchMode(buttonId);
} else {
//Remove the "?" mark if present
chopQMarkAndUpdateEditor();
mInputMethod->selectSpecialCharacterTableMode();
}
mLongPressHappened = true;
} else if (buttonId == HbInputButton::ButtonKeyCodeShift) {
mInputMethod->switchMode(HbInputButton::ButtonKeyCodeShift);
mLongPressHappened = true;
} else if (buttonId == HbInputButton::ButtonKeyCodeSymbol) {
//Remove the "?" mark if present
chopQMarkAndUpdateEditor();
mInputMethod->selectSpecialCharacterTableMode();
mLongPressHappened = true;
} else {
//With a long key press of a key, numbers are supposed to be entered.
//When the existing input (along with the short key press input of the
//existing key) results in tail (i.e. autocompletion), we need to accept
//the short key press as well as the tail. In case of ? delete the questionmark and add the number value.
//mTailShowing = false;
// Delete "?" entered
if (!mCanContinuePrediction) {
deleteOneCharacter();
mLongPressHappened = true;
}
if (buttonId != HbInputButton::ButtonKeyCodeDelete) {
q->commitFirstMappedNumber(buttonId, mInputMethod->currentKeyboardType());
mLongPressHappened = true;
}
}
if (mLongPressHappened) {
mLastKey = 0;
return true;
}
}
if (buttonId == HbInputButton::ButtonKeyCodeShift) {
// if we get a second consequtive shift key press,
// we want to handle it in buttonRelease
if (mTimer->isActive() && (mLastKey == buttonId)){
mShiftKeyDoubleTap = true;
}
}
mLastKey = buttonId;
mButtonDown = true;
return false;
}
/*!
Handles the key release events from the VKB. Launches the SCT with key release event of
asterisk.
*/
bool HbInputPrediction12KeyHandlerPrivate::buttonReleased(const QKeyEvent *keyEvent)
{
Q_Q(HbInputPrediction12KeyHandler);
if(!mButtonDown || mLongPressHappened){
return false;
}
// since button is released we can set buttonDown back to false.
mButtonDown = false;
int buttonId = keyEvent->key();
// Sym key is handled in this class it self, so not passing it to
// the base mode handlers.
if (buttonId == HbInputButton::ButtonKeyCodeSymbol ||
buttonId == HbInputButton::ButtonKeyCodeAlphabet) {
//Remove the "?" mark if present
chopQMarkAndUpdateEditor();
mInputMethod->switchMode(buttonId);
return true;
}
/* Behavior of Short Press of Asterisk Key when in inline editing state
- Should launch Candidate List if we can continue with prediction i.e. "?" is not displayed
- Should launch Spell Query Dialog if we cannot continue with prediction
- Behavior of Short Press of Asterisk Key when not in inline editing state
- Should launch SCT
*/
else if (buttonId == HbInputButton::ButtonKeyCodeAsterisk ) {
if(!mCanContinuePrediction && (*mCandidates)[mBestGuessLocation].endsWith('?')) {
//Remove the "?" mark
(*mCandidates)[mBestGuessLocation].chop(1);
updateEditor();
q->processCustomWord((*mCandidates)[mBestGuessLocation]);
mCanContinuePrediction = true;
}
else
mInputMethod->starKeySelected();
return true;
}
else if (buttonId == HbInputButton::ButtonKeyCodeEnter) {
mInputMethod->closeKeypad();
return true;
}
if (buttonId == HbInputButton::ButtonKeyCodeShift) {
// single tap of shift key toggles prediction status in case insensitive languages
if (!HbInputSettingProxy::instance()->globalInputLanguage().isCaseSensitiveLanguage()) {
HbInputSettingProxy::instance()->togglePrediction();
} else {
if (mShiftKeyDoubleTap) {
mTimer->stop();
mShiftKeyDoubleTap = false;
//mShowTail = false;
if (HbInputSettingProxy::instance()->globalInputLanguage()== mInputMethod->inputState().language()) {
// in latin variants , double tap of shift key toggles the prediction status
// revert back to the old case as this is a double tap
// (the case was changed on the single tap)
updateTextCase();
q->togglePrediction();
} else {
// if the global language is different from the input mode language, we should
// go back to the root state
// e.g. double tap of hash/shift key is used to change
// to chinese input mode from latin input mode
HbInputState rootState;
mInputMethod->editorRootState(rootState);
mInputMethod->activateState(rootState);
}
} else {
updateTextCase();
if( !mTimer->isActive()){
mTimer->start(HbMultiTapTimerTimeout);
}
}
}
return true;
}
if (buttonId != HbInputButton::ButtonKeyCodeDelete &&
mInputMethod->currentKeyboardType() == HbKeyboardSctPortrait) {
q->sctCharacterSelected(QChar(buttonId));
return true;
}
// text input happens on button release
if (q->HbInputPredictionHandler::filterEvent(keyEvent)) {
return true;
}
return false;
}
void HbInputPrediction12KeyHandlerPrivate::cancelButtonPress()
{
mTimer->stop();
mButtonDown = false;
mLastKey = 0;
mShiftKeyDoubleTap = false;
}
HbInputPrediction12KeyHandler::HbInputPrediction12KeyHandler(HbInputAbstractMethod *inputMethod)
:HbInputPredictionHandler(* new HbInputPrediction12KeyHandlerPrivate, inputMethod)
{
Q_D(HbInputPrediction12KeyHandler);
d->q_ptr = this;
}
HbInputPrediction12KeyHandler::HbInputPrediction12KeyHandler(HbInputPrediction12KeyHandlerPrivate &dd, HbInputAbstractMethod* inputMethod)
:HbInputPredictionHandler(dd, inputMethod)
{
Q_D(HbInputPrediction12KeyHandler);
d->q_ptr = this;
d->init();
}
HbInputPrediction12KeyHandler::~HbInputPrediction12KeyHandler()
{
}
/*!
filterEvent to handler keypress/release events.
*/
bool HbInputPrediction12KeyHandler::filterEvent(const QKeyEvent * event)
{
Q_D(HbInputPrediction12KeyHandler);
HbInputFocusObject *focusObject = 0;
focusObject = d->mInputMethod->focusObject();
//If there was a handling for empty candidate-list, i.e. the engine did not predict
//any meaningful word for the input sequence.
if(!d->mCanContinuePrediction) {
int eventKey = event->key();
switch(eventKey) {
case Qt::Key_0:
case HbInputButton::ButtonKeyCodeSpace: {
if(d->mCandidates->size() && focusObject) {
//Remove the "?" mark
(*d->mCandidates)[d->mBestGuessLocation].chop(1);
d->updateEditor();
d->mCanContinuePrediction = true;
}
}
break;
case HbInputButton::ButtonKeyCodeShift: {
if(event->type() == QEvent::KeyRelease && d->mShiftKeyDoubleTap) {
//Remove the "?" mark
deleteOneCharacter();
}
}
//For the following set of keys, it does not matter.
case Qt::Key_Backspace:
case HbInputButton::ButtonKeyCodeDelete:
case HbInputButton::ButtonKeyCodeEnter:
case HbInputButton::ButtonKeyCodeAsterisk:
case HbInputButton::ButtonKeyCodeControl:
break;
/* Behavior for other keys i.e. from key1 to key9 -
To start the long press timer as we need to handle long press functionality i.e Enter corresponding number mapped to a key */
case Qt::Key_1:
case Qt::Key_2:
case Qt::Key_3:
case Qt::Key_4:
case Qt::Key_5:
case Qt::Key_6:
case Qt::Key_7:
case Qt::Key_8:
case Qt::Key_9: {
if (event->type() == QEvent::KeyRelease) {
d->mButtonDown = false;
} else {
d->mButtonDown = true;
d->mLastKey = event->key();
}
return true;
}
//The default behavior for any other key press is just to consume the key event and
//not to do anything.
default: {
return true;
}
}
}
// prediction mode can't handle Qt::Key_0, so we will emit a passFilterEvent
// this signal must be connected to by the plugin to a modehandler.
// which can handle it.
if (event->key() == Qt::Key_0) {
if (d->mLastKey != Qt::Key_0) {
actionHandler(HbInputModeHandler::HbInputModeActionCommit);
}
emit passFilterEvent(event);
d->mLastKey = Qt::Key_0;
return true;
} else {
if (d->mLastKey == Qt::Key_0) {
emit passActionHandler(HbInputModeActionCommit);
}
if (event->type() == QEvent::KeyRelease) {
return d->buttonReleased(event);
} else {
return d->buttonPressed(event);
}
}
}
/*!
Action handler
*/
bool HbInputPrediction12KeyHandler::actionHandler(HbInputModeAction action)
{
Q_D(HbInputPrediction12KeyHandler);
bool ret = true;
switch (action) {
case HbInputModeActionReset:
HbInputPredictionHandler::actionHandler(HbInputModeActionReset);
d->mTimer->stop();
break;
case HbInputModeActionCancelButtonPress:
d->cancelButtonPress();
break;
case HbInputModeActionFocusRecieved:
HbInputPredictionHandler::actionHandler(HbInputModeActionSetCandidateList);
HbInputPredictionHandler::actionHandler(HbInputModeActionSetKeypad);
d->mTimer->stop();
break;
case HbInputModeActionCloseSpellQuery:
if (d->mInputSpellQuery) {
d->mInputSpellQuery->close();
}
break;
default:
ret = HbInputPredictionHandler::actionHandler(action);
break;
}
return ret;
}
void HbInputPrediction12KeyHandler::mouseHandler(int cursorPosition, QMouseEvent* mouseEvent)
{
Q_D(HbInputPrediction12KeyHandler);
if(d->mLastKey == Qt::Key_0) {
// zero key handling is done in the basic handler
emit passActionHandler(HbInputModeActionCommit);
} else {
HbInputPredictionHandler::mouseHandler(cursorPosition,mouseEvent);
}
}
/*!
Returns true if preidciton engine is available and initialized.
*/
bool HbInputPrediction12KeyHandler::isActive() const
{
Q_D(const HbInputPrediction12KeyHandler);
return d->mEngine != 0;
}
void HbInputPrediction12KeyHandler::processCustomWord(QString customWord)
{
Q_D(HbInputPrediction12KeyHandler);
if (customWord.size()) {
if(!d->mInputSpellQuery) {
d->mInputSpellQuery = new HbInputSpellQuery(d);
}
d->mInputSpellQuery->launch(customWord);
}
return;
}
//EOF