aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2021-11-07 01:08:50 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-11-08 09:16:56 +0000
commit771e80602c96c4be8d807eef1de7825dedfb9e7e (patch)
treeacd0783a378c6d96e3ecda87d3563451fda865ff
parentb721cced8eec425cea1113ffe129a3bb85e3c2b2 (diff)
Doc: Mention plugin dependencies in the deployment guide
As the plugin can be used also in widgets-based application, discuss the deployment of required libraries for such applications. Replace the qmake-specific notation in listed paths to make the guide build-system agnostic, and remove specific mentions of the major Qt version. Fixes: QTBUG-96578 Change-Id: I92f1a67b0cab0cbd046c7d4ab90519a8acd59e8f Reviewed-by: Paul Wicking <paul.wicking@qt.io> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io> (cherry picked from commit eeeb0642e5729ba52c837ec94fbc93800672720d) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/virtualkeyboard/doc/src/deployment-guide.qdoc26
1 files changed, 18 insertions, 8 deletions
diff --git a/src/virtualkeyboard/doc/src/deployment-guide.qdoc b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
index dc2eff92..c132ed0e 100644
--- a/src/virtualkeyboard/doc/src/deployment-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
@@ -34,7 +34,7 @@
\section1 Overview
This document describes how to deploy and use the Qt Virtual Keyboard plugin
-with Qt 5 applications.
+with Qt applications.
\section1 Deployment
@@ -48,31 +48,41 @@ locations:
\li Boot2Qt install path
\row
\li qtvirtualkeyboardplugin
- \li \c $$[QT_INSTALL_PLUGINS]/platforminputcontexts
+ \li \c <QT_INSTALL_PLUGINS>/platforminputcontexts
\li \c /system/plugins/platforminputcontexts
\row
\li qtvirtualkeyboardextensionplugin
- \li \c $$[QT_INSTALL_PLUGINS]/virtualkeyboard
+ \li \c <QT_INSTALL_PLUGINS>/virtualkeyboard
\li \c /system/plugins/virtualkeyboard
\row
\li qtvirtualkeyboardplugin QML files
- \li \c $$[QT_INSTALL_QML]/QtQuick/VirtualKeyboard
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard
\li \c /system/qml/QtQuick/VirtualKeyboard
\row
\li qtvirtualkeyboardstylesplugin
- \li \c $$[QT_INSTALL_QML]/QtQuick/VirtualKeyboard/Styles
+ \li \c <QT_INSTALL_QML>/QtQuick/VirtualKeyboard/Styles
\li \c /system/qml/QtQuick/VirtualKeyboard/Styles
\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
Qt Virtual Keyboard currently supports two alternative integration methods
for using the plugin:
\list
- \li \c Desktop: requires no changes to existing applications.
- The virtual keyboard is available to all of the Qt 5 applications
- in the system.
+ \li \c Desktop: requires no changes to existing applications. The virtual
+ keyboard is available to all Qt applications in the system.
In this integration method, the keyboard is shown in a dedicated
top-level window.