Doc: Combine two topics about selecting modes into one

Move information from "Selecting Modes" to "Switch between modes".
Hide it from the QDS Manual because modes are hidden by default in QDS.

Task-number: QTCREATORBUG-28996
Change-Id: I6d281fe9364e191616af3a8ac484dd0a7d6a3156
Reviewed-by: Mats Honkamaa <mats.honkamaa@qt.io>
This commit is contained in:
Leena Miettinen
2023-06-30 14:47:34 +02:00
parent 0f409b7ae8
commit 1956b0f698
11 changed files with 101 additions and 166 deletions

View File

@@ -71,31 +71,6 @@
\endlist \endlist
*/ */
/*!
\page creator-how-to-switch-between-modes.html
\previouspage creator-how-tos.html
\nextpage creator-known-issues.html
\ingroup creator-how-to-ui
\title Switch between modes
\QC uses different modes for different purposes. You can quickly
switch between these modes with the following keyboard shortcuts:
\list
\li \uicontrol Welcome mode \key Ctrl+1
\li \uicontrol Edit mode \key Ctrl+2
\li \uicontrol Design mode \key Ctrl+3
\li \uicontrol Debug mode \key Ctrl+4
\li \uicontrol Projects mode \key Ctrl+5
\li \uicontrol Help mode \key Ctrl+6
\endlist
For more information about \QC modes, see \l {Selecting Modes}.
*/
/*! /*!
\page creator-how-to-move-between-open-files.html \page creator-how-to-move-between-open-files.html
\previouspage creator-how-tos.html \previouspage creator-how-tos.html

View File

@@ -19,7 +19,6 @@
\li \l{IDE Overview} \li \l{IDE Overview}
\li \l{User Interface} \li \l{User Interface}
\list \list
\li \l{Selecting Modes}
\li \l{Working with Sidebars} \li \l{Working with Sidebars}
\li \l{Browsing Project Contents} \li \l{Browsing Project Contents}
\list \list

View File

@@ -0,0 +1,75 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-switch-between-modes.html
\previouspage creator-how-tos.html
\nextpage creator-known-issues.html
\ingroup creator-how-to-ui
\title Switch between modes
\e Modes let you quickly switch between tasks such as editing
project and source files, designing application UIs, configuring projects
for building and running, and debugging or analyzing source code.
To switch between modes:
\list
\li Click the icons on the mode selector.
\li Use the \l{keyboard-shortcuts}{corresponding keyboard shortcut}.
\endlist
\table
\header
\li {2,1} Mode
\li Keyboard Shortcut
\li Purpose
\li Read More
\row
\li {1,7} \inlineimage qtcreator-mode-selector.png
\row
\li \uicontrol Welcome
\li \key Ctrl+1
\li Open projects, tutorials, and examples.
\li \l{User Interface}
\row
\li \uicontrol Edit
\li \key Ctrl+2
\li Edit project and source files.
\li \l{Working in Edit Mode}
\row
\li \uicontrol Design
\li \key Ctrl+3
\li Design and develop application user interfaces.
This mode is available for UI files.
\li \l{Designing User Interfaces}
\row
\li \uicontrol Debug
\li \key Ctrl+4
\li Inspect the state of your application while debugging or use code
analysis tools to detect memory leaks and profile code.
\li \l{Debugging}
\row
\li \uicontrol Projects
\li \key Ctrl+5
\li Configure how to build and run projects.
This mode is available when a project is open.
\li \l{Specifying Build Settings}
\row
\li \uicontrol Help
\li \key Ctrl+6
\li Read documentation.
\li \l{Using the Help Mode}
\endtable
Some actions in \QC trigger a mode change. For example,
selecting \uicontrol {Debug} > \uicontrol {Start Debugging} >
\uicontrol {Start Debugging of Startup Project} automatically
switches to \uicontrol {Debug} mode.
To hide the mode selector and to save space on the display, select
\uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden.
To only show icons on the mode selector, select the \uicontrol {Icons Only}
style.
*/

View File

@@ -37,8 +37,11 @@
\li To open files that belong to a \l{Creating Projects}{project}, \li To open files that belong to a \l{Creating Projects}{project},
double-click them in the project tree. Files open in the double-click them in the project tree. Files open in the
appropriate editor, according to the file type. For example, code appropriate editor, according to the file type. For example, code
source files open in the code editor. Use the \l{Selecting Modes} source files open in the code editor.
{mode selector} to open the current file in another editor. \if defined(qtcreator)
Use the \l{Switch between modes} {mode selector} to open the current
file in another editor.
\endif
\li To bring up a \l{Projects View Context Menu}{context menu} \li To bring up a \l{Projects View Context Menu}{context menu}
that has the actions most commonly needed, right-click an that has the actions most commonly needed, right-click an
item in the project tree. For example, through the menu of item in the project tree. For example, through the menu of

View File

@@ -1,39 +0,0 @@
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-sidebars.html
\if defined(qtdesignstudio)
\previouspage creator-coding-navigating.html
\else
\previouspage creator-modes.html
\endif
\nextpage creator-views.html
\title Working with Sidebars
In the \uicontrol Edit mode, you can use a left and right sidebar to
organize different views into project contents. Only views that are
relevant to the \l{Selecting Modes}{mode} you are working in are
available in it.
You can select views in the sidebar menu (1):
\image qtcreator-sidebar.png
You can change the view of the sidebars in the following ways:
\list
\li To toggle the left sidebar, click \inlineimage icons/leftsidebaricon.png
(\uicontrol {Hide Left Sidebar/Show Left Sidebar}) or press
\key Alt+0 (\key Cmd+0 on \macos). To toggle the right
sidebar, click \inlineimage icons/rightsidebaricon.png
(\uicontrol {Hide Right Sidebar/Show Right Sidebar}) or press
\key Alt+Shift+0 (\key Cmd+Shift+0 on \macos).
\li To split a sidebar, click \inlineimage icons/splitbutton_horizontal.png
(\uicontrol {Split}). Select new content to view in the split view.
\li To close a sidebar view, click \inlineimage icons/splitbutton_closetop.png
(\uicontrol {Close}).
\endlist
*/

View File

@@ -11,10 +11,11 @@
\page creator-quick-tour.html \page creator-quick-tour.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\previouspage {Tutorials} \previouspage {Tutorials}
\nextpage creator-using-qt-quick-designer.html
\else \else
\previouspage creator-overview.html \previouspage creator-overview.html
\nextpage creator-sidebars.html
\endif \endif
\nextpage creator-modes.html
\title User Interface \title User Interface
@@ -34,7 +35,7 @@
\li Mode selector \li Mode selector
\li Perform a particular task, such as designing the UI, writing code, or \li Perform a particular task, such as designing the UI, writing code, or
debugging the application. debugging the application.
\li \l{Selecting Modes} \li \l{Switch between modes}
\row \row
\li \inlineimage numbers/02.png \li \inlineimage numbers/02.png
\li Kit selector \li Kit selector
@@ -83,7 +84,9 @@
\sa {Working with Sidebars}, {Browsing Project Contents} \sa {Working with Sidebars}, {Browsing Project Contents}
\sa {Use the UI}{How-to: Use the UI} \sa {Use the UI}{How-to: Use the UI}
\else \else
When you start \QC, it opens to the \uicontrol Welcome mode, where you can: When you start \QC, it opens to the \uicontrol Welcome mode, where you can:
\list \list
@@ -139,91 +142,6 @@
\endif \endif
*/ */
/*!
\page creator-modes.html
\previouspage creator-quick-tour.html
\if defined(qtdesignstudio)
\nextpage creator-using-qt-quick-designer.html
\else
\nextpage creator-sidebars.html
\endif
\title Selecting Modes
\image qtcreator-mode-selector.png
\if defined(qtcreator)
The mode selector allows you to quickly switch between tasks such as editing
project and source files, designing application UIs, configuring projects for
building and running, and debugging your applications. To change
modes, click the icons, or use the \l{keyboard-shortcuts}
{corresponding keyboard shortcut}.
To hide the mode selector and to save space on the display, select
\uicontrol View > \uicontrol {Mode Selector Style} > \uicontrol Hidden.
To only show icons on the mode selector, select the \uicontrol {Icons Only}
style.
\endif
\if defined(qtdesignstudio)
The mode selector is hidden by default.
To show the mode selector, go to \uicontrol Views >
\uicontrol {Mode Selector Style} and select \uicontrol {Icons and Text}
or \uicontrol {Icons Only}.
\endif
You can use \QC in the following modes:
\list
\li \uicontrol {\l{User Interface}{Welcome}} mode for opening projects,
tutorials, and examples.
\li \uicontrol{\l{Coding}{Edit}} mode for editing project and source
files.
\if defined(qtcreator)
\li \uicontrol{\l{Designing User Interfaces}{Design}}
mode for designing and developing application user interfaces.
This mode is available for UI files.
\else
\li \uicontrol{\l{Design Views}{Design}}
mode for designing and developing application user interfaces.
As a designer, you'll do most of your work in this mode.
\endif
\if defined(qtcreator)
\li \uicontrol{\l{Debugging}{Debug}}
\else
\li \uicontrol {\l{Debugging and Profiling}{Debug}}
\endif
mode for inspecting the state of your
application while debugging and for using code analysis tools
to detect memory leaks and profile code.
\if defined(qtcreator)
\li \uicontrol{\l{Specifying Build Settings}{Projects}} mode
for configuring project building and execution.
\else
\li \uicontrol{\l{Selecting the Preview Tool}{Projects}} mode
for selecting the tool to use for live preview.
\endif
This mode is available when a project is open.
\li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing
documentation.
\endlist
\if defined(qtcreator)
Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} >
\uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to
\uicontrol {Debug} mode.
\endif
*/
/*! /*!
\page creator-output-panes.html \page creator-output-panes.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
@@ -276,7 +194,12 @@
\endlist \endlist
Output is available on the taskbar in all \l{Selecting Modes}{modes}. Output is available on the taskbar in all
\if defined(qtcreator)
\l{Switch between modes}{modes}.
\else
\l{Mode}{modes}.
\endif
\image qtcreator-output-panes-taskbar.webp "Output on the taskbar" \image qtcreator-output-panes-taskbar.webp "Output on the taskbar"

View File

@@ -14,13 +14,13 @@
You can organize \QC views in \l {Working with Sidebars}{sidebars} or as You can organize \QC views in \l {Working with Sidebars}{sidebars} or as
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\l {Managing Workspaces}{workspaces}, \l {Managing Workspaces}{workspaces}, depending on the \l{Mode}{mode} you
are working in.
\else \else
workspaces workspaces, depending on the \l{Switch between modes}
\endif
depending on the \l{Selecting Modes}
{mode} you are working in. Only views that are relevant to a mode are {mode} you are working in. Only views that are relevant to a mode are
available in it. available in it.
\endif
\note Usually, \l{Searching with the Locator}{searching with the locator} \note Usually, \l{Searching with the Locator}{searching with the locator}
is the fastest way to find a particular project, file, class, or function, is the fastest way to find a particular project, file, class, or function,

View File

@@ -54,6 +54,7 @@ excludedirs += ../../qtcreator/examples/accelbubble \
../../qtcreator/src/python \ ../../qtcreator/src/python \
../../qtcreator/src/qnx \ ../../qtcreator/src/qnx \
../../qtcreator/src/qtquick/creator-only \ ../../qtcreator/src/qtquick/creator-only \
../../qtcreator/src/user-interface/creator-only \
../../qtcreator/src/vcs/creator-only \ ../../qtcreator/src/vcs/creator-only \
../../qtcreator/src/widgets \ ../../qtcreator/src/widgets \
../../qtcreator/src/webassembly ../../qtcreator/src/webassembly

View File

@@ -151,12 +151,11 @@
\image studio-design-mode.webp "Design mode" \image studio-design-mode.webp "Design mode"
Read more about modes: The mode selector is hidden by default.
\list To show the mode selector, go to \uicontrol Views >
\li \l{Selecting Modes} \uicontrol {Mode Selector Style} and select \uicontrol {Icons and Text}
\li \l{Design Views} or \uicontrol {Icons Only}.
\endlist
\section1 Project \section1 Project
\target glossary-project \target glossary-project

View File

@@ -12,7 +12,6 @@
\li \l{Tutorials} \li \l{Tutorials}
\li \l{User Interface} \li \l{User Interface}
\list \list
\li \l{Selecting Modes}
\li \l{Design Views} \li \l{Design Views}
\list \list
\li \l{2D} \li \l{2D}

View File

@@ -10,7 +10,7 @@
/*! /*!
\page creator-using-qt-quick-designer.html \page creator-using-qt-quick-designer.html
\previouspage creator-modes.html \previouspage creator-quick-tour.html
\nextpage qtquick-form-editor.html \nextpage qtquick-form-editor.html
\title Design Views \title Design Views