1 /***************************************************************************
2 **
3 ** Copyright (C) 2013 BlackBerry Limited. All rights reserved.
4 ** Contact: https://www.qt.io/licensing/
5 **
6 ** This file is part of the plugins of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
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 Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 3 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 3 requirements
23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24 **
25 ** GNU General Public License Usage
26 ** Alternatively, this file may be used under the terms of the GNU
27 ** General Public License version 2.0 or (at your option) the GNU General
28 ** Public license version 3 or any later version approved by the KDE Free
29 ** Qt Foundation. The licenses are as published by the Free Software
30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31 ** included in the packaging of this file. Please review the following
32 ** information to ensure the GNU General Public License requirements will
33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34 ** https://www.gnu.org/licenses/gpl-3.0.html.
35 **
36 ** $QT_END_LICENSE$
37 **
38 ****************************************************************************/
39 
40 #ifndef QQNXINPUTCONTEXT_H
41 #define QQNXINPUTCONTEXT_H
42 
43 #include <qpa/qplatforminputcontext.h>
44 #include "qqnxscreeneventfilter.h"
45 
46 #include <QtCore/QLocale>
47 #include <QtCore/QMetaType>
48 #include <QtCore/QList>
49 #include <qpa/qplatformintegration.h>
50 
51 #include "imf/imf_client.h"
52 #include "imf/input_control.h"
53 
54 QT_BEGIN_NAMESPACE
55 
56 class QQnxAbstractVirtualKeyboard;
57 class QQnxIntegration;
58 class QQnxImfRequest;
59 
60 class QQnxInputContext : public QPlatformInputContext, public QQnxScreenEventFilter
61 {
62     Q_OBJECT
63 public:
64     explicit QQnxInputContext(QQnxIntegration *integration, QQnxAbstractVirtualKeyboard &keyboard);
65     ~QQnxInputContext();
66 
67     // Indices for selecting and setting highlight colors.
68     enum HighlightIndex {
69         ActiveRegion,
70         AutoCorrected,
71         Reverted,
72     };
73 
74     bool isValid() const override;
75 
76     bool filterEvent(const QEvent *event) override;
77     QRectF keyboardRect() const override;
78     void reset() override;
79     void commit() override;
80     void update(Qt::InputMethodQueries) override;
81     bool handleKeyboardEvent(int flags, int sym, int mod, int scan, int cap, int sequenceId) override;
82 
83 
84     void showInputPanel() override;
85     void hideInputPanel() override;
86     bool isInputPanelVisible() const override;
87 
88     QLocale locale() const override;
89     void setFocusObject(QObject *object) override;
90 
91     static void setHighlightColor(int index, const QColor &color);
92 
93     static bool checkSpelling(const QString &text, void *context, void (*spellCheckDone)(void *context, const QString &text, const QList<int> &indices));
94 
95 private Q_SLOTS:
96     void keyboardVisibilityChanged(bool visible);
97     void keyboardLocaleChanged(const QLocale &locale);
98     void processImfEvent(QQnxImfRequest *event);
99 
100 private:
101     // IMF Event dispatchers
102     bool dispatchFocusGainEvent(int inputHints);
103     void dispatchFocusLossEvent();
104     bool dispatchRequestSoftwareInputPanel();
105     bool dispatchCloseSoftwareInputPanel();
106     int handleSpellCheck(spell_check_event_t *event);
107     int32_t processEvent(event_t *event);
108 
109     void closeSession();
110     bool openSession();
111     bool hasSession();
112     void updateCursorPosition();
113     void endComposition();
114     void finishComposingText();
115     bool hasSelectedText();
116     void updateComposition(spannable_string_t *text, int32_t new_cursor_position);
117 
118     // IMF Event handlers - these events will come in from QCoreApplication.
119     int32_t onCommitText(spannable_string_t *text, int32_t new_cursor_position);
120     int32_t onDeleteSurroundingText(int32_t left_length, int32_t right_length);
121     int32_t onGetCursorCapsMode(int32_t req_modes);
122     int32_t onFinishComposingText();
123     int32_t onGetCursorPosition();
124     spannable_string_t *onGetTextAfterCursor(int32_t n, int32_t flags);
125     spannable_string_t *onGetTextBeforeCursor(int32_t n, int32_t flags);
126     int32_t onSendEvent(event_t *event);
127     int32_t onSetComposingRegion(int32_t start, int32_t end);
128     int32_t onSetComposingText(spannable_string_t *text, int32_t new_cursor_position);
129     int32_t onIsTextSelected(int32_t* pIsSelected);
130     int32_t onIsAllTextSelected(int32_t* pIsSelected);
131     int32_t onForceUpdate();
132 
133     int m_caretPosition;
134     bool m_isComposing;
135     QString m_composingText;
136     bool m_isUpdatingText;
137     bool m_inputPanelVisible;
138     QLocale m_inputPanelLocale;
139     // The object that had focus when the last highlight color was set.
140     QObject *m_focusObject;
141     // Indexed by HighlightIndex
142     QColor m_highlightColor[3];
143     QQnxIntegration *m_integration;
144     QQnxAbstractVirtualKeyboard &m_virtualKeyboard;
145 };
146 
147 QT_END_NAMESPACE
148 
149 #endif // QQNXINPUTCONTEXT_H
150