diff options
| -rw-r--r-- | doc/config/macros.qdocconf | 1 | ||||
| -rw-r--r-- | doc/examples/progressbar/main.cpp | 18 | ||||
| -rw-r--r-- | doc/examples/progressbar/progressbar.pro | 30 | ||||
| -rw-r--r-- | doc/examples/progressbar/qml.qrc | 5 | ||||
| -rw-r--r-- | doc/examples/progressbar/qml/ProgressBar.qmlproject | 20 | ||||
| -rw-r--r-- | doc/examples/progressbar/qml/ProgressBar.ui.qml | 177 | ||||
| -rw-r--r-- | doc/examples/progressbar/qml/Root.qml | 153 | ||||
| -rw-r--r-- | doc/examples/progressbar/qml/built-with-Qt_Large.png | bin | 0 -> 49186 bytes | |||
| -rw-r--r-- | doc/src/qtcreator-toc.qdoc | 3 | ||||
| -rw-r--r-- | doc/src/qtquick/creator-only/qtquick-app-development.qdoc | 8 | ||||
| -rw-r--r-- | doc/src/qtquick/creator-only/qtquick-modules-with-plugins.qdoc | 4 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc | 138 | ||||
| -rw-r--r-- | doc/src/widgets/qtdesigner-overview.qdoc | 4 |
13 files changed, 555 insertions, 6 deletions
diff --git a/doc/config/macros.qdocconf b/doc/config/macros.qdocconf index d6c97fe4eb9..a6817d36426 100644 --- a/doc/config/macros.qdocconf +++ b/doc/config/macros.qdocconf @@ -20,6 +20,7 @@ macro.QA = "Qt Assistant" macro.QC = "$IDE_DISPLAY_NAME" macro.QCE = "$IDE_DISPLAY_NAME Enterprise" macro.QD = "Qt Designer" +macro.QDS = "Qt Design Studio" macro.QL = "Qt Linguist" macro.QMLD = "Qt Quick Designer" macro.QQV = "Qt QML Viewer" diff --git a/doc/examples/progressbar/main.cpp b/doc/examples/progressbar/main.cpp new file mode 100644 index 00000000000..f8f4c584aa5 --- /dev/null +++ b/doc/examples/progressbar/main.cpp @@ -0,0 +1,18 @@ +#include <QGuiApplication> +#include <QQmlApplicationEngine> +#include <QQuickView> + +int main(int argc, char *argv[]) +{ + QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling); + + QGuiApplication app(argc, argv); + + QQuickView view; + view.setSource(QUrl("qrc:/qml/ProgressBar.ui.qml")); + if (!view.errors().isEmpty()) + return -1; + view.show(); + + app.exec(); +} diff --git a/doc/examples/progressbar/progressbar.pro b/doc/examples/progressbar/progressbar.pro new file mode 100644 index 00000000000..85993f1729f --- /dev/null +++ b/doc/examples/progressbar/progressbar.pro @@ -0,0 +1,30 @@ +QT += quick +CONFIG += c++11 + +# The following define makes your compiler emit warnings if you use +# any Qt feature that has been marked deprecated (the exact warnings +# depend on your compiler). Refer to the documentation for the +# deprecated API to know how to port your code away from it. +DEFINES += QT_DEPRECATED_WARNINGS + +# You can also make your code fail to compile if it uses deprecated APIs. +# In order to do so, uncomment the following line. +# You can also select to disable deprecated APIs only up to a certain version of Qt. +#DEFINES += QT_DISABLE_DEPRECATED_BEFORE=0x060000 # disables all the APIs deprecated before Qt 6.0.0 + +SOURCES += \ + main.cpp + +RESOURCES += \ + $$files(qml/*) + +# Additional import path used to resolve QML modules in Qt Creator's code model +QML_IMPORT_PATH = + +# Additional import path used to resolve QML modules just for Qt Quick Designer +QML_DESIGNER_IMPORT_PATH = + +# Default rules for deployment. +qnx: target.path = /tmp/$${TARGET}/bin +else: unix:!android: target.path = /opt/$${TARGET}/bin +!isEmpty(target.path): INSTALLS += target diff --git a/doc/examples/progressbar/qml.qrc b/doc/examples/progressbar/qml.qrc new file mode 100644 index 00000000000..5f6483ac33f --- /dev/null +++ b/doc/examples/progressbar/qml.qrc @@ -0,0 +1,5 @@ +<RCC> + <qresource prefix="/"> + <file>main.qml</file> + </qresource> +</RCC> diff --git a/doc/examples/progressbar/qml/ProgressBar.qmlproject b/doc/examples/progressbar/qml/ProgressBar.qmlproject new file mode 100644 index 00000000000..0375ab01852 --- /dev/null +++ b/doc/examples/progressbar/qml/ProgressBar.qmlproject @@ -0,0 +1,20 @@ +/* File generated by Qt Creator */ + +import QmlProject 1.1 + +Project { + mainFile: "ProgressBar.ui.qml" + + /* Include .qml, .js, and image files from current directory and subdirectories */ + QmlFiles { + directory: "." + } + JavaScriptFiles { + directory: "." + } + ImageFiles { + directory: "." + } + /* List of plugin directories passed to QML runtime */ + // importPaths: [ "../exampleplugin" ] +} diff --git a/doc/examples/progressbar/qml/ProgressBar.ui.qml b/doc/examples/progressbar/qml/ProgressBar.ui.qml new file mode 100644 index 00000000000..d60695dea32 --- /dev/null +++ b/doc/examples/progressbar/qml/ProgressBar.ui.qml @@ -0,0 +1,177 @@ + + +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the examples of the Qt Design Studio. +** +** $QT_BEGIN_LICENSE:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +import QtQuick 2.9 +import QtQuick.Window 2.3 +import QtQuick.Timeline 1.0 +import QtQuick.Layouts 1.0 +import QtQuick.Controls 2.3 + +Rectangle { + visible: true + width: 640 + height: 480 + color: "#242424" + + ColumnLayout { + x: 20 + y: 152 + spacing: 20 + + Root { + id: root + } + + Root { + id: root1 + } + + Root { + id: root2 + } + } + + Timeline { + id: timeline + enabled: true + endFrame: 4000 + startFrame: 0 + + KeyframeGroup { + target: root + property: "progress" + + Keyframe { + value: 10 + frame: 0 + } + + Keyframe { + easing.bezierCurve: [0.86, 0.00, 0.07, 1.00, 1, 1] + value: 90 + frame: 2000 + } + + Keyframe { + easing.bezierCurve: [0.86, 0.00, 0.07, 1.00, 1, 1] + value: 10 + frame: 4000 + } + } + + KeyframeGroup { + target: root1 + property: "progress" + + Keyframe { + easing.bezierCurve: [0.17, 0.84, 0.44, 1.00, 1, 1] + value: 90 + frame: 4000 + } + + Keyframe { + easing.bezierCurve: [0.17, 0.84, 0.44, 1.00, 1, 1] + value: 20 + frame: 2000 + } + + Keyframe { + value: 90 + frame: 0 + } + } + + KeyframeGroup { + target: root2 + property: "progress" + + Keyframe { + value: 15 + frame: 0 + } + + Keyframe { + easing.bezierCurve: [0.79, 0.14, 0.15, 0.86, 1, 1] + value: 85 + frame: 2000 + } + + Keyframe { + easing.bezierCurve: [0.79, 0.14, 0.15, 0.86, 1, 1] + value: 15 + frame: 4000 + } + } + + animations: [ + TimelineAnimation { + id: propertyAnimation + target: timeline + property: "currentFrame" + running: true + to: timeline.endFrame + from: timeline.startFrame + loops: -1 + duration: 1000 + } + ] + } + + Image { + id: image + x: 518 + y: 0 + width: 102 + height: 137 + fillMode: Image.PreserveAspectFit + source: "built-with-Qt_Large.png" + } +} diff --git a/doc/examples/progressbar/qml/Root.qml b/doc/examples/progressbar/qml/Root.qml new file mode 100644 index 00000000000..aab23735457 --- /dev/null +++ b/doc/examples/progressbar/qml/Root.qml @@ -0,0 +1,153 @@ +/**************************************************************************** +** +** Copyright (C) 2018 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the examples of the Qt Design Studio. +** +** $QT_BEGIN_LICENSE:BSD$ +** 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. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +import QtQuick 2.9 +import QtQuick.Timeline 1.0 + +Item { + id: root + width: 600 + height: 65 + property alias progress: timeline.currentFrame + + Rectangle { + id: pb_back + color: "#9f9f9f" + radius: 4 + anchors.right: parent.right + anchors.rightMargin: 0 + anchors.left: parent.left + anchors.leftMargin: 0 + anchors.bottom: parent.bottom + anchors.bottomMargin: 0 + anchors.top: parent.top + anchors.topMargin: 30 + + Rectangle { + id: pb_front + width: 200 + color: "#ffffff" + anchors.bottomMargin: 5 + anchors.left: parent.left + anchors.leftMargin: 5 + anchors.bottom: parent.bottom + anchors.top: parent.top + anchors.topMargin: 5 + } + } + + Text { + id: text1 + color: "#ffffff" + text: Math.round(root.progress) + font.pixelSize: 18 + } + + Timeline { + id: timeline + enabled: true + startFrame: 0 + endFrame: 100 + + KeyframeGroup { + target: text1 + property: "color" + + Keyframe { + value: "#8de98d" + frame: 0 + } + + Keyframe { + value: "#de4f4f" + frame: 50 + } + + Keyframe { + value: "#f0c861" + frame: 100 + } + } + + KeyframeGroup { + target: pb_front + property: "width" + + Keyframe { + value: 0 + frame: 0 + } + + Keyframe { + value: 590 + frame: 100 + } + } + + KeyframeGroup { + target: pb_front + property: "color" + Keyframe { + value: "#8de98d" + frame: 0 + } + + Keyframe { + value: "#de4f4f" + frame: 50 + } + + Keyframe { + value: "#f0c861" + frame: 100 + } + } + } +} diff --git a/doc/examples/progressbar/qml/built-with-Qt_Large.png b/doc/examples/progressbar/qml/built-with-Qt_Large.png Binary files differnew file mode 100644 index 00000000000..75ec0fa0800 --- /dev/null +++ b/doc/examples/progressbar/qml/built-with-Qt_Large.png diff --git a/doc/src/qtcreator-toc.qdoc b/doc/src/qtcreator-toc.qdoc index 72826d00348..3bf014ccc8c 100644 --- a/doc/src/qtcreator-toc.qdoc +++ b/doc/src/qtcreator-toc.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2017 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -107,6 +107,7 @@ \li \l {Browsing ISO 7000 Icons} \li \l {Exporting Designs from Graphics Software} \li \l {Using QML Modules with Plugins} + \li \l {Converting Qt Quick UI Prototypes to Applications} \endlist \li \l{Developing Widget Based Applications} \list diff --git a/doc/src/qtquick/creator-only/qtquick-app-development.qdoc b/doc/src/qtquick/creator-only/qtquick-app-development.qdoc index 7890a1d5382..f9b255edf74 100644 --- a/doc/src/qtquick/creator-only/qtquick-app-development.qdoc +++ b/doc/src/qtquick/creator-only/qtquick-app-development.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -105,6 +105,12 @@ details of the contained components, and therefore, the modules must provide extra type information for code completion and the semantic checks to work correctly. + \li \l {Converting Qt Quick UI Prototypes to Applications} + + Qt Quick UI projects are useful for prototyping user interfaces. To + use them for application development, you have to convert them to + Qt Quick Application projects that contain .pro, .cpp, and .qrc + files. \endlist diff --git a/doc/src/qtquick/creator-only/qtquick-modules-with-plugins.qdoc b/doc/src/qtquick/creator-only/qtquick-modules-with-plugins.qdoc index c8f04145fe1..118349a0ae7 100644 --- a/doc/src/qtquick/creator-only/qtquick-modules-with-plugins.qdoc +++ b/doc/src/qtquick/creator-only/qtquick-modules-with-plugins.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -33,7 +33,7 @@ \contentspage index.html \previouspage quick-export-to-qml.html \page creator-qml-modules-with-plugins.html - \nextpage creator-using-qt-designer.html + \nextpage quick-converting-ui-projects.html \title Using QML Modules with Plugins diff --git a/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc b/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc new file mode 100644 index 00000000000..64eb3dfe4fe --- /dev/null +++ b/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc @@ -0,0 +1,138 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** 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. +** +****************************************************************************/ + +/*! + \contentspage index.html + \page quick-converting-ui-projects.html + \if defined(qtdesignstudio) + \previouspage studio-importing-designs.html + \nextpage studio-prototyping.html + \else + \previouspage creator-qml-modules-with-plugins.html + \nextpage creator-using-qt-designer.html + \endif + + \title Converting Qt Quick UI Prototypes to Applications + + Qt Quick UI projects are useful for prototyping user interfaces. To + use them for application development in Qt Creator you have to add: + + \list + \li Project configuration file (.pro) + \li C++ code (.cpp) + \li Resource files (.qrc) + \li Code needed for deploying applications to \l{glossary-device} + {devices} + \endlist + + You can use a Qt Creator wizard to create a Qt Quick application that is + built using the qmake build system and then copy the source files from the + Qt UI Quick prototype project to the application project. + + You can use the \c RESOURCES option in the project configuration file to + automatically add all the QML files and related assets to a Qt resource + file. + + The wizard automatically adds the \c QML_IMPORT_PATH option to the project + file for specifying the required + \l{https://doc.qt.io/qt-5/qtqml-syntax-imports.html#qml-import-path} + {QML import path}. The path is only needed if more than one subdirectory + contains QML files. + + Then you can use the \l QQuickView class in the main C++ source file to + show the main QML file when the application starts. + + At the time of this writing, the Qt Quick Timeline module is delivered with + \QDS, but not with Qt. If you use a timeline in a \QDS project that you + import to \QC, you must build the Qt Quick Timeline module and install it to + your Qt to be able to build your project. + + \section1 Converting Projects + + To convert a Qt Quick UI prototype project that has a .qmlproject file to + a Qt Quick application that has a .pro file: + + \list 1 + \li Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol Application > \uicontrol {Qt Quick Application - Empty} > + \uicontrol Choose. + \li In the \uicontrol {Build system} field, select \l qmake as the build + system to use for building and running the project, and then select + \uicontrol Next (or \uicontrol Continue on \macos). + \li Follow the instructions of the wizard to create the project. + \li In the file explorer, copy the source files from the Qt Quick UI + prototype project directory to a subdirectory in the application + project directory. For the purpose of these instructions, the + directory is called \c qml. + \li Open the application project file, and edit the value of the + \c RESOURCES option to add the following line: + \badcode + RESOURCES += \ + $$files(qml/*) + \endcode + \li Select \uicontrol Build > \uicontrol {Run qmake} to apply the + \c RESOURCES option to the build configuration. + \li Open the \e {main.cpp} file and replace the QQmlApplicationEngine + object with a QQuickView object: + \quotefromfile progressbar/main.cpp + \skipto QQuickView view; + \printuntil view.show() + Where \c {qml\main.qml} is the path to and the name of the main QML + file in the Qt Quick UI prototype project. + \li Select \uicontrol Build > \uicontrol Run to build and run your + project. + \endlist + + For example, if you copy the source files of the \e ProgressBar + example from your \QDS installation (located in the + \c{\share\qtcreator\examples\ProgressBar} directory) to an empty + Qt Quick application project and make the necessary changes, the + \e {main.cpp} file should look as follows: + + \quotefile progressbar/main.cpp + + \section1 Adding Qt Quick Timeline Module to Qt Installations + + Check out the Qt Quick Timeline module from + \l{https://codereview.qt-project.org/#/admin/projects/qt/qtquicktimeline} + {Qt Code Review}. + + For example: + \badcode + git clone ssh://user@codereview.qt-project.org:29418/qt/qtquicktimeline + \endcode + + Then use qmake from your Qt installation to build the module and to add it + to your Qt. Switch to the directory that contains the sources (usually, + \c qtquicktimeline), and enter the following commands: + + \badcode + <path_to_qmake>\qmake -r + make + make install + \endcode + + On Windows, use the \c nmake and \c {nmake install} commands instead. +*/ diff --git a/doc/src/widgets/qtdesigner-overview.qdoc b/doc/src/widgets/qtdesigner-overview.qdoc index 2706f262092..ba406bb8d9e 100644 --- a/doc/src/widgets/qtdesigner-overview.qdoc +++ b/doc/src/widgets/qtdesigner-overview.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -31,7 +31,7 @@ /*! \contentspage index.html - \previouspage creator-qml-modules-with-plugins.html + \previouspage quick-converting-ui-projects.html \page creator-using-qt-designer.html \nextpage adding-plugins.html |
