1 | // Copyright (C) 2021 The Qt Company Ltd. |
2 | // SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only |
3 | |
4 | #include <QtVirtualKeyboard/private/virtualkeyboard_p.h> |
5 | #include <QtVirtualKeyboard/private/virtualkeyboardattachedtype_p.h> |
6 | |
7 | QT_BEGIN_NAMESPACE |
8 | namespace QtVirtualKeyboard { |
9 | |
10 | /*! |
11 | \qmltype VirtualKeyboard |
12 | \inqmlmodule QtQuick.VirtualKeyboard |
13 | \ingroup qmlclass |
14 | \ingroup qtvirtualkeyboard-qml |
15 | \brief Provides attached properties for customizing the virtual keyboard. |
16 | \since QtQuick.VirtualKeyboard 6.1 |
17 | |
18 | The VirtualKeyboard type provides attached properties which allow |
19 | customizing the virtual keyboard, such as attaching custom dictionaries. |
20 | |
21 | The VirtualKeyboard must be used directly inside the item |
22 | receiving input focus, e.g. TextInput. |
23 | |
24 | For example: |
25 | \code |
26 | TextInput { |
27 | VirtualKeyboard.dictionaries: ["myDictionary"] |
28 | } |
29 | \endcode |
30 | */ |
31 | |
32 | /*! |
33 | \class QtVirtualKeyboard::VirtualKeyboard |
34 | \internal |
35 | */ |
36 | |
37 | /*! |
38 | \internal |
39 | */ |
40 | VirtualKeyboardAttachedType *VirtualKeyboard::qmlAttachedProperties(QObject *object) |
41 | { |
42 | return new VirtualKeyboardAttachedType(object); |
43 | } |
44 | |
45 | /*! |
46 | \qmlattachedproperty list VirtualKeyboard::dictionaries |
47 | |
48 | Sets active user dictionaries in this context. |
49 | */ |
50 | |
51 | } // namespace QtVirtualKeyboard |
52 | QT_END_NAMESPACE |
53 | |