aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMitch Curtis <mitch.curtis@qt.io>2017-05-08 10:23:38 +0200
committerMitch Curtis <mitch.curtis@qt.io>2017-05-09 06:50:51 +0000
commitc03d7f4063f905f5b33cd3fec38f4eb816c15125 (patch)
tree65f01db20fa589cec0f2e247e27149ca9698c42a
parenta230f0eac4eb743a6ad502e3d2d939a2c7731dcd (diff)
Doc: explain how the keyboard is shown in different integration methods
Change-Id: I12400fab4eaef25fcfff5245d61c184958df506e Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi> Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
-rw-r--r--src/virtualkeyboard/doc/src/deployment-guide.qdoc11
1 files changed, 8 insertions, 3 deletions
diff --git a/src/virtualkeyboard/doc/src/deployment-guide.qdoc b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
index 516c00a3..c3729d84 100644
--- a/src/virtualkeyboard/doc/src/deployment-guide.qdoc
+++ b/src/virtualkeyboard/doc/src/deployment-guide.qdoc
@@ -75,17 +75,22 @@ for using the plugin:
\li \c Desktop: Qt Virtual Keyboard is integrated with Qt 5 and requires no
changes to existing applications. The Qt Virtual Keyboard input method
is available to all of the Qt 5 applications in the system.
+
+ In this integration method, the keyboard is shown in a dedicated
+ top-level window.
\li \c Application: Qt Virtual Keyboard is integrated with Qt 5, but
requires changes to particular applications using Qt Virtual Keyboard.
This method is mandatory in a Boot2Qt environment, but can be used in
desktop applications too.
+
+ In this integration method, the keyboard is shown in the same Qt Quick
+ scene as the application.
\endlist
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.
-This happens by adding the \c CONFIG+=disable-desktop to the \c qmake
-command line.
+integration method and use the application integration method instead,
+by adding \c CONFIG+=disable-desktop to the \c qmake command line.
\note The desktop integration method is not currently available in Boot2Qt
environments.