/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtGui of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, 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 qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef QT_NO_IM
#include "qcoefepinputcontext_p.h"
#include <qapplication.h>
#include <qtextformat.h>
#include <private/qcore_symbian_p.h>
#include <fepitfr.h>
#include <limits.h>
// You only find these enumerations on SDK 5 onwards, so we need to provide our own
// to remain compatible with older releases. They won't be called by pre-5.0 SDKs.
// MAknEdStateObserver::EAknCursorPositionChanged
#define QT_EAknCursorPositionChanged MAknEdStateObserver::EAknEdwinStateEvent(6)
// MAknEdStateObserver::EAknActivatePenInputRequest
#define QT_EAknActivatePenInputRequest MAknEdStateObserver::EAknEdwinStateEvent(7)
QT_BEGIN_NAMESPACE
QCoeFepInputContext::QCoeFepInputContext(QObject *parent)
: QInputContext(parent),
m_fepState(q_check_ptr(new CAknEdwinState)), // CBase derived object needs check on new
m_lastImHints(Qt::ImhNone),
m_textCapabilities(TCoeInputCapabilities::EAllText),
m_isEditing(false),
m_inDestruction(false),
m_pendingInputCapabilitiesChanged(false),
m_cursorVisibility(1),
m_inlinePosition(0),
m_formatRetriever(0),
m_pointerHandler(0)
{
m_fepState->SetObjectProvider(this);
m_fepState->SetFlags(EAknEditorFlagDefault);
m_fepState->SetDefaultInputMode( EAknEditorTextInputMode );
m_fepState->SetPermittedInputModes( EAknEditorAllInputModes );
m_fepState->SetDefaultCase( EAknEditorLowerCase );
m_fepState->SetPermittedCases( EAknEditorLowerCase|EAknEditorUpperCase );
m_fepState->SetSpecialCharacterTableResourceId( 0 );
m_fepState->SetNumericKeymap( EAknEditorStandardNumberModeKeymap );
}
QCoeFepInputContext::~QCoeFepInputContext()
{
m_inDestruction = true;
// This is to make sure that the FEP manager "forgets" about us,
// otherwise we may get callbacks even after we're destroyed.
// The call below is essentially equivalent to InputCapabilitiesChanged(),
// but is synchronous, rather than asynchronous.
CCoeEnv::Static()->SyncNotifyFocusObserversOfChangeInFocus();
if (m_fepState)
delete m_fepState;
}
void QCoeFepInputContext::reset()
{
CCoeFep* fep = CCoeEnv::Static()->Fep();
if (fep)
fep->CancelTransaction();
}
void QCoeFepInputContext::ReportAknEdStateEvent(MAknEdStateObserver::EAknEdwinStateEvent aEventType)
{
QT_TRAP_THROWING(m_fepState->ReportAknEdStateEventL(aEventType));
}
void QCoeFepInputContext::update()
{
updateHints(false);
// :QTP: Always show virtual keyboard - fix needed to use feature manager
// For pre-5.0 SDKs, we don't do text updates on S60 side.
//if (QSysInfo::s60Version() != QSysInfo::SV_S60_5_0) {
// return;
//}
// Don't be fooled (as I was) by the name of this enumeration.
// What it really does is tell the virtual keyboard UI that the text has been
// updated and it should be reflected in the internal display of the VK.
ReportAknEdStateEvent(QT_EAknCursorPositionChanged);
}
void QCoeFepInputContext::setFocusWidget(QWidget *w)
{
commitCurrentString(false);
QInputContext::setFocusWidget(w);
updateHints(true);
}
void QCoeFepInputContext::widgetDestroyed(QWidget *w)
{
// Make sure that the input capabilities of whatever new widget got focused are queried.
CCoeControl *ctrl = w->effectiveWinId();
if (ctrl->IsFocused()) {
ctrl->SetFocus(false);
ctrl->SetFocus(true);
}
}
QString QCoeFepInputContext::language()
{
TLanguage lang = m_fepState->LocalLanguage();
const QByteArray localeName = qt_symbianLocaleName(lang);
if (!localeName.isEmpty()) {
return QString::fromLatin1(localeName);
} else {
return QString::fromLatin1("C");
}
}
bool QCoeFepInputContext::filterEvent(const QEvent *event)
{
// The CloseSoftwareInputPanel event is not handled here, because the VK will automatically
// close when it discovers that the underlying widget does not have input capabilities.
if (!focusWidget())
return false;
if (event->type() == QEvent::KeyPress || event->type() == QEvent::KeyRelease) {
const QKeyEvent *keyEvent = static_cast<const QKeyEvent *>(event);
Q_ASSERT(m_lastImHints == focusWidget()->inputMethodHints());
if (keyEvent->key() == Qt::Key_F20 && m_lastImHints & Qt::ImhHiddenText) {
// Special case in Symbian. On editors with secret text, F20 is for some reason
// considered to be a backspace.
QKeyEvent modifiedEvent(keyEvent->type(), Qt::Key_Backspace, keyEvent->modifiers(),
keyEvent->text(), keyEvent->isAutoRepeat(), keyEvent->count());
QApplication::sendEvent(focusWidget(), &modifiedEvent);
return true;
}
}
// :QTP: Always show virtual keyboard - fix needed to use feature manager
// For pre-5.0 SDKs, we don't launch the keyboard.
/*
if (QSysInfo::s60Version() != QSysInfo::SV_S60_5_0) {
return false;
}
*/
if (event->type() == QEvent::RequestSoftwareInputPanel) {
// Notify S60 that we want the virtual keyboard to show up.
QSymbianControl *sControl;
sControl = focusWidget()->effectiveWinId()->MopGetObject(sControl);
Q_ASSERT(sControl);
// The FEP UI temporarily steals focus when it shows up the first time, causing
// all sorts of weird effects on the focused widgets. Since it will immediately give
// back focus to us, we temporarily disable focus handling until the job's done.
if (sControl) {
sControl->setIgnoreFocusChanged(true);
}
ensureInputCapabilitiesChanged();
m_fepState->ReportAknEdStateEventL(MAknEdStateObserver::QT_EAknActivatePenInputRequest);
if (sControl) {
sControl->setIgnoreFocusChanged(false);
}
return true;
}
return false;
}
void QCoeFepInputContext::mouseHandler( int x, QMouseEvent *event)
{
Q_ASSERT(m_isEditing);
Q_ASSERT(focusWidget());
if (event->type() == QEvent::MouseButtonPress && event->button() == Qt::LeftButton) {
commitCurrentString(false);
int pos = focusWidget()->inputMethodQuery(Qt::ImCursorPosition).toInt();
QList<QInputMethodEvent::Attribute> attributes;
attributes << QInputMethodEvent::Attribute(QInputMethodEvent::Selection, pos + x, 0, QVariant());
QInputMethodEvent event(QLatin1String(""), attributes);
sendEvent(event);
}
}
TCoeInputCapabilities QCoeFepInputContext::inputCapabilities()
{
if (m_inDestruction || !focusWidget()) {
return TCoeInputCapabilities(TCoeInputCapabilities::ENone, 0, 0);
}
return TCoeInputCapabilities(m_textCapabilities, this, 0);
}
static QTextCharFormat qt_TCharFormat2QTextCharFormat(const TCharFormat &cFormat)
{
QTextCharFormat qFormat;
QBrush foreground(QColor(cFormat.iFontPresentation.iTextColor.Internal()));
qFormat.setForeground(foreground);
qFormat.setFontStrikeOut(cFormat.iFontPresentation.iStrikethrough == EStrikethroughOn);
qFormat.setFontUnderline(cFormat.iFontPresentation.iUnderline == EUnderlineOn);
return qFormat;
}
void QCoeFepInputContext::updateHints(bool mustUpdateInputCapabilities)
{
QWidget *w = focusWidget();
if (w) {
Qt::InputMethodHints hints = w->inputMethodHints();
if (hints != m_lastImHints) {
m_lastImHints = hints;
applyHints(hints);
} else if (!mustUpdateInputCapabilities) {
// Optimization. Return immediately if there was no change.
return;
}
}
queueInputCapabilitiesChanged();
}
void QCoeFepInputContext::applyHints(Qt::InputMethodHints hints)
{
using namespace Qt;
bool numbersOnly = hints & ImhDigitsOnly || hints & ImhFormattedNumbersOnly
|| hints & ImhDialableCharactersOnly;
bool noOnlys = !(numbersOnly || hints & ImhUppercaseOnly
|| hints & ImhLowercaseOnly);
TInt flags;
Qt::InputMethodHints oldHints = hints;
// Some sanity checking. Make sure that only one preference is set.
InputMethodHints prefs = ImhPreferNumbers | ImhPreferUppercase | ImhPreferLowercase;
prefs &= hints;
if (prefs != ImhPreferNumbers && prefs != ImhPreferUppercase && prefs != ImhPreferLowercase) {
hints &= ~prefs;
}
if (!noOnlys) {
// Make sure that the preference is within the permitted set.
if (hints & ImhPreferNumbers && !(hints & ImhDigitsOnly || hints & ImhFormattedNumbersOnly
|| hints & ImhDialableCharactersOnly)) {
hints &= ~ImhPreferNumbers;
} else if (hints & ImhPreferUppercase && !(hints & ImhUppercaseOnly)) {
hints &= ~ImhPreferUppercase;
} else if (hints & ImhPreferLowercase && !(hints & ImhLowercaseOnly)) {
hints &= ~ImhPreferLowercase;
}
// If there is no preference, set it to something within the permitted set.
if (!(hints & ImhPreferNumbers || hints & ImhPreferUppercase || hints & ImhPreferLowercase)) {
if (hints & ImhLowercaseOnly) {
hints |= ImhPreferLowercase;
} else if (hints & ImhUppercaseOnly) {
hints |= ImhPreferUppercase;
} else if (hints & ImhDigitsOnly || hints & ImhFormattedNumbersOnly
|| hints & ImhDialableCharactersOnly) {
hints |= ImhPreferNumbers;
}
}
}
if (hints & ImhPreferNumbers) {
m_fepState->SetDefaultInputMode(EAknEditorNumericInputMode);
m_fepState->SetCurrentInputMode(EAknEditorNumericInputMode);
} else {
m_fepState->SetDefaultInputMode(EAknEditorTextInputMode);
m_fepState->SetCurrentInputMode(EAknEditorTextInputMode);
}
flags = 0;
if (numbersOnly) {
flags |= EAknEditorNumericInputMode;
}
if (hints & ImhUppercaseOnly || hints & ImhLowercaseOnly) {
flags |= EAknEditorTextInputMode;
}
if (flags == 0) {
flags = EAknEditorAllInputModes;
}
m_fepState->SetPermittedInputModes(flags);
ReportAknEdStateEvent(MAknEdStateObserver::EAknEdwinStateInputModeUpdate);
if (hints & ImhPreferLowercase) {
m_fepState->SetDefaultCase(EAknEditorLowerCase);
m_fepState->SetCurrentCase(EAknEditorLowerCase);
} else if (hints & ImhPreferUppercase) {
m_fepState->SetDefaultCase(EAknEditorUpperCase);
m_fepState->SetCurrentCase(EAknEditorUpperCase);
} else if (hints & ImhNoAutoUppercase) {
m_fepState->SetDefaultCase(EAknEditorLowerCase);
m_fepState->SetCurrentCase(EAknEditorLowerCase);
} else {
m_fepState->SetDefaultCase(EAknEditorTextCase);
m_fepState->SetCurrentCase(EAknEditorTextCase);
}
flags = 0;
if (hints & ImhUppercaseOnly) {
flags |= EAknEditorUpperCase;
}
if (hints & ImhLowercaseOnly) {
flags |= EAknEditorLowerCase;
}
if (flags == 0) {
flags = EAknEditorAllCaseModes;
if (hints & ImhNoAutoUppercase) {
flags &= ~EAknEditorTextCase;
}
}
m_fepState->SetPermittedCases(flags);
ReportAknEdStateEvent(MAknEdStateObserver::EAknEdwinStateCaseModeUpdate);
flags = 0;
if (hints & ImhUppercaseOnly && !(hints & ImhLowercaseOnly)
|| hints & ImhLowercaseOnly && !(hints & ImhUppercaseOnly)) {
flags |= EAknEditorFlagFixedCase;
}
// Using T9 and hidden text together may actually crash the FEP, so check for hidden text too.
if (hints & ImhNoPredictiveText || hints & ImhHiddenText) {
flags |= EAknEditorFlagNoT9;
}
m_fepState->SetFlags(flags);
ReportAknEdStateEvent(MAknEdStateObserver::EAknEdwinStateFlagsUpdate);
if (hints & ImhFormattedNumbersOnly) {
flags = EAknEditorCalculatorNumberModeKeymap;
} else if (hints & ImhDigitsOnly) {
flags = EAknEditorPlainNumberModeKeymap;
} else {
// ImhDialableCharactersOnly is the fallback as well, so we don't need to check for
// that flag.
flags = EAknEditorStandardNumberModeKeymap;
}
m_fepState->SetNumericKeymap(static_cast<TAknEditorNumericKeymap>(flags));
if (hints & ImhHiddenText) {
m_textCapabilities = TCoeInputCapabilities::EAllText | TCoeInputCapabilities::ESecretText;
} else {
m_textCapabilities = TCoeInputCapabilities::EAllText;
}
}
void QCoeFepInputContext::applyFormat(QList<QInputMethodEvent::Attribute> *attributes)
{
TCharFormat cFormat;
TInt numChars = 0;
TInt charPos = 0;
int oldSize = attributes->size();
while (m_formatRetriever) {
m_formatRetriever->GetFormatOfFepInlineText(cFormat, numChars, charPos);
if (numChars <= 0) {
// This shouldn't happen according to S60 docs, but apparently does sometimes.
break;
}
attributes->append(QInputMethodEvent::Attribute(QInputMethodEvent::TextFormat,
charPos,
numChars,
QVariant(qt_TCharFormat2QTextCharFormat(cFormat))));
charPos += numChars;
if (charPos >= m_preeditString.size()) {
break;
}
}
if (attributes->size() == oldSize) {
// S60 didn't provide any format, so let's give our own instead.
attributes->append(QInputMethodEvent::Attribute(QInputMethodEvent::TextFormat,
0,
m_preeditString.size(),
standardFormat(PreeditFormat)));
}
}
void QCoeFepInputContext::queueInputCapabilitiesChanged()
{
if (m_pendingInputCapabilitiesChanged)
return;
// Call ensureInputCapabilitiesChanged asynchronously. This is done to improve performance
// by not updating input capabilities too often. The reason we don't call the Symbian
// asynchronous version of InputCapabilitiesChanged is because we need to ensure that it
// is synchronous in some specific cases. Those will call ensureInputCapabilitesChanged.
QMetaObject::invokeMethod(this, "ensureInputCapabilitiesChanged", Qt::QueuedConnection);
m_pendingInputCapabilitiesChanged = true;
}
void QCoeFepInputContext::ensureInputCapabilitiesChanged()
{
if (!m_pendingInputCapabilitiesChanged)
return;
// The call below is essentially equivalent to InputCapabilitiesChanged(),
// but is synchronous, rather than asynchronous.
CCoeEnv::Static()->SyncNotifyFocusObserversOfChangeInFocus();
m_pendingInputCapabilitiesChanged = false;
}
void QCoeFepInputContext::StartFepInlineEditL(const TDesC& aInitialInlineText,
TInt aPositionOfInsertionPointInInlineText, TBool aCursorVisibility, const MFormCustomDraw* /*aCustomDraw*/,
MFepInlineTextFormatRetriever& aInlineTextFormatRetriever,
MFepPointerEventHandlerDuringInlineEdit& aPointerEventHandlerDuringInlineEdit)
{
QWidget *w = focusWidget();
if (!w)
return;
m_isEditing = true;
QList<QInputMethodEvent::Attribute> attributes;
m_cursorVisibility = aCursorVisibility ? 1 : 0;
m_inlinePosition = aPositionOfInsertionPointInInlineText;
m_preeditString = qt_TDesC2QString(aInitialInlineText);
m_formatRetriever = &aInlineTextFormatRetriever;
m_pointerHandler = &aPointerEventHandlerDuringInlineEdit;
applyFormat(&attributes);
attributes.append(QInputMethodEvent::Attribute(QInputMethodEvent::Cursor,
m_inlinePosition,
m_cursorVisibility,
QVariant()));
QInputMethodEvent event(m_preeditString, attributes);
sendEvent(event);
}
void QCoeFepInputContext::UpdateFepInlineTextL(const TDesC& aNewInlineText,
TInt aPositionOfInsertionPointInInlineText)
{
QWidget *w = focusWidget();
if (!w)
return;
m_inlinePosition = aPositionOfInsertionPointInInlineText;
QList<QInputMethodEvent::Attribute> attributes;
applyFormat(&attributes);
attributes.append(QInputMethodEvent::Attribute(QInputMethodEvent::Cursor,
m_inlinePosition,
m_cursorVisibility,
QVariant()));
m_preeditString = qt_TDesC2QString(aNewInlineText);
QInputMethodEvent event(m_preeditString, attributes);
sendEvent(event);
}
void QCoeFepInputContext::SetInlineEditingCursorVisibilityL(TBool aCursorVisibility)
{
QWidget *w = focusWidget();
if (!w)
return;
m_cursorVisibility = aCursorVisibility ? 1 : 0;
QList<QInputMethodEvent::Attribute> attributes;
attributes.append(QInputMethodEvent::Attribute(QInputMethodEvent::Cursor,
m_inlinePosition,
m_cursorVisibility,
QVariant()));
QInputMethodEvent event(m_preeditString, attributes);
sendEvent(event);
}
void QCoeFepInputContext::CancelFepInlineEdit()
{
QList<QInputMethodEvent::Attribute> attributes;
QInputMethodEvent event(QLatin1String(""), attributes);
event.setCommitString(QLatin1String(""), 0, 0);
m_preeditString.clear();
sendEvent(event);
m_isEditing = false;
}
TInt QCoeFepInputContext::DocumentLengthForFep() const
{
QWidget *w = focusWidget();
if (!w)
return 0;
QVariant variant = w->inputMethodQuery(Qt::ImSurroundingText);
return variant.value<QString>().size() + m_preeditString.size();
}
TInt QCoeFepInputContext::DocumentMaximumLengthForFep() const
{
QWidget *w = focusWidget();
if (!w)
return 0;
QVariant variant = w->inputMethodQuery(Qt::ImMaximumTextLength);
int size;
if (variant.isValid()) {
size = variant.toInt();
} else {
size = INT_MAX; // Sensible default for S60.
}
return size;
}
void QCoeFepInputContext::SetCursorSelectionForFepL(const TCursorSelection& aCursorSelection)
{
QWidget *w = focusWidget();
if (!w)
return;
int pos = aCursorSelection.iAnchorPos;
int length = aCursorSelection.iCursorPos - pos;
QList<QInputMethodEvent::Attribute> attributes;
attributes << QInputMethodEvent::Attribute(QInputMethodEvent::Selection, pos, length, QVariant());
QInputMethodEvent event(m_preeditString, attributes);
sendEvent(event);
}
void QCoeFepInputContext::GetCursorSelectionForFep(TCursorSelection& aCursorSelection) const
{
QWidget *w = focusWidget();
if (!w) {
aCursorSelection.SetSelection(0,0);
return;
}
int cursor = w->inputMethodQuery(Qt::ImCursorPosition).toInt() + m_preeditString.size();
int anchor = w->inputMethodQuery(Qt::ImAnchorPosition).toInt() + m_preeditString.size();
aCursorSelection.iAnchorPos = anchor;
aCursorSelection.iCursorPos = cursor;
}
void QCoeFepInputContext::GetEditorContentForFep(TDes& aEditorContent, TInt aDocumentPosition,
TInt aLengthToRetrieve) const
{
QWidget *w = focusWidget();
if (!w) {
aEditorContent.FillZ(aLengthToRetrieve);
return;
}
QString text = w->inputMethodQuery(Qt::ImSurroundingText).value<QString>();
// FEP expects the preedit string to be part of the editor content, so let's mix it in.
int cursor = w->inputMethodQuery(Qt::ImCursorPosition).toInt();
text.insert(cursor, m_preeditString);
aEditorContent.Copy(qt_QString2TPtrC(text.mid(aDocumentPosition, aLengthToRetrieve)));
}
void QCoeFepInputContext::GetFormatForFep(TCharFormat& aFormat, TInt /* aDocumentPosition */) const
{
QWidget *w = focusWidget();
if (!w) {
aFormat = TCharFormat();
return;
}
QFont font = w->inputMethodQuery(Qt::ImFont).value<QFont>();
QFontMetrics metrics(font);
//QString name = font.rawName();
QString name = font.defaultFamily(); // TODO! FIXME! Should be the above.
QHBufC hBufC(name);
aFormat = TCharFormat(hBufC->Des(), metrics.height());
}
void QCoeFepInputContext::GetScreenCoordinatesForFepL(TPoint& aLeftSideOfBaseLine, TInt& aHeight,
TInt& aAscent, TInt /* aDocumentPosition */) const
{
QWidget *w = focusWidget();
if (!w) {
aLeftSideOfBaseLine = TPoint(0,0);
aHeight = 0;
aAscent = 0;
return;
}
QRect rect = w->inputMethodQuery(Qt::ImMicroFocus).value<QRect>();
aLeftSideOfBaseLine.iX = rect.left();
aLeftSideOfBaseLine.iY = rect.bottom();
QFont font = w->inputMethodQuery(Qt::ImFont).value<QFont>();
QFontMetrics metrics(font);
aHeight = metrics.height();
aAscent = metrics.ascent();
}
void QCoeFepInputContext::DoCommitFepInlineEditL()
{
commitCurrentString(true);
}
void QCoeFepInputContext::commitCurrentString(bool triggeredBySymbian)
{
if (m_preeditString.size() == 0) {
return;
}
QList<QInputMethodEvent::Attribute> attributes;
QInputMethodEvent event(QLatin1String(""), attributes);
event.setCommitString(m_preeditString, 0, 0);//m_preeditString.size());
m_preeditString.clear();
sendEvent(event);
m_isEditing = false;
if (!triggeredBySymbian) {
CCoeFep* fep = CCoeEnv::Static()->Fep();
if (fep)
fep->CancelTransaction();
}
}
MCoeFepAwareTextEditor_Extension1* QCoeFepInputContext::Extension1(TBool& aSetToTrue)
{
aSetToTrue = ETrue;
return this;
}
void QCoeFepInputContext::SetStateTransferingOwnershipL(MCoeFepAwareTextEditor_Extension1::CState* aState,
TUid /*aTypeSafetyUid*/)
{
// Note: The S60 docs are wrong! See the State() function.
if (m_fepState)
delete m_fepState;
m_fepState = static_cast<CAknEdwinState *>(aState);
}
MCoeFepAwareTextEditor_Extension1::CState* QCoeFepInputContext::State(TUid /*aTypeSafetyUid*/)
{
// Note: The S60 docs are horribly wrong when describing the
// SetStateTransferingOwnershipL function and this function. They say that the former
// sets a CState object identified by the TUid, and the latter retrieves it.
// In reality, the CState is expected to always be a CAknEdwinState (even if it was not
// previously set), and the TUid is ignored. All in all, there is a single CAknEdwinState
// per QCoeFepInputContext, which should be deleted if the SetStateTransferingOwnershipL
// function is used to set a new one.
return m_fepState;
}
TTypeUid::Ptr QCoeFepInputContext::MopSupplyObject(TTypeUid /*id*/)
{
return TTypeUid::Null();
}
QT_END_NAMESPACE
#endif // QT_NO_IM