diff options
| author | Mitch Curtis <mitch.curtis@qt.io> | 2017-01-31 09:44:28 +0100 |
|---|---|---|
| committer | Mitch Curtis <mitch.curtis@qt.io> | 2017-02-01 08:39:07 +0000 |
| commit | 40455c50331757aff9a315b0450be00646b5a03e (patch) | |
| tree | f89650eb7af810ab4df7bcadbd7ad3303953ce01 /src | |
| parent | 0371486a32a0e39cdc9d04f9d1245b214d269e3c (diff) | |
Doc: make QT_IM_MODULE=qtvirtualkeyboard requirement more visible
Task-number: QTBUG-58441
Change-Id: I33881f66b15f282fe866c926a9707f939de8bc0b
Reviewed-by: Jarkko Koivikko <jarkko.koivikko@code-q.fi>
Reviewed-by: Mitch Curtis <mitch.curtis@qt.io>
Diffstat (limited to 'src')
| -rw-r--r-- | src/virtualkeyboard/content/InputPanel.qml | 5 | ||||
| -rw-r--r-- | src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc | 4 |
2 files changed, 9 insertions, 0 deletions
diff --git a/src/virtualkeyboard/content/InputPanel.qml b/src/virtualkeyboard/content/InputPanel.qml index 3e354471..d2792fa9 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/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc index 4a84c940..ca19f825 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 |