QmlDesigner: Document Jump to the Code feature

This patch documents the jump to code features. It allows
users to instantly jump to code specific for a component,
state or connection.

Fixes: QDS-11132
Change-Id: I4483dda8dd6a899ddee017196e697008f4be0fcd
Reviewed-by: Qt CI Patch Build Bot <ci_patchbuild_bot@qt.io>
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
Reviewed-by: Johanna Vanhatapio <johanna.vanhatapio@qt.io>
This commit is contained in:
Pranta Dastider
2023-12-14 19:03:04 +01:00
committed by Pranta Ghosh Dastider
parent a3b58d9107
commit 1c4a2ade1d
10 changed files with 77 additions and 2 deletions

View File

@@ -3,7 +3,7 @@
/*!
\page creator-editor-refactoring.html
\previouspage creator-editor-locator.html
\previouspage creator-jump-to-the-code.html
\nextpage creator-editor-quick-fixes.html
\title Refactoring

View File

@@ -37,6 +37,14 @@
through projects, files, classes, functions, documentation and
file systems.
\li \l{Jump to the Code}
Jump to the code for a specific component directly from
the \uicontrol {2D} view or \uicontrol {Navigator} view.
You can also jump to the code of a particular
\uicontrol {State} or \uicontrol {Connection} from their
corresponding views.
\endlist
*/

View File

@@ -0,0 +1,66 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\previouspage creator-editor-locator.html
\page creator-jump-to-the-code.html
\nextpage creator-editor-refactoring.html
\title Jump to the Code
Jump to the code is a feature that gives you instant access to a particular
part of the code. It takes you to the \uicontrol {Code} view location of a particular
component, \uicontrol {State}, or \uicontrol {Connection}.
You can jump to the code from:
\list
\li \uicontrol {Navigator} view
\li \uicontrol {2D} view
\li \uicontrol {States} view
\li \uicontrol {Connections} view
\endlist
\section1 Jump to the Code from the Navigator View
\list 1
\li Right-click on a component in the \uicontrol {Navigator} view.
\li Select \uicontrol {Jump to the Code}.
\endlist
\image jump-to-the-code-from-navigator-view.webp
\section1 Jump to the Code from the 2D View
\list 1
\li Right-click on a component in the \uicontrol {2D} view.
\li Select \uicontrol {Jump to the Code}.
\endlist
\image jump-to-the-code-from-2D-view.webp
\note Alternatively, you can select the component in the \uicontrol {Navigator} view
or in the \uicontrol {2D} view and press \key {F4}. That takes you to the code
location in the \uicontrol {Code} view.
\section1 Jump to the Code from the States View
\list 1
\li Locate the state you want to check in the \uicontrol {States} view.
\li Select \inlineimage icons/browse-button.png
to open additional options.
\li Select \uicontrol {Jump to the Code}.
\endlist
\image jump-to-the-code-from-state-view.webp
\section1 Jump to the Code from the Connections View
\list 1
\li Select a connection in the \uicontrol {Connections} view.
\li Select \inlineimage icons/jump-to-code-16px.png
to jump to the code segment related to the connection.
\endlist
\image jump-to-the-code-from-connections-view.webp
*/

View File

@@ -4,7 +4,7 @@
/*!
\previouspage creator-editor-finding.html
\page creator-editor-locator.html
\nextpage creator-editor-refactoring.html
\nextpage creator-jump-to-the-code.html
\title Searching with the Locator

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View File

@@ -214,6 +214,7 @@
\list
\li \l{Finding and Replacing}
\li \l{Searching with the Locator}
\li \l{Jump to the Code}
\endlist
\li \l{Refactoring}
\li \l{Applying Refactoring Actions}