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 VIRTUALKEYBOARDSETTINGS_H
31#define VIRTUALKEYBOARDSETTINGS_H
32
33//
34// W A R N I N G
35// -------------
36//
37// This file is not part of the Qt API. It exists purely as an
38// implementation detail. This header file may change from version to
39// version without notice, or even be removed.
40//
41// We mean it.
42//
43
44#include <qqml.h>
45#include <QtVirtualKeyboard/qvirtualkeyboard_global.h>
46
47QT_BEGIN_NAMESPACE
48namespace QtVirtualKeyboard {
49
50class WordCandidateListSettings;
51class VirtualKeyboardSettingsPrivate;
52
53class QVIRTUALKEYBOARD_EXPORT VirtualKeyboardSettings : public QObject
54{
55 Q_OBJECT
56 Q_DECLARE_PRIVATE(VirtualKeyboardSettings)
57 Q_PROPERTY(QUrl style READ style NOTIFY styleChanged)
58 Q_PROPERTY(QUrl layoutPath READ layoutPath WRITE setLayoutPath NOTIFY layoutPathChanged)
59 Q_PROPERTY(QString styleName READ styleName WRITE setStyleName NOTIFY styleNameChanged)
60 Q_PROPERTY(QString locale READ locale WRITE setLocale NOTIFY localeChanged)
61 Q_PROPERTY(QStringList availableLocales READ availableLocales NOTIFY availableLocalesChanged)
62 Q_PROPERTY(QStringList activeLocales READ activeLocales WRITE setActiveLocales NOTIFY activeLocalesChanged)
63 Q_PROPERTY(WordCandidateListSettings *wordCandidateList READ wordCandidateList CONSTANT)
64 Q_PROPERTY(bool fullScreenMode READ fullScreenMode WRITE setFullScreenMode NOTIFY fullScreenModeChanged)
65
66public:
67 static QObject *registerSettingsModule(QQmlEngine *engine, QJSEngine *jsEngine);
68
69 explicit VirtualKeyboardSettings(QQmlEngine *engine);
70
71 QString style() const;
72
73 QUrl layoutPath() const;
74 void setLayoutPath(const QUrl &layoutPath);
75
76 QString styleName() const;
77 void setStyleName(const QString &styleName);
78
79 QString locale() const;
80 void setLocale(const QString &locale);
81
82 QStringList availableLocales() const;
83
84 void setActiveLocales(const QStringList &activeLocales);
85 QStringList activeLocales() const;
86
87 WordCandidateListSettings *wordCandidateList() const;
88
89 bool fullScreenMode() const;
90 void setFullScreenMode(bool fullScreenMode);
91
92signals:
93 void styleChanged();
94 void styleNameChanged();
95 void localeChanged();
96 void availableLocalesChanged();
97 void activeLocalesChanged();
98 void layoutPathChanged();
99 void fullScreenModeChanged();
100
101private:
102 void resetStyle();
103 void resetLayoutPath();
104};
105
106class QVIRTUALKEYBOARD_EXPORT WordCandidateListSettings : public QObject
107{
108 Q_OBJECT
109 Q_PROPERTY(int autoHideDelay READ autoHideDelay WRITE setAutoHideDelay NOTIFY autoHideDelayChanged)
110 Q_PROPERTY(bool alwaysVisible READ alwaysVisible WRITE setAlwaysVisible NOTIFY alwaysVisibleChanged)
111 Q_PROPERTY(bool autoCommitWord READ autoCommitWord WRITE setAutoCommitWord NOTIFY autoCommitWordChanged)
112
113 explicit WordCandidateListSettings(QObject *parent = nullptr);
114 friend class VirtualKeyboardSettingsPrivate;
115
116public:
117 int autoHideDelay() const;
118 void setAutoHideDelay(int autoHideDelay);
119
120 bool alwaysVisible() const;
121 void setAlwaysVisible(bool alwaysVisible);
122
123 bool autoCommitWord() const;
124 void setAutoCommitWord(bool autoCommitWord);
125
126signals:
127 void autoHideDelayChanged();
128 void alwaysVisibleChanged();
129 void autoCommitWordChanged();
130};
131
132} // namespace QtVirtualKeyboard
133QT_END_NAMESPACE
134
135#endif // VIRTUALKEYBOARDSETTINGS_H
136

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