aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--src/virtualkeyboard/content/InputPanel.qml5
-rw-r--r--src/virtualkeyboard/doc/src/build.qdoc17
-rw-r--r--src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc4
3 files changed, 26 insertions, 0 deletions
diff --git a/src/virtualkeyboard/content/InputPanel.qml b/src/virtualkeyboard/content/InputPanel.qml
index 2b6772de..f9d25a02 100644
--- a/src/virtualkeyboard/content/InputPanel.qml
+++ b/src/virtualkeyboard/content/InputPanel.qml
@@ -41,6 +41,11 @@ import QtQuick.VirtualKeyboard 2.1
width; that is, the keyboard maintains the aspect ratio specified by the current
style. Therefore the application should only set the \l {Item::}{width} and \l {Item::}{y}
coordinates of the InputPanel, and not the \l {Item::}{height}.
+
+ As with \l {Qt Virtual Keyboard QML Types}{all other QML types} provided by
+ the module, the \c QT_IM_MODULE environment variable must be set to
+ \c qtvirtualkeyboard before using InputPanel. For more information, see
+ \l {Loading the Plugin}.
*/
Item {
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc
index add2738b..3d9d9eac 100644
--- a/src/virtualkeyboard/doc/src/build.qdoc
+++ b/src/virtualkeyboard/doc/src/build.qdoc
@@ -264,6 +264,23 @@ then the dictionary files must also be copied into the
\e src/virtualkeyboard/3rdparty/hunspell/data directory. Furthermore, if Hunspell
sources are used, \e hunspell.pro will be used for all targets.
+An example of how the directory structure should look after copying in the
+Hunspell sources and dictionary files is listed below:
+
+\badcode
+3rdparty
+└── hunspell
+ ├── data
+ │ ├── en_GB.aff
+ │ └── en_GB.dic
+ ├── hunspell.pro
+ └── src
+ └── hunspell
+ ├── affentry.cxx
+ ├── affentry.hxx
+ (etc.)
+\endcode
+
\section2 Static builds
The virtual keyboard can be built and linked statically against the application.
diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
index 46e8d5eb..91373b23 100644
--- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
+++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc
@@ -139,6 +139,10 @@ end.
import QtQuick.VirtualKeyboard.Settings 2.2
\endcode
+ 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:
\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles