Skip to content

Commit

Permalink
QmlDesigner: Update the documentation for Run dropdown and Qt UI viewer
Browse files Browse the repository at this point in the history
The Run dropdown button is a new inclusion which has
changed the way how applications can be run or preview
in Qt Design Studio. This document updates the basic
idea of that across a few documents. It also updates
the old Qt UI viewer document to include the new way
of intracting with the Android app and Qt design studio.

Fixes: QDS-13920
Fixes: QDS-14311
Fixes: QDS-13918
Change-Id: I66d3bdbf147c750f59d5521878015d6a8a7c0c92
  • Loading branch information
PrantaGhoshDastider authored and ThomasHartmannQt committed Feb 7, 2025
1 parent 9985489 commit 7c5bdef
Show file tree
Hide file tree
Showing 21 changed files with 103 additions and 92 deletions.
1 change: 1 addition & 0 deletions doc/qtdesignstudio/config/style/qt5-sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ <h2>Working with</h2>
<li><a>Projects</a>
<ul>
<li><a href="studio-projects.html">Creating projects</a></li>
<li><a href="studio-live-preview-desktop.html">Running a Qt Design Studio project</a></li>
<li><a href="studio-designer-developer-workflow.html">Designer-developer workflow</a></li>
</ul>
</li>
Expand Down
Binary file not shown.
Binary file modified doc/qtdesignstudio/images/qtuiviewer-appstore.webp
Binary file not shown.
Binary file removed doc/qtdesignstudio/images/qtuiviewer-examples.webp
Binary file not shown.
Binary file not shown.
Binary file removed doc/qtdesignstudio/images/qtuiviewer-network.webp
Binary file not shown.
Binary file not shown.
Binary file modified doc/qtdesignstudio/images/qtuiviewer-settings.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified doc/qtdesignstudio/images/studio-live-preview.webp
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added doc/qtdesignstudio/images/studio-run-project.webp
Binary file not shown.
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,35 +1,34 @@
// Copyright (C) 2024 The Qt Company Ltd.
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
\page studio-live-preview-desktop.html
\previouspage studio-live-preview.html
\previouspage studio-run-project.html
\nextpage creator-live-preview-devices.html

\title Previewing on desktop

To preview the currently active QML file on the desktop:

\list
\li Select the \uicontrol {Live Preview} button on the top toolbar.
\li Select \key {Alt+P}.
\image studio-live-preview.webp
\list 1
\li Select \uicontrol Run dropdown from the top toolbar and select
\uicontrol {Live Preview}.
\li Select \imagerunproject.
\image studio-live-preview.webp Live preview a \QDS project on the desktop

\note Alternatively, select \key {Alt+P}.
\endlist

To preview any QML file in the project:

\list
\li Select the \uicontrol {Live Preview} button on the top toolbar.
\list 1
\li Select \uicontrol Run dropdown from the top toolbar and select
\uicontrol {Live Preview}.
\li Select \imagerunproject.
\li Right-click the filename in the \l Projects view, and select
\uicontrol {Preview File}.
\endlist

To preview the whole application, select \uicontrol {Live Preview}
when viewing the main QML file of the project.

To preview the application in a different zoom level, right-click the \uicontrol {Live Preview}
button and select the zoom level.

\section1 Overriding the preview tool

By default, the QML runtime is used for previewing.
Expand All @@ -39,7 +38,7 @@
\list 1
\li Select \imagesettings to go to
\uicontrol {Run Settings}.
\image studio-run-settings.webp {Run Settings}
\image studio-run-settings.webp Run Settings
\li In \uicontrol {Override device QML viewer}, select the folder where
the preview tool executable is located.
\endlist
Expand Down
25 changes: 25 additions & 0 deletions doc/qtdesignstudio/src/how-to/qtdesignstudio-run-project.qdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
\page studio-run-project.html
\previouspage studio-live-preview.html
\nextpage studio-live-preview-desktop.html

\title Running a \QDS project

To run a project created with \QDS:

\list 1
\li Open the project with \QDS.
\li Select \uicontrol Run dropdown from the top toolbar and select
\uicontrol {Run App}.
\li Select \imagerunproject.
\image studio-run-project.webp {Run a \QDS project}

\note Alternatively, select \key {Ctrl+R}.
\endlist



*/
19 changes: 10 additions & 9 deletions doc/qtdesignstudio/src/overviews/qtquick-live-preview.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,27 @@
devices, the preview shows the snapshot of your project from the moment
you start the preview on the device, not your changes.

\image studio-live-preview.webp
\image studio-live-preview.webp Live preview of the application

Or, use \QDV to run applications in most widely-used web browsers on the
desktop and in mobile devices and share your designs with reviewers who
don't have \QC.
don't have \QDS.

To learn more follow the topics below:
\list
\li \l{Running a \QDS project}
{Run a project created with \QDS}.

\li \l{Previewing on desktop}
{Preview individual QML files or the whole UI}.

Preview individual QML files or the whole UI.
\li \l{Previewing on devices}

Connect your devices to your computer.
{Connect your devices to your computer}.

\li \l{Sharing applications online}

Share applications online and view them in a web browser.
{Share applications online and view them in a web browser}.

\li \l{Viewing applications on Android}

Preview \QDS projects with \QUV on an Android device.
{Preview \QDS projects with \QUV on an Android device}.
\endlist
*/
120 changes: 52 additions & 68 deletions doc/qtdesignstudio/src/qtdesignstudio-qt-ui-viewer.qdoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (C) 2024 The Qt Company Ltd.
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
Expand All @@ -9,100 +9,84 @@

\title Viewing applications on Android

View \QDS projects that you have shared online in \QUV.
Bring all the projects from a \QDS ID to \QUV, or establish a direct
network connection for a real-time preview of your current \QDS project.
These projects then run on your Android device. You can also
adjust settings, view logs, and run example projects.

\note This feature is included in the
\l{https://www.qt.io/pricing}{Qt Design Studio Enterprise license}.
\uicontrol {Share Application Online} and \uicontrol {Deploy Project to Android}
are unavailable in \QDS without the Enterprise license.
Run and preview your \QDS projects in \QUV with a
direct network connection in real-time.

\section1 Installing Qt UI Viewer

\image qtuiviewer-appstore.webp

To install \QUV on your Android device:
\list 1
\li Open the Google Play store on your Android device.
\li Search for \QUV.
\li Select \uicontrol Install.
\li Open \QUV.
\endlist
\image qtuiviewer-appstore.webp Qt UI Viewer in the Google Play Store

\section1 Connecting a \QDS ID with \QUV
\section1 Creating a network connection between \QDS and \QUV

Connect your \QDS ID to \QUV to access all your shared \QDS projects in \QUV:
\note Use the same network to connect both \QDS and your
Android device where you have installed \QUV.
\list 1
\li Open \QDS on your computer.
\li Open \QUV on your Android device. Find the IP address and note it down.
\li Open or create a project in \QDS.
\li Go to \uicontrol File > \uicontrol {Share Application Online}.

\inlineimage menu-share-application-online.webp
\inlineimage studio-share-application-online.webp

\li Open \QUV on your Android device.
\li Select \uicontrol {Scan QR Code}.
\image qtuiviewer-scan-qr-code.webp
\li Scan the QR code from Share Application Online in the \QDS.
\li Select \uicontrol Run dropdown from the top toolbar and select
\uicontrol {Device Manager}.

\image studio-run-dropdown.webp Device Manager in the Run dropdown

\li In \uicontrol {Set target device IP} write the IP address you have
noted from \QUV. Then, select \imageplus. Your device is now added
to the list of available devices.
\list
\li To update the device name, edit \uicontrol Alias.
\li To show your device in the \uicontrol Run dropdow,
always keep \uicontrol Enabled turned on.
\li If you are connected to the same network, and \QUV is running on your
Android device, the \uicontrol Status is Online.
\endlist

\image studio-devicemanager-add-device.webp {Add an device in the Device Manager}
\endlist

\note Only one \QDS ID can be connected to the \QUV at a time.

\section1 Running a \QDS project in \QUV
\note You can connect multiple Android devices to \QDS. Then, run a \QDS
project on any of the devices by selecting them from
\uicontrol Run dropdown, and selecting \imagerunproject.

Once the projects are in \QUV:
\list 1
\li Select a project from the drop-down.
\li Select \uicontrol {Run Project}.
\image qtuiviewer-live-project.webp
\endlist
\section1 Previewing a \QDS project in \QUV

Control how frequently \QUV updates the projects or make the project
fit the device display from \QUV \uicontrol {Settings}.
Once you have created a network connection between \QDS and \QUV:

To specify these settings:
\list 1
\li Go to \uicontrol File > \uicontrol {Settings}.
\li Toggle the \uicontrol {Update user projects in the background} or
the \uicontrol {Auto scale the project} setting.
\image qtuiviewer-settings.webp
\li Open or create a project in \QDS.
\li Open \QUV on your Android device.
\li Select your Android device from the \uicontrol Run dropdown.
\image studio-run-dropdown-with-added-device.webp {Android device listed in the Run dropdown}

\note The setting "Auto scale the project" works independent of the \QDS
ID connection.
\li Select \imagerunproject.
\endlist

\section1 Creating a network connection between \QDS and \QUV
Every time you close \QUV or \QDS, you need to follow the above process
to preview it again in \QUV.

To create a direct connection with a \QDS project without using a
\QDS ID, first, get your Android device's \e {Local IP} from \QUV.
Then, use the \e {Local IP} in \QDS.
To fit the preview on your Android device's screen, select \uicontrol Settings
in the \QUV and turn on \uicontrol Auto-scale. \QUV follows the orientation of your
Android device.

To get the \e {Local IP} from \QUV:
\list 1
\li Go to \uicontrol Menu > \uicontrol Network.
\li Note the \e {Local IP} of your Android device.
\image qtuiviewer-network.webp
\endlist
To keep your Android device awake, select \uicontrol Settings
in the \QUV and turn on \uicontrol {Keep screen on}.

\image qtuiviewer-settings.webp Settings of the Qt UI Viewer

\section1 Removing a connected Android device from \QDS

To establish a direct connection between \QUV and \QDS:
\list 1
\li Open \QDS on your computer.
\li Open the project you want to connect directly.
\li Go to \uicontrol File > \uicontrol {Deploy Project to Android}.
\li Enter the \e {Local IP} you got from \QUV into \uicontrol {Device IP}.
\li Select \uicontrol Connect.
\image studio-deploy-project-to-android.webp

\li Select \uicontrol {Send Project}.
\li In \QUV, select \uicontrol Menu > \uicontrol Network. The \QDS project
now runs in \QUV.
\li Open or create a project in \QDS.
\li Select \uicontrol Run dropdown from the top toolbar and select
\uicontrol {Device Manager}.
\li Select the device you want to remove from the list of devices and
select \imageminus.
\image studio-devicemanager-remove-device.webp Remove a device from the Device Manager
\endlist

\note The Android device needs to be on the same network as the \QDS
workstation for the connection to work. Also, automatic synchronization
is not possible. To update your project manually send it again.

*/
1 change: 1 addition & 0 deletions doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
\endlist
\li \l{Validating with target hardware}
\list
\li \l{Running a \QDS project}
\li \l{Previewing on desktop}
\li \l{Previewing on devices}
\li \l{Sharing applications online}
Expand Down

0 comments on commit 7c5bdef

Please sign in to comment.