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 QVIRTUALKEYBOARDABSTRACTINPUTMETHOD_H
31#define QVIRTUALKEYBOARDABSTRACTINPUTMETHOD_H
32
33#include <QtVirtualKeyboard/qvirtualkeyboardinputengine.h>
34#include <QtVirtualKeyboard/qvirtualkeyboardselectionlistmodel.h>
35
36QT_BEGIN_NAMESPACE
37
38class QVirtualKeyboardAbstractInputMethodPrivate;
39
40class QVIRTUALKEYBOARD_EXPORT QVirtualKeyboardAbstractInputMethod : public QObject
41{
42 Q_OBJECT
43 Q_DECLARE_PRIVATE(QVirtualKeyboardAbstractInputMethod)
44
45public:
46 explicit QVirtualKeyboardAbstractInputMethod(QObject *parent = nullptr);
47 ~QVirtualKeyboardAbstractInputMethod();
48
49 QVirtualKeyboardInputContext *inputContext() const;
50 QVirtualKeyboardInputEngine *inputEngine() const;
51
52 virtual QList<QVirtualKeyboardInputEngine::InputMode> inputModes(const QString &locale) = 0;
53 virtual bool setInputMode(const QString &locale, QVirtualKeyboardInputEngine::InputMode inputMode) = 0;
54 virtual bool setTextCase(QVirtualKeyboardInputEngine::TextCase textCase) = 0;
55
56 virtual bool keyEvent(Qt::Key key, const QString &text, Qt::KeyboardModifiers modifiers) = 0;
57
58 virtual QList<QVirtualKeyboardSelectionListModel::Type> selectionLists();
59 virtual int selectionListItemCount(QVirtualKeyboardSelectionListModel::Type type);
60 virtual QVariant selectionListData(QVirtualKeyboardSelectionListModel::Type type, int index, QVirtualKeyboardSelectionListModel::Role role);
61 virtual void selectionListItemSelected(QVirtualKeyboardSelectionListModel::Type type, int index);
62 virtual bool selectionListRemoveItem(QVirtualKeyboardSelectionListModel::Type type, int index);
63
64 virtual QList<QVirtualKeyboardInputEngine::PatternRecognitionMode> patternRecognitionModes() const;
65 virtual QVirtualKeyboardTrace *traceBegin(
66 int traceId, QVirtualKeyboardInputEngine::PatternRecognitionMode patternRecognitionMode,
67 const QVariantMap &traceCaptureDeviceInfo, const QVariantMap &traceScreenInfo);
68 virtual bool traceEnd(QVirtualKeyboardTrace *trace);
69
70 virtual bool reselect(int cursorPosition, const QVirtualKeyboardInputEngine::ReselectFlags &reselectFlags);
71 virtual bool clickPreeditText(int cursorPosition);
72
73Q_SIGNALS:
74 void selectionListChanged(QVirtualKeyboardSelectionListModel::Type type);
75 void selectionListActiveItemChanged(QVirtualKeyboardSelectionListModel::Type type, int index);
76 void selectionListsChanged();
77
78public Q_SLOTS:
79 virtual void reset();
80 virtual void update();
81
82private:
83 void setInputEngine(QVirtualKeyboardInputEngine *inputEngine);
84
85 friend class QVirtualKeyboardInputEngine;
86};
87
88QT_END_NAMESPACE
89
90#endif
91

source code of qtvirtualkeyboard/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.h