diff options
author | Liang Qi <liang.qi@qt.io> | 2016-11-26 12:56:18 +0100 |
---|---|---|
committer | Liang Qi <liang.qi@qt.io> | 2016-11-26 19:55:26 +0100 |
commit | 573fb399f9917713621d25e0c0aeb48fbc085af5 (patch) | |
tree | edb575544ccc2e48a410f41472a3827ea1f00477 /src/virtualkeyboard/doc/src | |
parent | 947a55149aec2724158934efde1be496b3c5e04e (diff) | |
parent | e67e97e9543eae2de42666eec3ff4d3cdca81db3 (diff) |
Merge remote-tracking branch 'origin/5.7' into 5.8
Conflicts:
src/virtualkeyboard/doc/qtvirtualkeyboard.qdocconf
Change-Id: I2aac70f4bf65794c73096ec575c9f72bc63ec61c
Diffstat (limited to 'src/virtualkeyboard/doc/src')
4 files changed, 73 insertions, 19 deletions
diff --git a/src/virtualkeyboard/doc/src/build.qdoc b/src/virtualkeyboard/doc/src/build.qdoc index 01836252..1e75ef32 100644 --- a/src/virtualkeyboard/doc/src/build.qdoc +++ b/src/virtualkeyboard/doc/src/build.qdoc @@ -29,7 +29,7 @@ /*! -\page build.html +\page qtvirtualkeyboard-build.html \contentspage {Building Qt Virtual Keyboard} {Contents} \title Building Qt Virtual Keyboard diff --git a/src/virtualkeyboard/doc/src/deployment-guide.qdoc b/src/virtualkeyboard/doc/src/deployment-guide.qdoc index 4e4bfd1a..843d2f38 100644 --- a/src/virtualkeyboard/doc/src/deployment-guide.qdoc +++ b/src/virtualkeyboard/doc/src/deployment-guide.qdoc @@ -29,7 +29,7 @@ /*! -\page deployment-guide.html +\page qtvirtualkeyboard-deployment-guide.html \contentspage {Deployment Guide} {Contents} \title Deployment Guide diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc index 1c23af89..94339df7 100644 --- a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc +++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-index.qdoc @@ -99,17 +99,11 @@ \li \l {User Guide} \endlist - \section1 QML Types + \section1 API Reference - \annotatedlist qtvirtualkeyboard-qml - - Styling components: - - \annotatedlist qtvirtualkeyboard-styles-qml - - Settings components: - - \annotatedlist qtvirtualkeyboard-settings-qml + \list + \li \l{Qt Virtual Keyboard QML Types}{QML Types} + \endlist \section1 Examples @@ -130,17 +124,29 @@ */ /*! -\page qt-virtual-keyboard-qmltypes.html +\qmlmodule QtQuick.VirtualKeyboard 2.0 \title Qt Virtual Keyboard QML Types -\inmodule qtvirtualkeyboard +\ingroup qmlmodules +\brief Provides QML types for an input framework and a reference keyboard front +end. + + The QML types can be imported into your application using the following + import statements in your .qml file: + + \badcode + import QtQuick.VirtualKeyboard 2.0 + import QtQuick.VirtualKeyboard.Styles 2.0 + import QtQuick.VirtualKeyboard.Settings 2.0 + \endcode + +Styling: -\annotatedlist qtvirtualkeyboard-qml +\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Styles -Styling components: +Settings: -\annotatedlist qtvirtualkeyboard-styles-qml +\generatelist qmltypesbymodule QtQuick.VirtualKeyboard.Settings -Settings components: +Input framework and keys: -\annotatedlist qtvirtualkeyboard-settings-qml */ diff --git a/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc new file mode 100644 index 00000000..a0514fe9 --- /dev/null +++ b/src/virtualkeyboard/doc/src/qtvirtualkeyboard-module-cpp.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2016 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$ +** +****************************************************************************/ + +/*! + \module QtVirtualKeyboard + \title Qt Virtual Keyboard C++ Classes + \brief Provides classes to implement input methods for virtual keyboards. + + \internal + + \qtvariable virtualkeyboard + + To include the definitions of the module's classes, use the following directive: + + \code + #include <QVirtualKeyboard> + \endcode + + To link against the module, add this line to your qmake .pro file: + + \badcode + QT += virtualkeyboard + \endcode +*/ |