aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJarkko Koivikko <jarkko.koivikko@code-q.fi>2022-03-01 10:06:27 +0200
committerJarkko Koivikko <jarkko.koivikko@code-q.fi>2022-04-25 15:20:57 +0300
commitf90eb98e6c51f3b073e11c6e9f71cc6c64bf60a2 (patch)
treed57b48c156f603a350f636d17676331495bcbd6a
parent7962eee50b83a58dcbbfd6dc94fc0a1bec87df01 (diff)
Update documentation
Task-number: QTBUG-100783 Change-Id: If48efba10aa9cfd856e54b0a8154c1a78389d5a9 Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> Reviewed-by: Nicholas Bennett <nicholas.bennett@qt.io>
-rw-r--r--src/components/BackspaceKey.qml6
-rw-r--r--src/components/BaseKey.qml28
-rw-r--r--src/components/ChangeLanguageKey.qml6
-rw-r--r--src/components/EnterKey.qml6
-rw-r--r--src/components/FillerKey.qml6
-rw-r--r--src/components/FlickKey.qml6
-rw-r--r--src/components/HandwritingModeKey.qml6
-rw-r--r--src/components/HideKeyboardKey.qml6
-rw-r--r--src/components/InputModeKey.qml6
-rw-r--r--src/components/Key.qml6
-rw-r--r--src/components/KeyboardColumn.qml5
-rw-r--r--src/components/KeyboardLayout.qml5
-rw-r--r--src/components/KeyboardLayoutLoader.qml5
-rw-r--r--src/components/KeyboardRow.qml5
-rw-r--r--src/components/ModeKey.qml6
-rw-r--r--src/components/NumberKey.qml6
-rw-r--r--src/components/ShiftKey.qml6
-rw-r--r--src/components/SpaceKey.qml6
-rw-r--r--src/components/SymbolModeKey.qml6
-rw-r--r--src/components/TraceInputArea.qml5
-rw-r--r--src/components/TraceInputKey.qml6
-rw-r--r--src/settings/qquickvirtualkeyboardsettings.cpp2
-rw-r--r--src/styles/KeyIcon.qml1
-rw-r--r--src/styles/KeyPanel.qml1
-rw-r--r--src/styles/KeyboardStyle.qml1
-rw-r--r--src/styles/SelectionListItem.qml1
-rw-r--r--src/styles/TraceCanvas.qml1
-rw-r--r--src/styles/TraceInputKeyPanel.qml1
-rw-r--r--src/styles/qtquickvirtualkeyboardstylesplugin.cpp2
-rw-r--r--src/virtualkeyboard/HandwritingInputPanel.qml1
-rw-r--r--src/virtualkeyboard/InputPanel.qml1
-rw-r--r--src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf45
-rw-r--r--src/virtualkeyboard/doc/src/build.qdoc162
-rw-r--r--src/virtualkeyboard/doc/src/deployment-guide.qdoc65
-rw-r--r--src/virtualkeyboard/doc/src/includes/build.qdocinc7
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-components.qdoc41
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc76
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-namespace.qdoc76
-rw-r--r--src/virtualkeyboard/doc/src/technical-guide.qdoc182
-rw-r--r--src/virtualkeyboard/enterkeyaction.cpp1
-rw-r--r--src/virtualkeyboard/inputmethod.cpp2
-rw-r--r--src/virtualkeyboard/qt_cmdline.cmake2
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp1
-rw-r--r--src/virtualkeyboard/qvirtualkeyboarddictionary.cpp1
-rw-r--r--src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp1
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp3
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardinputengine.cpp3
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardobserver.cpp3
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp3
-rw-r--r--src/virtualkeyboard/qvirtualkeyboardtrace.cpp3
-rw-r--r--src/virtualkeyboard/shifthandler.cpp2
-rw-r--r--src/virtualkeyboard/virtualkeyboard.cpp1
52 files changed, 432 insertions, 403 deletions
diff --git a/src/components/BackspaceKey.qml b/src/components/BackspaceKey.qml
index 998e9181..f9dcd7aa 100644
--- a/src/components/BackspaceKey.qml
+++ b/src/components/BackspaceKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype BackspaceKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Backspace key for keyboard layouts.
diff --git a/src/components/BaseKey.qml b/src/components/BaseKey.qml
index af2adee2..d7a61b9e 100644
--- a/src/components/BaseKey.qml
+++ b/src/components/BaseKey.qml
@@ -33,8 +33,9 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype BaseKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits Item
\brief Common parent for all key types.
@@ -50,25 +51,10 @@ Item {
/*! \since QtQuick.VirtualKeyboard 6.1
- Type of the key.
-
- \list
- \li \c QtVirtualKeyboard.BaseKey
- \li \c QtVirtualKeyboard.BackspaceKey
- \li \c QtVirtualKeyboard.ChangeLanguageKey
- \li \c QtVirtualKeyboard.EnterKey
- \li \c QtVirtualKeyboard.FillerKey
- \li \c QtVirtualKeyboard.HandwritingModeKey
- \li \c QtVirtualKeyboard.HideKeyboardKey
- \li \c QtVirtualKeyboard.InputModeKey
- \li \c QtVirtualKeyboard.Key
- \li \c QtVirtualKeyboard.ModeKey
- \li \c QtVirtualKeyboard.NumberKey
- \li \c QtVirtualKeyboard.ShiftKey
- \li \c QtVirtualKeyboard.SpaceKey
- \li \c QtVirtualKeyboard.SymbolModeKey
- \li \c QtVirtualKeyboard.FlickKey
- \endlist
+ \l Key type for the specialized key. Possible values are defined by the
+ {QtVirtualKeyboard::KeyType}{key type enumeration}.
+
+ For example, \l SpaceKey sets this value to \e QtVirtualKeyboard.SpaceKey.
*/
property int keyType: QtVirtualKeyboard.BaseKey
diff --git a/src/components/ChangeLanguageKey.qml b/src/components/ChangeLanguageKey.qml
index 0d3ec969..2bae1bd2 100644
--- a/src/components/ChangeLanguageKey.qml
+++ b/src/components/ChangeLanguageKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype ChangeLanguageKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Change language key for keyboard layouts.
diff --git a/src/components/EnterKey.qml b/src/components/EnterKey.qml
index f3ade36e..73f00fad 100644
--- a/src/components/EnterKey.qml
+++ b/src/components/EnterKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype EnterKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Enter key for keyboard layouts.
diff --git a/src/components/FillerKey.qml b/src/components/FillerKey.qml
index a6c2a402..3f6f4d9f 100644
--- a/src/components/FillerKey.qml
+++ b/src/components/FillerKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype FillerKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Filler key for keyboard layouts.
diff --git a/src/components/FlickKey.qml b/src/components/FlickKey.qml
index 48108f00..11ad2ce2 100644
--- a/src/components/FlickKey.qml
+++ b/src/components/FlickKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype FlickKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\since QtQuick.VirtualKeyboard 6.1
diff --git a/src/components/HandwritingModeKey.qml b/src/components/HandwritingModeKey.qml
index 946b9502..ea6debeb 100644
--- a/src/components/HandwritingModeKey.qml
+++ b/src/components/HandwritingModeKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype HandwritingModeKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/components/HideKeyboardKey.qml b/src/components/HideKeyboardKey.qml
index 504fbc3a..48ce9b94 100644
--- a/src/components/HideKeyboardKey.qml
+++ b/src/components/HideKeyboardKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype HideKeyboardKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Hide keyboard key for keyboard layouts.
diff --git a/src/components/InputModeKey.qml b/src/components/InputModeKey.qml
index 142c8866..de67cb32 100644
--- a/src/components/InputModeKey.qml
+++ b/src/components/InputModeKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype InputModeKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\since QtQuick.VirtualKeyboard 2.3
diff --git a/src/components/Key.qml b/src/components/Key.qml
index a1666f3a..4f08d4f6 100644
--- a/src/components/Key.qml
+++ b/src/components/Key.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype Key
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Regular character key for keyboard layouts.
diff --git a/src/components/KeyboardColumn.qml b/src/components/KeyboardColumn.qml
index 15c2e315..40b463a0 100644
--- a/src/components/KeyboardColumn.qml
+++ b/src/components/KeyboardColumn.qml
@@ -32,8 +32,9 @@ import QtQuick.Layouts
/*!
\qmltype KeyboardColumn
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits ColumnLayout
\brief Keyboard column for keyboard layouts.
diff --git a/src/components/KeyboardLayout.qml b/src/components/KeyboardLayout.qml
index 14e5e8eb..25b8ff47 100644
--- a/src/components/KeyboardLayout.qml
+++ b/src/components/KeyboardLayout.qml
@@ -33,8 +33,9 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype KeyboardLayout
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits ColumnLayout
\brief Keyboard layout.
diff --git a/src/components/KeyboardLayoutLoader.qml b/src/components/KeyboardLayoutLoader.qml
index f67a72e8..c381cd47 100644
--- a/src/components/KeyboardLayoutLoader.qml
+++ b/src/components/KeyboardLayoutLoader.qml
@@ -32,8 +32,9 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype KeyboardLayoutLoader
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits Loader
\since QtQuick.VirtualKeyboard 1.1
diff --git a/src/components/KeyboardRow.qml b/src/components/KeyboardRow.qml
index d08f8411..b83b45c6 100644
--- a/src/components/KeyboardRow.qml
+++ b/src/components/KeyboardRow.qml
@@ -32,8 +32,9 @@ import QtQuick.Layouts
/*!
\qmltype KeyboardRow
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits RowLayout
\brief Keyboard row for keyboard layouts.
diff --git a/src/components/ModeKey.qml b/src/components/ModeKey.qml
index 165d0f95..b746170b 100644
--- a/src/components/ModeKey.qml
+++ b/src/components/ModeKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype ModeKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/components/NumberKey.qml b/src/components/NumberKey.qml
index 61df72aa..995b664c 100644
--- a/src/components/NumberKey.qml
+++ b/src/components/NumberKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype NumberKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\brief Specialized number key for keyboard layouts.
diff --git a/src/components/ShiftKey.qml b/src/components/ShiftKey.qml
index 1b256c66..d06a5910 100644
--- a/src/components/ShiftKey.qml
+++ b/src/components/ShiftKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype ShiftKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits BaseKey
\brief Shift key for keyboard layouts.
diff --git a/src/components/SpaceKey.qml b/src/components/SpaceKey.qml
index 0a06ad29..a3a99ceb 100644
--- a/src/components/SpaceKey.qml
+++ b/src/components/SpaceKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype SpaceKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\brief Space key for keyboard layouts.
diff --git a/src/components/SymbolModeKey.qml b/src/components/SymbolModeKey.qml
index d58402cb..c9089a11 100644
--- a/src/components/SymbolModeKey.qml
+++ b/src/components/SymbolModeKey.qml
@@ -32,8 +32,10 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype SymbolModeKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Key
\brief Symbol mode key for keyboard layouts.
diff --git a/src/components/TraceInputArea.qml b/src/components/TraceInputArea.qml
index cbbfc598..f692503f 100644
--- a/src/components/TraceInputArea.qml
+++ b/src/components/TraceInputArea.qml
@@ -33,8 +33,9 @@ import QtQuick.VirtualKeyboard
/*!
\qmltype TraceInputArea
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
\inherits MultiPointTouchArea
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/components/TraceInputKey.qml b/src/components/TraceInputKey.qml
index a12a0a20..9ee9dce8 100644
--- a/src/components/TraceInputKey.qml
+++ b/src/components/TraceInputKey.qml
@@ -32,8 +32,10 @@ import QtQuick.Layouts
/*!
\qmltype TraceInputKey
- \inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \inqmlmodule QtQuick.VirtualKeyboard.Components
+ \ingroup qmlclass
+ \ingroup qtvirtualkeyboard-components-qml
+ \ingroup qtvirtualkeyboard-key-types
\inherits Item
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/settings/qquickvirtualkeyboardsettings.cpp b/src/settings/qquickvirtualkeyboardsettings.cpp
index 7357c2ab..c0e5595c 100644
--- a/src/settings/qquickvirtualkeyboardsettings.cpp
+++ b/src/settings/qquickvirtualkeyboardsettings.cpp
@@ -117,7 +117,7 @@ public:
The QML types can be imported into your application using the following
import statements in your .qml file:
- \qml \QtMinorVersion
+ \qml
import QtQuick.VirtualKeyboard.Settings
\endqml
*/
diff --git a/src/styles/KeyIcon.qml b/src/styles/KeyIcon.qml
index a5e77131..095103be 100644
--- a/src/styles/KeyIcon.qml
+++ b/src/styles/KeyIcon.qml
@@ -33,6 +33,7 @@ import QtQuick
\qmltype KeyIcon
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief Key icon with adjustable color.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
The KeyIcon item displays an icon with adjustable color.
diff --git a/src/styles/KeyPanel.qml b/src/styles/KeyPanel.qml
index 0e2ca2bb..12bad78e 100644
--- a/src/styles/KeyPanel.qml
+++ b/src/styles/KeyPanel.qml
@@ -33,6 +33,7 @@ import QtQuick
\qmltype KeyPanel
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief A base type of the styled keys.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
All the key delegates provided by the style should be based on this type.
diff --git a/src/styles/KeyboardStyle.qml b/src/styles/KeyboardStyle.qml
index 7943f014..68034e25 100644
--- a/src/styles/KeyboardStyle.qml
+++ b/src/styles/KeyboardStyle.qml
@@ -33,6 +33,7 @@ import QtQuick
\qmltype KeyboardStyle
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief Provides a styling interface for the Virtual Keyboard.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
The style type provides the style definitions that are used by
diff --git a/src/styles/SelectionListItem.qml b/src/styles/SelectionListItem.qml
index d1a40758..1a71cd8d 100644
--- a/src/styles/SelectionListItem.qml
+++ b/src/styles/SelectionListItem.qml
@@ -33,6 +33,7 @@ import QtQuick
\qmltype SelectionListItem
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief A base type for selection list item delegates.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
The SelectionListItem enables mouse handling for the selection list item
diff --git a/src/styles/TraceCanvas.qml b/src/styles/TraceCanvas.qml
index 64de2c8b..566ca58c 100644
--- a/src/styles/TraceCanvas.qml
+++ b/src/styles/TraceCanvas.qml
@@ -35,6 +35,7 @@ import QtQuick.VirtualKeyboard
\qmltype TraceCanvas
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief A specialized Canvas type for rendering Trace objects.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
\inherits Canvas
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/styles/TraceInputKeyPanel.qml b/src/styles/TraceInputKeyPanel.qml
index 5a53b42f..ba439c5b 100644
--- a/src/styles/TraceInputKeyPanel.qml
+++ b/src/styles/TraceInputKeyPanel.qml
@@ -33,6 +33,7 @@ import QtQuick
\qmltype TraceInputKeyPanel
\inqmlmodule QtQuick.VirtualKeyboard.Styles
\brief A base type of the trace input key.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-styles-qml
\since QtQuick.VirtualKeyboard 2.0
diff --git a/src/styles/qtquickvirtualkeyboardstylesplugin.cpp b/src/styles/qtquickvirtualkeyboardstylesplugin.cpp
index d6f4350c..aef4e6a1 100644
--- a/src/styles/qtquickvirtualkeyboardstylesplugin.cpp
+++ b/src/styles/qtquickvirtualkeyboardstylesplugin.cpp
@@ -48,7 +48,7 @@ Q_GHS_KEEP_REFERENCE(qml_register_types_QtQuick_VirtualKeyboard_Styles);
The QML types can be imported into your application using the following
import statements in your .qml file:
- \qml \QtMinorVersion
+ \qml
import QtQuick.VirtualKeyboard.Styles
\endqml
*/
diff --git a/src/virtualkeyboard/HandwritingInputPanel.qml b/src/virtualkeyboard/HandwritingInputPanel.qml
index 92f97fcc..ec3c54e6 100644
--- a/src/virtualkeyboard/HandwritingInputPanel.qml
+++ b/src/virtualkeyboard/HandwritingInputPanel.qml
@@ -40,6 +40,7 @@ import QtQuick.VirtualKeyboard.Components
\since QtQuick.VirtualKeyboard 2.0
\brief Provides a handwriting panel add-on for the virtual keyboard UI.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-qml
The HandwritingInputPanel is an add-on component for the InputPanel, which
diff --git a/src/virtualkeyboard/InputPanel.qml b/src/virtualkeyboard/InputPanel.qml
index 65be0745..67e480a1 100644
--- a/src/virtualkeyboard/InputPanel.qml
+++ b/src/virtualkeyboard/InputPanel.qml
@@ -38,6 +38,7 @@ import QtQuick.VirtualKeyboard.Components
\inqmlmodule QtQuick.VirtualKeyboard
\brief Provides the virtual keyboard UI.
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-qml
The keyboard size is automatically calculated from the available
diff --git a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
index b13391f6..2da552ea 100644
--- a/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
+++ b/src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
@@ -1,14 +1,13 @@
include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
include($QT_INSTALL_DOCS/config/exampleurl-qtvirtualkeyboard.qdocconf)
-project = QtVirtualKeyboard
+project = QtVirtualKeyboardDoc
description = Qt Virtual Keyboard
version = $QT_VERSION
buildversion = Qt Virtual Keyboard | Commercial or GPLv3
-headerdirs += ..
-sourcedirs += .. ../../styles/
-excludedirs += ../content/layouts
+headerdirs += .. ../../components/ ../../styles/ ../../settings/
+sourcedirs += .. ../../components/ ../../styles/ ../../settings/
# Specify the install path under QT_INSTALL_EXAMPLES
exampledirs += ../../../examples/virtualkeyboard \
@@ -27,30 +26,30 @@ imagedirs += images
depends += qtdoc qtcore qtgui qtwidgets qtwaylandcompositor qtqml qtquick qtquickcontrols qtcmake qmake
-qhp.projects = QtVirtualKeyboard
+qhp.projects = QtVirtualKeyboardDoc
-qhp.QtVirtualKeyboard.file = qtvirtualkeyboard.qhp
-qhp.QtVirtualKeyboard.namespace = org.qt-project.qtvirtualkeyboard.$QT_VERSION_TAG
-qhp.QtVirtualKeyboard.virtualFolder = qtvirtualkeyboard
-qhp.QtVirtualKeyboard.indexTitle = Qt Virtual Keyboard
-qhp.QtVirtualKeyboard.indexRoot =
+qhp.QtVirtualKeyboardDoc.file = qtvirtualkeyboard.qhp
+qhp.QtVirtualKeyboardDoc.namespace = org.qt-project.qtvirtualkeyboard.$QT_VERSION_TAG
+qhp.QtVirtualKeyboardDoc.virtualFolder = qtvirtualkeyboard
+qhp.QtVirtualKeyboardDoc.indexTitle = Qt Virtual Keyboard
+qhp.QtVirtualKeyboardDoc.indexRoot =
-qhp.QtVirtualKeyboard.subprojects = classes qmltypes examples
+qhp.QtVirtualKeyboardDoc.subprojects = classes qmltypes examples
-qhp.QtVirtualKeyboard.subprojects.classes.title = C++ Classes
-qhp.QtVirtualKeyboard.subprojects.classes.indexTitle = Qt Virtual Keyboard C++ Classes
-qhp.QtVirtualKeyboard.subprojects.classes.selectors = class doc:headerfile
-qhp.QtVirtualKeyboard.subprojects.classes.sortPages = true
+qhp.QtVirtualKeyboardDoc.subprojects.classes.title = C++ Classes
+qhp.QtVirtualKeyboardDoc.subprojects.classes.indexTitle = Qt Virtual Keyboard C++ Classes
+qhp.QtVirtualKeyboardDoc.subprojects.classes.selectors = class doc:headerfile
+qhp.QtVirtualKeyboardDoc.subprojects.classes.sortPages = true
-qhp.QtVirtualKeyboard.subprojects.qmltypes.title = QML Types
-qhp.QtVirtualKeyboard.subprojects.qmltypes.indexTitle = Qt Virtual Keyboard QML Types
-qhp.QtVirtualKeyboard.subprojects.qmltypes.selectors = qmlclass
-qhp.QtVirtualKeyboard.subprojects.qmltypes.sortPages = true
+qhp.QtVirtualKeyboardDoc.subprojects.qmltypes.title = QML Types
+qhp.QtVirtualKeyboardDoc.subprojects.qmltypes.indexTitle = Qt Virtual Keyboard QML Types
+qhp.QtVirtualKeyboardDoc.subprojects.qmltypes.selectors = qmlclass
+qhp.QtVirtualKeyboardDoc.subprojects.qmltypes.sortPages = true
-qhp.QtVirtualKeyboard.subprojects.examples.title = Examples
-qhp.QtVirtualKeyboard.subprojects.examples.indexTitle = Qt Virtual Keyboard Examples
-qhp.QtVirtualKeyboard.subprojects.examples.selectors = doc:example
-qhp.QtVirtualKeyboard.subprojects.examples.sortPages = true
+qhp.QtVirtualKeyboardDoc.subprojects.examples.title = Examples
+qhp.QtVirtualKeyboardDoc.subprojects.examples.indexTitle = Qt Virtual Keyboard Examples
+qhp.QtVirtualKeyboardDoc.subprojects.examples.selectors = doc:example
+qhp.QtVirtualKeyboardDoc.subprojects.examples.sortPages = true
navigation.landingpage = "Qt Virtual Keyboard"
navigation.qmltypespage = "Qt Virtual Keyboard QML Types"
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc
index a765ba47..e8b6580a 100644
--- a/src/virtualkeyboard/doc/src/build.qdoc
+++ b/src/virtualkeyboard/doc/src/build.qdoc
@@ -38,52 +38,37 @@ This document describes how to build the Qt Virtual Keyboard plugin.
The project is split into the following subprojects:
\table
\row
- \li \e examples/virtualkeyboard/basic/basic.pro
+ \li \e examples/virtualkeyboard/basic
\li Qt Virtual Keyboard Demo application
\row
- \li \e src/virtualkeyboard/import/
- \li Qt Virtual Keyboard QML plugin (QtQuick.VirtualKeyboard)
+ \li \e src/components/
+ \li Qt Virtual Keyboard Components QML plugin (QtQuick.VirtualKeyboard.Components)
\row
- \li \e src/virtualkeyboard/plugin/
+ \li \e src/plugin/
\li Qt Virtual Keyboard platform input context plugin. This plugin
- provides the QPlatformInputContext interface for the Qt and is
- also responsible for loading the Virtual Keyboard Plugins
- (QtQuick.VirtualKeyboard.Plugins).
+ provides the QPlatformInputContext interface and works as a
+ layer between QML input context and platform.
\row
- \li \e src/virtualkeyboard/plugins/
- \li A directory containing Qt Virtual Keyboard plugins, such as the Hunspell plugin
+ \li \e src/plugins/
+ \li A directory containing Qt Virtual Keyboard plugins (QtQuick.VirtualKeyboard.Plugins),
+ which implement complex input methods, such as the \e HunspellInputMethod.
+ Build time configuration specifies which plugins are built and loaded at runtime.
\row
- \li \e src/virtualkeyboard/settings/
- \li Qt Virtual Keyboard Settings QML plugin (QtQuick.VirtualKeyboard.Settings)
+ \li \e src/settings/
+ \li Qt Virtual Keyboard Settings QML plugin (QtQuick.VirtualKeyboard.Settings).
+ This plugin provides application-configurable settings for the virtual keyboard.
\row
- \li \e src/virtualkeyboard/styles/styles.pro
- \li Qt Virtual Keyboard Styles QML plugin (QtQuick.VirtualKeyboard.Styles)
+ \li \e src/styles/
+ \li Qt Virtual Keyboard Styles QML plugin (QtQuick.VirtualKeyboard.Styles).
\row
- \li \e src/virtualkeyboard/virtualkeyboard.pro
- \li Qt Virtual Keyboard module, QML components and layouts
+ \li \e src/virtualkeyboard/
+ \li Qt Virtual Keyboard module and QML plugin.
\endtable
-The input methods are implemented either in C++ or QML.
-Qt Virtual Keyboard provides implementations of \e PlainInputMethod,
-\e MultitapInputMethod and \e HunspellInputMethod.
-The \e MultitapInputMethod is implemented in QML while the others are implemented
-in C++.
-
-\section1 Build Instructions
-
-The Qt Virtual Keyboard can be built for Linux Desktop/X11, Windows Desktop
-or Boot2Qt targets.
-The target is automatically detected by QMAKE and requires no special
-configuration parameters.
-
-Qt Creator is the preferred build environment for Qt Virtual Keyboard as you
-can then leverage the shadow build functionality and rapidly switch between
-build targets.
-
\section2 Configuration Options
The table below contains the top-level options for configuring the virtual
-keyboard features.
+keyboard features. These options are passed to the \e configure tool.
\table
\header
@@ -166,25 +151,16 @@ keyboard features.
\note In this scenario, the \c QT_VIRTUALKEYBOARD_LAYOUT_PATH environment
variable should be set to the file system directory containing the custom
keyboard layouts before running the application.
-\endtable
-
-These options can be passed to configure when doing a full build of Qt.
-Alternatively, when building only the Qt Virtual Keyboard, you can configure
-the keyboard using the following command (where SRCDIR points to the source
-directory of QtVirtualKeyboard):
-
-\badcode
-qmake $SRCDIR -- [options]
-\endcode
-
-\table
\row
- \li \e disable-hunspell
- \li \e n/a
- \li Disables Hunspell integration
- \li Hunspell integration is enabled if the Hunspell library is available on the
- system, or if it is built using the local project file. Integration can be
- disabled using this option.
+ \li \e -vkb-hunspell
+ \li \e [no|3rdparty|system]
+ \li Choose Hunspell integration
+ \li Forces the Hunspell integration method to the specified option. The \e 3rdparty option
+ selects the local build of the Hunspell source code using project files in the
+ virtual keyboard repo. This option requires that the Hunspell git repository has
+ been cloned into \e src/plugins/hunspell/3rdparty/hunspell directory. The \e system
+ option selects the system package via \e pkg-config. The \e no option disables the
+ Hunspell plugin.
\row
\li \e -vkb-no-bundle-pinyin
\li \e n/a
@@ -198,34 +174,11 @@ qmake $SRCDIR -- [options]
\li This option excludes tcime resources from the plugin binary. This option may be
used to reduce the plugin binary size.
\row
- \li \e pinyin
- \li \e lang-zh_CN
- \li Enables the Pinyin input method for Simplified Chinese.
- \li This option activates the Pinyin input method for the Simplified Chinese
- language.
-
- \include build.qdocinc input-method-language-option-note
-\row
- \li \e tcime
- \li \e lang-zh_TW
- \li Enables the both Cangjie and Zhuyin input methods for Traditional Chinese.
- \li This option activates the both Cangjie and Zhuyin input methods for the
- Traditional Chinese language.
-
- \include build.qdocinc input-method-language-option-note
-\row
- \li \e openwnn
- \li \e lang-ja_JP
- \li Enables the OpenWnn input method for Japanese.
- \li This option activates the OpenWnn input method for the Japanese language.
-
- \include build.qdocinc input-method-language-option-note
-\row
\li \e -vkb-cerence-sdk
\li \e path/to/cerence/sdk
\li Configures the Cerence SDK location and enables the Cerence Handwriting and XT9 integrations.
- \li The Cerence SDK (zip) must be unpacked using the \e src/virtualkeyboard/plugins/cerence/unpack.py
- script. By default, the SDK is unpacked to \e src/virtualkeyboard/plugins/cerence/sdk, where
+ \li The Cerence SDK zip file must be unpacked using the \e src/plugins/cerence/unpack.py
+ script. By default, the SDK is unpacked to \e src/plugins/cerence/sdk, where
the build scripts can pick it up automatically. However, by using the second parameter to the unpack.py
script, it is possible to use different location for the SDK. In that case, the location must be
passed to the build script using the -vkb-cerence-sdk command line parameter.
@@ -263,26 +216,18 @@ qmake $SRCDIR -- [options]
command line parameter.
\endtable
-\section2 Building Documentation
-
-\table
-\row
- \li \e {make docs}
- \li Generates documentation
-\endtable
-
\section2 Hunspell Integration
By default, \e HunspellInputMethod will not be available unless the Hunspell
library and development headers are found. For Linux/X11 targets, the Hunspell
library can be provided by installing the libhunspell-dev package.
-Alternatively, the Hunspell sources can be extracted into the
+Alternatively, the Hunspell git repository can be cloned into the
\e src/plugins/hunspell/3rdparty/hunspell directory. The sources are automatically
detected by the qmake and the project will be configured to use the local Hunspell.
If Hunspell sources are used, then the dictionary files must also be
copied into the \e src/plugins/hunspell/3rdparty/hunspell/data directory.
-An example of how the directory structure should look after copying in the
+An example of how the directory structure should look after setting up the
Hunspell sources and dictionary files is listed below:
\badcode
@@ -291,12 +236,8 @@ Hunspell sources and dictionary files is listed below:
├── data
│ ├── en_GB.aff
│ └── en_GB.dic
- ├── hunspell.pro
- └── src
- └── hunspell
- ├── affentry.cxx
- ├── affentry.hxx
- (etc.)
+ ├── hunspell <-- Hunspell git repository
+ └── CMakeLists.txt
\endcode
\section2 Cerence Handwriting Integration
@@ -609,41 +550,4 @@ The virtual keyboard can be built and linked statically against the application.
This implies that Qt is also built statically (using the -static option in the
configure command line).
-Static builds of the virtual keyboard are enabled by adding \c CONFIG+=static to
-the qmake command line and then rebuilding.
-
-Some third party modules used by the virtual keyboard are always built as shared
-libraries (e.g. Hunspell).
-
-\section3 Using the static plugin
-
-The following section should be added to the application project file that uses the
-statically built virtual keyboard.
-
-\code
-static {
- QTPLUGIN += qtvirtualkeyboardplugin
- QT += svg
-}
-\endcode
-
-\c QTPLUGIN causes qmake to pull linker dependencies for the virtual keyboard
-plugin. The SVG module is required as an extra dependency for Qt, since the SVG format is
-required by the default styles.
-
-From here on, using a statically built virtual keyboard is no different from the normal
-case.
-
-\section1 Deployment
-
-\section2 Desktop Targets
-
-Add a Deploy Step that executes the \e {make install} command, then deploy using
-the \e {Deploy All} command.
-
-\section2 Boot2Qt Targets
-
-The installation is done by copying the necessary files to the memory card, or
-by using the adb push command.
-
*/
diff --git a/src/virtualkeyboard/doc/src/deployment-guide.qdoc b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
index 5754f635..ede033d2 100644
--- a/src/virtualkeyboard/doc/src/deployment-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
@@ -47,32 +47,45 @@ locations:
\li Desktop install path
\li Boot2Qt install path
\row
- \li qtvirtualkeyboardplugin
+ \li qtvirtualkeyboardplugin platform input context plugin
\li \c <QT_INSTALL_PLUGINS>/platforminputcontexts
\li \c /system/plugins/platforminputcontexts
\row
- \li qtvirtualkeyboardextensionplugin
- \li \c <QT_INSTALL_PLUGINS>/virtualkeyboard
- \li \c /system/plugins/virtualkeyboard
-\row
- \li qtvirtualkeyboardplugin QML files
+ \li qtvkbplugin QML plugin
\li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard
\li \c /system/qml/QtQuick/VirtualKeyboard
\row
- \li qtvirtualkeyboardstylesplugin
+ \li qtvkbcomponentsplugin QML plugin
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Components
+ \li \c /system/qml/QtQuick/VirtualKeyboard/Components
+\row
+ \li qtvkblayoutsplugin QML plugin
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Layouts
+ \li \c /system/qml/QtQuick/VirtualKeyboard/Layouts
+\row
+ \li qtvkbpluginsplugin QML plugin
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Plugins
+ \li \c /system/qml/QtQuick/VirtualKeyboard/Plugins
+\row
+ \li extension QML plugins
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Plugins/*
+ \li \c /system/qml/QtQuick/VirtualKeyboard/Plugins/*
+\row
+ \li qtvkbsettingsplugin QML plugin
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Settings
+ \li \c /system/qml/QtQuick/VirtualKeyboard/Settings
+\row
+ \li qtvkbstylesplugin QML plugin
\li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Styles
\li \c /system/qml/QtQuick/VirtualKeyboard/Styles
+\row
+ \li Virtual keyboard data
+ \li \c <QT_INSTALL_DATA>/qtvirtualkeyboard
+ \li \c /system/qtvirtualkeyboard
\endtable
\section2 Dependencies
-The Qt Virtual Keyboard plugin \e (qtvirtualkeyboardplugin) has a dependency
-to the \e {libQt\QtMajorVersion}\e{\VirtualKeyboard} library. In addition, the
-plugin depends on Qt Quick. Therefore, a stand-alone application based on
-\l [QtWidgets] {Qt Widgets} must deploy also the
-\e {libQt\QtMajorVersion}\e{Quick} library and its dependencies in order to
-use the virtual keyboard.
-
Read more at \l {Deploying Qt's Libraries}.
\section1 Integration Method
@@ -101,7 +114,7 @@ The integration method is automatically selected by the project files.
However, in desktop environments, it is possible to override the desktop
integration method and use the application integration method instead,
by using the \c QT_VIRTUALKEYBOARD_DESKTOP_DISABLE environment variable,
-or by adding \c CONFIG+=disable-desktop to the \c qmake command line.
+or by adding \c -no-vkb-desktop to the \c configure command line.
\section2 Using Qt Virtual Keyboard with Qt Wayland
@@ -164,8 +177,8 @@ The following example shows how to create an InputPanel and how to
divide the screen area with the application container.
\code
-import QtQuick 2.0
-import QtQuick.VirtualKeyboard 2.1
+import QtQuick
+import QtQuick.VirtualKeyboard
Item {
id: root
@@ -216,8 +229,8 @@ There are several environment variables defined by the module that are listed be
By default, the dictionary is bundled into the plugin's resources.
- To disable resource bundling, add \c CONFIG+=no-bundle-pinyin in the
- plugin's qmake command line. In this scenario, the default location
+ To disable resource bundling, add \e -vkb-no-bundle-pinyin to the
+ Qt configure command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::path(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/pinyin/dict_pinyin.dat}.
@@ -227,8 +240,8 @@ There are several environment variables defined by the module that are listed be
By default, the dictionary is bundled into the plugin's resources.
- To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
- plugin's qmake command line. In this scenario, the default location
+ To disable resource bundling, add \e -vkb-no-bundle-tcime to the
+ Qt configure command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::path(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_cangjie.dat}.
@@ -238,8 +251,8 @@ There are several environment variables defined by the module that are listed be
By default, the dictionary is bundled into the plugin's resources.
- To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
- plugin's qmake command line. In this scenario, the default location
+ To disable resource bundling, add \e -vkb-no-bundle-tcime to the
+ Qt configure command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::path(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_zhuyin.dat}.
@@ -249,8 +262,8 @@ There are several environment variables defined by the module that are listed be
By default, the dictionary is bundled into the plugin's resources.
- To disable resource bundling, add \c CONFIG+=no-bundle-tcime in the
- plugin's qmake command line. In this scenario, the default location
+ To disable resource bundling, add \e -vkb-no-bundle-tcime to the
+ Qt configure command line. In this scenario, the default location
depends on the value of \c {QLibraryInfo::path(QLibraryInfo::DataPath)}.
For example, for Qt libraries built from source,
it could be \c {qtbase/qtvirtualkeyboard/tcime/dict_phrases.dat}.
@@ -288,7 +301,7 @@ There are several environment variables defined by the module that are listed be
\li Specifies the location of the style to use with the virtual keyboard.
This can also be specified in QML by setting \l {VirtualKeyboardSettings::styleName},
- or at build time by using the \l {Advanced Usage}{qmake advanced configuration options}.
+ or at build time by using the \l {Advanced Usage}{Configuration Options}.
\row
\li QT_VIRTUALKEYBOARD_LAYOUT_PATH
\li Specifies the location of the layouts to be used with the virtual keyboard.
diff --git a/src/virtualkeyboard/doc/src/includes/build.qdocinc b/src/virtualkeyboard/doc/src/includes/build.qdocinc
deleted file mode 100644
index 44988ce7..00000000
--- a/src/virtualkeyboard/doc/src/includes/build.qdocinc
+++ /dev/null
@@ -1,7 +0,0 @@
-//! [input-method-language-option-note]
-
-As this option activates a particular language, the \c lang-all option
-will not be enabled if this option is specified. To build all languages,
-use \c CONFIG+=lang-all.
-
-//! [input-method-language-option-note]
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-components.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-components.qdoc
new file mode 100644
index 00000000..ed9a4759
--- /dev/null
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-components.qdoc
@@ -0,0 +1,41 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \qmlmodule QtQuick.VirtualKeyboard.Components
+ \title Qt Quick Virtual Keyboard Components QML Types
+ \ingroup qmlmodules
+ \ingroup qtvirtualkeyboard-components-qml
+ \brief Provides QML types for customizing virtual keyboard layouts.
+
+ The QML types can be imported into your application using the following
+ import statement in your .qml file:
+
+ \qml
+ import QtQuick.VirtualKeyboard.Components
+ \endqml
+*/
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 09bddb95..5fd7ca41 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -87,8 +87,10 @@
\section1 API Reference
\list
- \li \l{Qt Virtual Keyboard QML Types}{QML Types}
- \li \l{Qt Virtual Keyboard C++ Classes}{C++ Classes}
+ \li \l{Qt Virtual Keyboard API for Applications}
+ \li \l{Qt Virtual Keyboard API for Advanced Use Cases}
+ \li \l{Qt Virtual Keyboard QML Types}
+ \li \l{Qt Virtual Keyboard C++ Classes}
\endlist
\section1 Examples
@@ -110,33 +112,75 @@
*/
/*!
-\qmlmodule QtQuick.VirtualKeyboard 2.\QtMinorVersion
-\title Qt Virtual Keyboard QML Types
-\ingroup qmlmodules
-\brief Provides QML types for an input framework and a reference keyboard front
-end.
+ \page qtquick-virtualkeyboard-for-application.html
+ \title Qt Virtual Keyboard API for Applications
+ \brief Provides API for integrating the virtual keyboard into an application.
The QML types can be imported into your application using the following
import statements in your .qml file:
- \qml \QtMinorVersion
- import QtQuick.VirtualKeyboard 2.\1
- import QtQuick.VirtualKeyboard.Styles 2.\1
- import QtQuick.VirtualKeyboard.Settings 2.\1
+ \qml
+ import QtQuick.VirtualKeyboard
+ import QtQuick.VirtualKeyboard.Settings
\endqml
In addition to importing the types, the \c QT_IM_MODULE environment
variable must be set to \c qtvirtualkeyboard. For more information, see
\l {Loading the Plugin}.
-Styling:
+ \section1 \l {Qt Virtual Keyboard Module QML Types} {Virtual Keyboard}
-\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles
+ QML types
-Settings:
+ \generatelist groupsbymodule qtvirtualkeyboard-qml
-\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Settings
+ C++ types
-Input framework and keys:
+ \generatelist groupsbymodule qtvirtualkeyboard-cpp-for-apps
+ \section1 \l {Qt Quick Virtual Keyboard Settings QML Types} {Virtual Keyboard Settings}
+
+ QML types
+
+ \generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Settings
+*/
+
+/*!
+ \page qtquick-virtualkeyboard-for-advanced-use-cases.html
+ \title Qt Virtual Keyboard API for Advanced Use Cases
+ \brief Provides API for extending or modifying virtual keyboard functionality.
+
+ These QML types fall under the categories of virtual keyboard plugin vendors,
+ style providers, and keyboard layouts. They should not be used by application
+ or middleware.
+
+ \section1 \l {Qt Quick Virtual Keyboard Styles QML Types} {Styles}
+
+ QML types
+
+ \generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles
+
+ \section1 \l {Qt Quick Virtual Keyboard Components QML Types} {Components}
+
+ QML types
+
+ \generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Components
+
+ C++ types
+
+ \generatelist groupsbymodule qtvirtualkeyboard-cpp-for-devs
+*/
+
+/*!
+ \qmlmodule QtQuick.VirtualKeyboard
+ \title Qt Virtual Keyboard Module QML Types
+ \brief Provides QML types for the virtual keyboard.
+*/
+
+/*!
+ \page qtvirtualkeyboard-qmltypes.html
+ \title Qt Virtual Keyboard QML Types
+ \brief QML types for the virtual keyboard.
+
+ \generatelist groupsbymodule qmlclass
*/
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-namespace.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-namespace.qdoc
new file mode 100644
index 00000000..5e5b10d9
--- /dev/null
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-namespace.qdoc
@@ -0,0 +1,76 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+ \namespace QtVirtualKeyboard
+ \inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
+ \keyword Qt Virtual Keyboard Namespace
+*/
+
+/*!
+ \enum QtVirtualKeyboard::KeyType
+
+ \inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
+
+ \brief Key type for the virtual keyboard key.
+
+ \value BaseKey
+ \value BackspaceKey
+ \value ChangeLanguageKey
+ \value EnterKey
+ \value FillerKey
+ \value HandwritingModeKey
+ \value HideKeyboardKey
+ \value InputModeKey
+ \value Key
+ \value ModeKey
+ \value NumberKey
+ \value ShiftKey
+ \value SpaceKey
+ \value SymbolModeKey
+ \value FlickKey
+*/
+
+/*!
+ \enum QtVirtualKeyboard::KeyboardFunction
+
+ \inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
+
+ \brief Specifies a keyboard function to be executed by the virtual keyboard.
+
+ This enumeration is used as an alias for predefined keyboard functions, such
+ as hiding the virtual keyboard. The enumeration is used internally by the
+ virtual keyboard to implement common functionality. The enumeration value is
+ passed to Keyboard.doKeyboardFunction() for execution.
+
+ \value HideInputPanel
+ \value ChangeLanguage
+ \value ToggleHandwritingMode
+*/
diff --git a/src/virtualkeyboard/doc/src/technical-guide.qdoc b/src/virtualkeyboard/doc/src/technical-guide.qdoc
index 5513cd82..3fb80c93 100644
--- a/src/virtualkeyboard/doc/src/technical-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/technical-guide.qdoc
@@ -61,8 +61,6 @@ The input framework provides the following main interfaces:
\li InputMethod: a base type for QML-based input methods. The input method
usually handles key events, but can also handle mouse and touch input
events.
- \li QVirtualKeyboardExtensionPlugin: a plugin interface for virtual keyboard
- extensions that provide additional functionality.
\endlist
\section1 Input Context
@@ -179,28 +177,17 @@ case:
input method.
\endlist
-\section1 Virtual Keyboard Extension Plugin
+\section1 Virtual Keyboard Plugins
-An extension plugin allows third-party providers to enhance the functionality
-of the virtual keyboard without recompiling it. Currently the extension plugin
-can provide keyboard layouts and custom input methods. Creating a plugin for
-Qt Virtual Keyboard is similar to the standard way of creating a Qt plugin:
+The \e src/plugins directory of the virtual keyboard contains the existing plugins
+for the virtual keyboard. These plugins are standard QML modules loaded implicitly
+by the QtQuick.VirtualKeyboard.Plugins QML module.
-\list
- \li \b {Link against the virtualkeyboard library}.
-
- The virtualkeyboard module must be linked against the plugin:
-
- \badcode
- QT += virtualkeyboard
- \endcode
-
- This allows the plugin to access \l QVirtualKeyboardInputContext and other interfaces.
- \li \b {Implement a subclass of QVirtualKeyboardExtensionPlugin.}
-
- The plugin provides the virtual keyboard with the necessary metadata,
- which allows it to sort and load the plugins.
-\endlist
+A plugin may provide keyboard layouts and input methods (usually both). The input method
+used by the virtual keyboard depends on which keyboard layout is in use. The keyboard layout
+may provide an instance of a custom input method by the KeyboardLayout.createInputMethod()
+function. Otherwise, the default input method (DefaultInputMethod) created by the virtual
+keyboard is used.
\section2 Adding Keyboard Layouts
@@ -208,82 +195,29 @@ The plugin can add keyboard layouts for the virtual keyboard by including
the layout files in the Qt resources of the plugin binary.
The virtual keyboard searches for the keyboard layouts (per language) from a specific
-path \e /qt-project.org/imports/QtQuick/VirtualKeyboard/content/layouts/<language_COUNTRY>, so it is essential
-to use this exact path also in the plugin. Qt resource paths can be overlapped, however,
-the plugin cannot override the existing layouts in the virtual keyboard plugin.
-
-If the extension plugin needs to override the built-in keyboard layout, the virtual
-keyboard must be recompiled with only specific languages (e.g. \e CONFIG+=lang-en) or without
-keyboard layouts at (e.g. \e CONFIG+=disable-layouts). Alternatively, if recompiling is not an
-option, it is possible to override the built-in keyboard layouts and have them loaded directly
+path \e /qt-project.org/imports/QtQuick/VirtualKeyboard/Layouts/<language_COUNTRY>, so it is essential
+to use this exact path also in the plugin. Qt resource paths can overlap, meaning that
+the plugin can override existing layouts on the virtual keyboard.
+
+It is also possible to override the built-in keyboard layouts by having them loaded directly
from the file system by using the \e QT_VIRTUALKEYBOARD_LAYOUT_PATH environment variable.
\section2 Adding Input Method
The plugin can register an input method that other keyboard layouts can use by
default (such as \c DefaultInputMethod) or an input method that is used privately
-in the plugin.
-
-The input method must implement \l {QVirtualKeyboardAbstractInputMethod} (C++) or InputMethod (QML)
-interface and the plugin must register it as a QML type in
-{QVirtualKeyboardExtensionPlugin::registerTypes} method.
-
-\section2 Metadata for the Extension Plugin
+in the plugin (by also providing custom keyboard layout, which creates the input
+method).
-Metadata allows the virtual keyboard to inspect the plugin before loading
-the actual library. It also prevents the virtual keyboard from loading
-conflicting extension plugins, for example, two handwriting extensions.
-
-\table
- \row
- \li \c Name
- \li \c Required
- \li This field defines the plugin name. There are several built-in
- plugins available by default:
-
- \list
- \li \c hangul
- \li \c default (Hunspell)
- \li \c handwriting (T9 Write)
- \li \c japanese (OpenWNN)
- \li \c pinyin
- \li \c traditional_chinese
- \endlist
- \row
- \li \c Provider
- \li \c Optional
- \li An informative name of the plugin provider. Used mainly for diagnostics.
- \row
- \li \c InputMethod
- \li \c Optional
- \li This field tells the virtual keyboard the plugin contains an input method.
- When this field is defined, the virtual keyboard will invoke the
- \l {QVirtualKeyboardExtensionPlugin::registerTypes} {interface}
- for registering the QML types.
- Similar to the \c Name, there can be only one provider for each input method.
- \row
- \li \c Version
- \li \c Required
- \li An integer defining the version number of the plugin. If there are two or more
- plugins available of the same \c Name, the one with greatest version number is
- preferred.
-\endtable
-
-The following snippet shows the example handwriting plugin metadata:
-
-\badcode
-{
- "Name": "handwriting",
- "Provider": "Qt Handwriting Extension",
- "InputMethod": "HandwritingInputMethod",
- "Version": 100
-}
-\endcode
+The input method must implement a \l {QVirtualKeyboardAbstractInputMethod} (C++) or InputMethod (QML)
+interface and it must be registered as a QML type (\l {QML_NAMED_ELEMENT}) by the plugin.
\section1 Implementing a Custom Input Method
-The implementation of input methods starts by deciding which interface is used;
-QML or C++. In this example the QML interface is used.
+The implementation of input methods starts by deciding which interface is used,
+QML or C++. In this example the QML interface is used. The same logic and interfaces
+apply with the C++ interface \l {QVirtualKeyboardAbstractInputMethod}. In this case,
+the plugin must be linked to the \e VirtualKeyboard module.
The following example shows the minimum functionality that is required
from an input method:
@@ -399,17 +333,19 @@ function selectionListItemSelected(type, index) {
\section1 Integrating Handwriting Recognition
-Since version 2.0 of the virtual keyboard, input methods can consume
-touch input data from touch screens or other input devices. This allows
-integration of a handwriting recognition engine seamlessly to the virtual
-keyboard, without any changes to the existing keyboard layouts (as
-the virtual keyboard already provides the handwriting keyboard layouts for
-most languages).
+An input method can also use input data from the touch screen or other input devices.
+
+When the input begins, the virtual keyboard calls the input method function
+\l { QVirtualKeyboardAbstractInputMethod::traceBegin } { traceBegin }, which returns a new \l {QVirtualKeyboardTrace} {Trace}
+object to which the input is collected on behalf of the input method. Similarly, when
+the finger or stylus is raised, the event is terminated with the \l { QVirtualKeyboardAbstractInputMethod::traceEnd } { traceEnd } call.
+The input method processes the collected data and produces text using the
+\l {QVirtualKeyboardInputContext} {InputContext} interface.
-Towards an input method, handwriting recognition works on the same principle
-as handling of normal keyboard input, i.e. input data is collected by the
-keyboard layout and transferred by the input engine to the input method for
-processing.
+There are predefined keyboard layouts for handwriting. However, they are not included
+by default, and the handwriting plugin should include them in its own resources. For
+examples of how to do this, see the existing plugins for handwriting from \e MyScript
+or \e Cerence.
\section2 Data Model for Handwriting Input
@@ -465,7 +401,7 @@ the object. This also removes the trace rendered to the screen.
\section1 Keyboard Layouts
-Keyboard layouts are located in the \e src/virtualkeyboard/content/layouts
+Keyboard layouts are located in the \e src/layouts/builtin
directory. Each subdirectory of the layout directory represents a locale.
The locale directory is a string of the form "language_country", where
language is a lowercase, two-letter ISO 639 language code, and country is an
@@ -517,30 +453,16 @@ Otherwise, the key weight is inherited from its parent element.
New keys are added to the keyboard row using the Key type or one of the
specialized key types. Below is the list of all key types:
-\list
- \li \l Key
- \li \l BackspaceKey
- \li \l ChangeLanguageKey
- \li \l EnterKey
- \li \l FillerKey
- \li \l HideKeyboardKey
- \li \l NumberKey
- \li \l ShiftKey
- \li \l SpaceKey
- \li \l SymbolModeKey
- \li \l FlickKey
- \li \l HandwritingModeKey
- \li \l TraceInputKey
-\endlist
+\generatelist groupsbymodule qtvirtualkeyboard-key-types
For example, to add a regular key which sends a key event to the input method:
\code
- import QtQuick 2.0
- import QtQuick.Layouts 1.0
- import QtQuick.VirtualKeyboard 2.1
+ import QtQuick
+ import QtQuick.VirtualKeyboard
+ import QtQuick.VirtualKeyboard.Components
- // file: layouts/en_GB/main.qml
+ // file: en_GB/main.qml
KeyboardLayout {
keyWeight: 160
@@ -569,11 +491,11 @@ The effective value for the key weight will be 160. For the sake of the
example, we add another key which specifies a custom key weight:
\code
- import QtQuick 2.0
- import QtQuick.Layouts 1.0
- import QtQuick.VirtualKeyboard 2.1
+ import QtQuick
+ import QtQuick.VirtualKeyboard
+ import QtQuick.VirtualKeyboard.Components
- // file: layouts/en_GB/main.qml
+ // file: en_GB/main.qml
KeyboardLayout {
keyWeight: 160
@@ -627,11 +549,11 @@ sourceComponent property.
For example:
\code
- import QtQuick 2.0
- import QtQuick.Layouts 1.0
- import QtQuick.VirtualKeyboard 2.1
+ import QtQuick
+ import QtQuick.VirtualKeyboard
+ import QtQuick.VirtualKeyboard.Components
- // file: layouts/en_GB/symbols.qml
+ // file: en_GB/symbols.qml
KeyboardLayoutLoader {
property bool secondPage
@@ -675,7 +597,7 @@ This type of keyboard layout must meet the following requirements:
\li provides an instance of HandwritingInputMethod as the input method.
\endlist
-The handwriting layout may also include ChangeLanguageKey. For this purpose, it is
+The handwriting layout may also include \l ChangeLanguageKey. For this purpose, it is
important to use the \l {ChangeLanguageKey::customLayoutsOnly} {customLayoutsOnly} attribute, which will filter out languages
that do not use handwriting.
@@ -696,8 +618,8 @@ In case the environment variable is not set, or contains an invalid
directory, the virtual keyboard falls back to the default built-in layouts.
To prevent the built-in layouts from being built into the virtual keyboard
-plugin when using custom layouts, add \c disable-layouts to the \c CONFIG qmake variable.
-For more information, see \l {Advanced Usage}{qmake advanced configuration options}.
+plugin when using custom layouts, add \c -no-vkb-layouts option to the \c configure script.
+For more information, see \l {Advanced Usage}{Configuration Options}.
\section1 Keyboard Styles
@@ -731,7 +653,7 @@ which currently includes "default" and "retro".
A good starting point for creating a new style is to use an existing
built-in style as a template and edit it. You can find the built-in
styles from the virtual keyboard sources directory
-src/virtualkeyboard/content/styles. Copy one of the directories containing
+src/styles/builtin. Copy one of the directories containing
a built-in style into the \e Styles directory and rename it to "test".
The directory structure should now be as follows:
diff --git a/src/virtualkeyboard/enterkeyaction.cpp b/src/virtualkeyboard/enterkeyaction.cpp
index 6d9361b1..5d64f4c0 100644
--- a/src/virtualkeyboard/enterkeyaction.cpp
+++ b/src/virtualkeyboard/enterkeyaction.cpp
@@ -36,6 +36,7 @@ namespace QtVirtualKeyboard {
/*!
\qmltype EnterKeyAction
\inqmlmodule QtQuick.VirtualKeyboard
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-qml
\brief Provides attached properties for customizing the enter key.
diff --git a/src/virtualkeyboard/inputmethod.cpp b/src/virtualkeyboard/inputmethod.cpp
index 3abc1b5a..c229db85 100644
--- a/src/virtualkeyboard/inputmethod.cpp
+++ b/src/virtualkeyboard/inputmethod.cpp
@@ -38,7 +38,7 @@ namespace QtVirtualKeyboard {
\qmltype InputMethod
\instantiates QtVirtualKeyboard::InputMethod
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\brief Base type for creating input method in QML.
The InputMethod type lets you create a custom input method
diff --git a/src/virtualkeyboard/qt_cmdline.cmake b/src/virtualkeyboard/qt_cmdline.cmake
index e210ecaf..8ee9f0ee 100644
--- a/src/virtualkeyboard/qt_cmdline.cmake
+++ b/src/virtualkeyboard/qt_cmdline.cmake
@@ -4,8 +4,6 @@ qt_commandline_option(vkb-enable TYPE enableLang)
qt_commandline_option(vkb-disable TYPE disableLang)
qt_commandline_option(vkb-layouts TYPE boolean)
qt_commandline_option(vkb-desktop TYPE boolean)
-qt_commandline_option(vkb-cangjie TYPE boolean VALUE cangjie)
-qt_commandline_option(vkb-zhuyin TYPE boolean VALUE zhuyin)
qt_commandline_option(vkb-hunspell TYPE enum VALUES no 3rdparty system)
qt_commandline_option(vkb-handwriting TYPE optionalString VALUES no myscript-hwr cerence-hwr)
qt_commandline_option(vkb-cerence-sdk TYPE string)
diff --git a/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp b/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp
index 944afb26..05eb76bd 100644
--- a/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardabstractinputmethod.cpp
@@ -36,6 +36,7 @@ QT_BEGIN_NAMESPACE
\class QVirtualKeyboardAbstractInputMethod
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\brief The base class for input methods.
diff --git a/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp b/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp
index e0df0a63..c794a199 100644
--- a/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboarddictionary.cpp
@@ -33,6 +33,7 @@
\class QVirtualKeyboardDictionary
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-apps
\brief An application-defined dictionary for virtual keyboard input methods.
diff --git a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp
index c4676271..f43edef4 100644
--- a/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboarddictionarymanager.cpp
@@ -72,6 +72,7 @@ Q_GLOBAL_STATIC(QVirtualKeyboardDictionaryManagerSingleton, singleton)
\class QVirtualKeyboardDictionaryManager
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-apps
\brief Dictionary management for application-defined dictionaries.
diff --git a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
index 47d3117f..608399c9 100644
--- a/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardinputcontext.cpp
@@ -44,7 +44,7 @@ using namespace QtVirtualKeyboard;
\qmltype InputContext
\instantiates QVirtualKeyboardInputContext
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\brief Provides access to an input context.
The InputContext can be accessed as singleton instance.
@@ -53,6 +53,7 @@ using namespace QtVirtualKeyboard;
/*!
\class QVirtualKeyboardInputContext
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\brief Provides access to an input context.
*/
diff --git a/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp b/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp
index 4f7c2967..e6004ca7 100644
--- a/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardinputengine.cpp
@@ -126,7 +126,7 @@ private:
/*!
\qmltype InputEngine
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\instantiates QVirtualKeyboardInputEngine
\brief Maps the user input to the input methods.
@@ -141,6 +141,7 @@ private:
/*!
\class QVirtualKeyboardInputEngine
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\brief The InputEngine class provides an input engine
that supports C++ and QML integration.
diff --git a/src/virtualkeyboard/qvirtualkeyboardobserver.cpp b/src/virtualkeyboard/qvirtualkeyboardobserver.cpp
index 40340b0e..c2d976f6 100644
--- a/src/virtualkeyboard/qvirtualkeyboardobserver.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardobserver.cpp
@@ -46,13 +46,14 @@ public:
\qmltype KeyboardObserver
\instantiates QVirtualKeyboardObserver
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\brief Acts as a hub for keyboard event notifications.
*/
/*!
\class QVirtualKeyboardObserver
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\brief Acts as a hub for keyboard event notifications.
*/
diff --git a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp
index 90b1e7df..02084c9c 100644
--- a/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardselectionlistmodel.cpp
@@ -60,7 +60,7 @@ public:
\qmltype SelectionListModel
\instantiates QVirtualKeyboardSelectionListModel
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\brief Provides a data model for the selection lists.
The SelectionListModel is a data model for word candidates
@@ -92,6 +92,7 @@ public:
\class QVirtualKeyboardSelectionListModel
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\brief List model for selection lists.
diff --git a/src/virtualkeyboard/qvirtualkeyboardtrace.cpp b/src/virtualkeyboard/qvirtualkeyboardtrace.cpp
index dcddaa64..53578833 100644
--- a/src/virtualkeyboard/qvirtualkeyboardtrace.cpp
+++ b/src/virtualkeyboard/qvirtualkeyboardtrace.cpp
@@ -56,6 +56,7 @@ public:
/*!
\class QVirtualKeyboardTrace
\inmodule QtVirtualKeyboard
+ \ingroup qtvirtualkeyboard-cpp-for-devs
\since QtQuick.VirtualKeyboard 2.0
\brief Trace is a data model for touch input data.
@@ -117,7 +118,7 @@ public:
\qmltype Trace
\instantiates QVirtualKeyboardTrace
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\since QtQuick.VirtualKeyboard 2.0
\brief Trace is a data model for touch input data.
diff --git a/src/virtualkeyboard/shifthandler.cpp b/src/virtualkeyboard/shifthandler.cpp
index 695676ff..72415490 100644
--- a/src/virtualkeyboard/shifthandler.cpp
+++ b/src/virtualkeyboard/shifthandler.cpp
@@ -85,7 +85,7 @@ public:
/*!
\qmltype ShiftHandler
\inqmlmodule QtQuick.VirtualKeyboard
- \ingroup qtvirtualkeyboard-qml
+ \ingroup qtvirtualkeyboard-internal-qml
\instantiates QtVirtualKeyboard::ShiftHandler
\brief Manages the shift state.
*/
diff --git a/src/virtualkeyboard/virtualkeyboard.cpp b/src/virtualkeyboard/virtualkeyboard.cpp
index 5da978fe..87f559d5 100644
--- a/src/virtualkeyboard/virtualkeyboard.cpp
+++ b/src/virtualkeyboard/virtualkeyboard.cpp
@@ -36,6 +36,7 @@ namespace QtVirtualKeyboard {
/*!
\qmltype VirtualKeyboard
\inqmlmodule QtQuick.VirtualKeyboard
+ \ingroup qmlclass
\ingroup qtvirtualkeyboard-qml
\brief Provides attached properties for customizing the virtual keyboard.
\since QtQuick.VirtualKeyboard 6.1