1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the Qt Virtual Keyboard module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:GPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/contact-us. 16 ** 17 ** GNU General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU 19 ** General Public License version 3 or (at your option) any later version 20 ** approved by the KDE Free Qt Foundation. The licenses are as published by 21 ** the Free Software Foundation and appearing in the file LICENSE.GPL3 22 ** included in the packaging of this file. Please review the following 23 ** information to ensure the GNU General Public License requirements will 24 ** be met: https://www.gnu.org/licenses/gpl-3.0.html. 25 ** 26 ** $QT_END_LICENSE$ 27 ** 28 ****************************************************************************/ 29 30 #ifndef ABSTRACTINPUTMETHOD_H 31 #define ABSTRACTINPUTMETHOD_H 32 33 #include "inputengine.h" 34 #include "selectionlistmodel.h" 35 #include <QtCore/private/qobject_p.h> 36 37 namespace QtVirtualKeyboard { 38 39 class AbstractInputMethodPrivate : public QObjectPrivate 40 { 41 public: 42 AbstractInputMethodPrivate(); 43 44 InputEngine *inputEngine; 45 }; 46 47 class AbstractInputMethod : public QObject 48 { 49 Q_OBJECT 50 Q_DECLARE_PRIVATE(AbstractInputMethod) 51 52 protected: 53 AbstractInputMethod(AbstractInputMethodPrivate &dd, QObject *parent = 0); 54 public: 55 explicit AbstractInputMethod(QObject *parent = 0); 56 ~AbstractInputMethod(); 57 58 InputContext *inputContext() const; 59 InputEngine *inputEngine() const; 60 61 virtual QList<InputEngine::InputMode> inputModes(const QString &locale) = 0; 62 virtual bool setInputMode(const QString &locale, InputEngine::InputMode inputMode) = 0; 63 virtual bool setTextCase(InputEngine::TextCase textCase) = 0; 64 65 virtual bool keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) = 0; 66 67 virtual QList<SelectionListModel::Type> selectionLists(); 68 virtual int selectionListItemCount(SelectionListModel::Type type); 69 virtual QVariant selectionListData(SelectionListModel::Type type, int index, int role); 70 virtual void selectionListItemSelected(SelectionListModel::Type type, int index); 71 72 virtual QList<InputEngine::PatternRecognitionMode> patternRecognitionModes() const; 73 virtual Trace *traceBegin(int traceId, InputEngine::PatternRecognitionMode patternRecognitionMode, 74 const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo); 75 virtual bool traceEnd(Trace *trace); 76 77 virtual bool reselect(int cursorPosition, const InputEngine::ReselectFlags &reselectFlags); 78 79 signals: 80 void selectionListChanged(int type); 81 void selectionListActiveItemChanged(int type, int index); 82 83 public slots: 84 virtual void reset(); 85 virtual void update(); 86 87 private: 88 void setInputEngine(InputEngine *inputEngine); 89 90 friend class InputEngine; 91 }; 92 93 } // namespace QtVirtualKeyboard 94 95 #endif 96