summaryrefslogtreecommitdiffstats
path: root/src/imports/virtualkeyboard/platforminputcontext/declarativeinputcontext.h
blob: cb695ab61beaf5bb7d615f743389a40baeaa6e60 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
/****************************************************************************
**
** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/
**
** This file is part of the examples of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:BSD$
** You may use this file under the terms of the BSD license as follows:
**
** "Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are
** met:
**   * Redistributions of source code must retain the above copyright
**     notice, this list of conditions and the following disclaimer.
**   * Redistributions in binary form must reproduce the above copyright
**     notice, this list of conditions and the following disclaimer in
**     the documentation and/or other materials provided with the
**     distribution.
**   * Neither the name of Nokia Corporation and its Subsidiary(-ies) nor
**     the names of its contributors may be used to endorse or promote
**     products derived from this software without specific prior written
**     permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef DECLARATIVEINPUTCONTEXT_H
#define DECLARATIVEINPUTCONTEXT_H

#include <QObject>
#include <QRectF>
#include <QFont>
#include <QtQml/qqml.h>

class PlatformInputContext;
class QQuickItem;

class DeclarativeInputContext : public QObject
{
    Q_OBJECT
    Q_PROPERTY(bool inputMethodVisible READ inputMethodVisible NOTIFY inputMethodVisibleChanged)
    Q_PROPERTY(bool focus READ focus NOTIFY focusChanged)
    Q_PROPERTY(bool shift READ shift WRITE setShift NOTIFY shiftChanged)
    Q_PROPERTY(bool capsLock READ capsLock WRITE setCapsLock NOTIFY capsLockChanged)
    Q_PROPERTY(int cursorPosition READ cursorPosition NOTIFY cursorPositionChanged)
    Q_PROPERTY(Qt::InputMethodHints inputMethodHints READ inputMethodHints NOTIFY inputMethodHintsChanged)
    Q_PROPERTY(QString preeditText READ preeditText WRITE setPreeditText NOTIFY preeditTextChanged)
    Q_PROPERTY(QString surroundingText READ surroundingText NOTIFY surroundingTextChanged)
    Q_PROPERTY(QString selectedText READ selectedText NOTIFY selectedTextChanged)
    Q_PROPERTY(QRectF cursorRectangle READ cursorRectangle NOTIFY cursorRectangleChanged)
    Q_PROPERTY(QRectF keyboardRectangle READ keyboardRectangle WRITE setKeyboardRectangle NOTIFY keyboardRectangleChanged)

public:
    explicit DeclarativeInputContext(PlatformInputContext *parent = 0);
    ~DeclarativeInputContext();

    bool inputMethodVisible() const;
    void setInputMethodVisibleProperty(bool visible);

    bool focus() const;
    void setFocus(bool enable);

    bool shift() const;
    void setShift(bool enable);

    bool capsLock() const;
    void setCapsLock(bool enable);

    int cursorPosition() const;

    Qt::InputMethodHints inputMethodHints() const;

    QString preeditText() const;
    void setPreeditText(const QString &text);

    QString surroundingText() const;

    QString selectedText() const;

    QRectF cursorRectangle() const;

    QRectF keyboardRectangle() const;
    Q_INVOKABLE void setKeyboardRectangle(QRectF rectangle);

    Q_INVOKABLE void sendKeyClick(int key, const QString &text, int modifiers = 0);
    Q_INVOKABLE void sendPreedit(const QString &text, int cursor = -1);

    Q_INVOKABLE void commit();
    Q_INVOKABLE void commit(const QString &text, int replacementStart = 0, int replacementEnd = 0);

    Q_INVOKABLE void clear();

    Q_INVOKABLE void setAnimating(bool animating);
    Q_INVOKABLE void setLocale(QString name);

    void update(Qt::InputMethodQueries queries);

    Q_INVOKABLE void registerCharacterKey(QQuickItem * key);
    Q_INVOKABLE void unregisterCharacterKey(QQuickItem * key);
    Q_INVOKABLE void handleUppercasing(bool uppercased);

signals:
    void inputMethodVisibleChanged();
    void focusChanged();
    void preeditTextChanged();
    void surroundingTextChanged();
    void selectedTextChanged();
    void cursorPositionChanged();
    void inputMethodHintsChanged();
    void focusEditorChanged();
    void shiftChanged();
    void capsLockChanged();
    void cursorRectangleChanged();
    void keyboardRectangleChanged();

private:
    void updateInputMethodValues();

    PlatformInputContext *m_inputContext;
    bool m_inputMethodVisible;
    bool m_focus;
    bool m_shift;
    bool m_capsLock;
    int m_cursorPosition;
    Qt::InputMethodHints m_inputMethodHints;
    QString m_preeditText;
    QString m_surroundingText;
    QString m_selectedText;
    QRectF m_cursorRectangle;
    QList<QQuickItem *> m_characterKeys;
};

QML_DECLARE_TYPE(DeclarativeInputContext)

#endif