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 QtGui module 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 QINPUTMETHOD_H
41#define QINPUTMETHOD_H
42
43#include <QtGui/qtguiglobal.h>
44#include <QtCore/qobject.h>
45
46QT_BEGIN_NAMESPACE
47
48class QInputMethodPrivate;
49class QWindow;
50class QRectF;
51class QTransform;
52class QInputMethodQueryEvent;
53
54class Q_GUI_EXPORT QInputMethod : public QObject
55{
56 Q_OBJECT
57 Q_DECLARE_PRIVATE(QInputMethod)
58 Q_PROPERTY(QRectF cursorRectangle READ cursorRectangle NOTIFY cursorRectangleChanged)
59 Q_PROPERTY(QRectF anchorRectangle READ anchorRectangle NOTIFY anchorRectangleChanged)
60 Q_PROPERTY(QRectF keyboardRectangle READ keyboardRectangle NOTIFY keyboardRectangleChanged)
61 Q_PROPERTY(QRectF inputItemClipRectangle READ inputItemClipRectangle NOTIFY inputItemClipRectangleChanged)
62 Q_PROPERTY(bool visible READ isVisible NOTIFY visibleChanged)
63 Q_PROPERTY(bool animating READ isAnimating NOTIFY animatingChanged)
64 Q_PROPERTY(QLocale locale READ locale NOTIFY localeChanged)
65 Q_PROPERTY(Qt::LayoutDirection inputDirection READ inputDirection NOTIFY inputDirectionChanged)
66
67public:
68 QTransform inputItemTransform() const;
69 void setInputItemTransform(const QTransform &transform);
70
71 QRectF inputItemRectangle() const;
72 void setInputItemRectangle(const QRectF &rect);
73
74 // in window coordinates
75 QRectF cursorRectangle() const; // ### what if we have rotations for the item?
76 QRectF anchorRectangle() const; // ### ditto
77
78 // keyboard geometry in window coords
79 QRectF keyboardRectangle() const;
80
81 QRectF inputItemClipRectangle() const;
82
83 enum Action {
84 Click,
85 ContextMenu
86 };
87 Q_ENUM(Action)
88
89 bool isVisible() const;
90 void setVisible(bool visible);
91
92 bool isAnimating() const;
93
94 QLocale locale() const;
95 Qt::LayoutDirection inputDirection() const;
96
97 static QVariant queryFocusObject(Qt::InputMethodQuery query, const QVariant &argument);
98
99public Q_SLOTS:
100 void show();
101 void hide();
102
103 void update(Qt::InputMethodQueries queries);
104 void reset();
105 void commit();
106
107 void invokeAction(Action a, int cursorPosition);
108
109Q_SIGNALS:
110 void cursorRectangleChanged();
111 void anchorRectangleChanged();
112 void keyboardRectangleChanged();
113 void inputItemClipRectangleChanged();
114 void visibleChanged();
115 void animatingChanged();
116 void localeChanged();
117 void inputDirectionChanged(Qt::LayoutDirection newDirection);
118
119private:
120 friend class QGuiApplication;
121 friend class QGuiApplicationPrivate;
122 friend class QPlatformInputContext;
123 QInputMethod();
124 ~QInputMethod();
125};
126
127QT_END_NAMESPACE
128
129#endif
130