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