feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity
Files
21f1c1a5e441d35e9e3515ce9ad47c1cfa017e15
qt-creator/doc/qtdesignstudio/src/qtdesignstudio-examples.qdoc

56 lines
2.1 KiB
Plaintext
Raw Normal View History

Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
/****************************************************************************
**
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
** Copyright (C) 2021 The Qt Company Ltd.
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Design Studio 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.
**
****************************************************************************/
/*!
Doc: Restructure the QDS Manual Getting Started chapter - Add the Use Cases topic - Move text from other topics as necessary - Fix the navigation links to match the new structure Fixes: QDS-4468 Change-Id: Ic67dbe073c5be2420795c1f5049217319ab0a202 Reviewed-by: Jarko Vihriala <jarko.vihriala@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-06-02 17:10:38 +02:00
\previouspage studio-terms.html
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
\group studioexamples
Doc: Restructure the QDS Manual Getting Started chapter - Add the Use Cases topic - Move text from other topics as necessary - Fix the navigation links to match the new structure Fixes: QDS-4468 Change-Id: Ic67dbe073c5be2420795c1f5049217319ab0a202 Reviewed-by: Jarko Vihriala <jarko.vihriala@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-06-02 17:10:38 +02:00
\nextpage quick-uis.html
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
\title Examples
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
\QDS comes with a set of example projects. To see these, select \uicontrol
Examples on the \uicontrol Welcome page when you run \QDS.
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
\image studio-examples-download.png "Examples for download in Welcome mode"
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
To run an example project:
\list 1
\li Select the example.
Doc: Copy icons from sources to images\icons Copy black icons with white background to be able to turn them gray with transparent background as a first step of making them visible in both light and dark online doc modes. Task-number: QDS-5693 Change-Id: I317714ba355d7c05742434fcdcafa87aef732dd4 Reviewed-by: Alessandro Portale <alessandro.portale@qt.io>
2021-12-09 17:39:20 +01:00
\li Select the \inlineimage icons/live_preview.png
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
(\uicontrol {Show Live Preview}) button to preview the example.
\endlist
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
Some of the example projects require that you download them before you can run them, to do this:
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
\list 1
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
\li Select an example.
\li Select \uicontrol {Start Download}.
\li Select the folder where the source files will be installed.
\li Select \uicontrol Continue to install the files.
\li Select \uicontrol Open to open the example in \QDS.
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
\endlist
Doc: Split the Examples and Tutorials Section into two pages Splitting Examples and Tutorials to own separate pages. Task-number: QDS-5495 Change-Id: I0014f1ab456298e9b5887b511f608725ec9d2455 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Mahmoud Badri <mahmoud.badri@qt.io>
2021-11-30 15:27:06 +02:00
\section1 Example Documentation
Doc: Describe downloading and installing examples in QDS Some examples can now be downloaded, while others are still delivered with QDS. Task-number: QDS-3407 Change-Id: Ib74dce703d5e824bfbf129951c3fd624ada601b9 Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io> Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
2021-04-08 16:29:58 +02:00
Doc: Add Qt Design Studio Manual sources To build the manual, switch to qtcreator\doc\qtdesignstudiodoc, run qmake, and then "make docs". The example documentation does not get built with this change. We need to decide whether to move the examples or fetch their docs from the other repository. Task-number: QDS-1487 Change-Id: Ic0a8c15b226eba8ac90686953568f3deaa000fb0 Reviewed-by: Eike Ziller <eike.ziller@qt.io> Reviewed-by: Tim Jenssen <tim.jenssen@qt.io>
2020-01-16 16:30:39 +01:00
*/
Copy Permalink