diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc index fc5d0f3fb7d..c90ba786bc5 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc @@ -71,31 +71,6 @@ \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 \previouspage creator-how-tos.html diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index acf3ca83a7c..3c9e696fdb2 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -19,7 +19,6 @@ \li \l{IDE Overview} \li \l{User Interface} \list - \li \l{Selecting Modes} \li \l{Working with Sidebars} \li \l{Browsing Project Contents} \list diff --git a/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc new file mode 100644 index 00000000000..a43cffc4f04 --- /dev/null +++ b/doc/qtcreator/src/user-interface/creator-only/creator-how-to-switch-between-modes.qdoc @@ -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. +*/ diff --git a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc index cd8fd9a62a6..431227e4fc5 100644 --- a/doc/qtcreator/src/user-interface/creator-projects-view.qdoc +++ b/doc/qtcreator/src/user-interface/creator-projects-view.qdoc @@ -37,8 +37,11 @@ \li To open files that belong to a \l{Creating Projects}{project}, double-click them in the project tree. Files open in the appropriate editor, according to the file type. For example, code - source files open in the code editor. Use the \l{Selecting Modes} - {mode selector} to open the current file in another editor. + source files open in the code 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} that has the actions most commonly needed, right-click an item in the project tree. For example, through the menu of diff --git a/doc/qtcreator/src/user-interface/creator-sidebars.qdoc b/doc/qtcreator/src/user-interface/creator-sidebars.qdoc deleted file mode 100644 index aecb42aa76c..00000000000 --- a/doc/qtcreator/src/user-interface/creator-sidebars.qdoc +++ /dev/null @@ -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 -*/ diff --git a/doc/qtcreator/src/user-interface/creator-ui.qdoc b/doc/qtcreator/src/user-interface/creator-ui.qdoc index 0ac81844cf3..5afdb8986d0 100644 --- a/doc/qtcreator/src/user-interface/creator-ui.qdoc +++ b/doc/qtcreator/src/user-interface/creator-ui.qdoc @@ -11,10 +11,11 @@ \page creator-quick-tour.html \if defined(qtdesignstudio) \previouspage {Tutorials} + \nextpage creator-using-qt-quick-designer.html \else \previouspage creator-overview.html + \nextpage creator-sidebars.html \endif - \nextpage creator-modes.html \title User Interface @@ -34,7 +35,7 @@ \li Mode selector \li Perform a particular task, such as designing the UI, writing code, or debugging the application. - \li \l{Selecting Modes} + \li \l{Switch between modes} \row \li \inlineimage numbers/02.png \li Kit selector @@ -83,7 +84,9 @@ \sa {Working with Sidebars}, {Browsing Project Contents} \sa {Use the UI}{How-to: Use the UI} + \else + When you start \QC, it opens to the \uicontrol Welcome mode, where you can: \list @@ -139,91 +142,6 @@ \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 \if defined(qtdesignstudio) @@ -276,7 +194,12 @@ \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" diff --git a/doc/qtcreator/src/user-interface/creator-views.qdoc b/doc/qtcreator/src/user-interface/creator-views.qdoc index e676ed18907..1add46b099f 100644 --- a/doc/qtcreator/src/user-interface/creator-views.qdoc +++ b/doc/qtcreator/src/user-interface/creator-views.qdoc @@ -14,13 +14,13 @@ You can organize \QC views in \l {Working with Sidebars}{sidebars} or as \if defined(qtdesignstudio) - \l {Managing Workspaces}{workspaces}, + \l {Managing Workspaces}{workspaces}, depending on the \l{Mode}{mode} you + are working in. \else - workspaces - \endif - depending on the \l{Selecting Modes} + workspaces, depending on the \l{Switch between modes} {mode} you are working in. Only views that are relevant to a mode are available in it. + \endif \note Usually, \l{Searching with the Locator}{searching with the locator} is the fastest way to find a particular project, file, class, or function, diff --git a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf index 5bcfe70d400..86a948bd889 100644 --- a/doc/qtdesignstudio/config/qtdesignstudio.qdocconf +++ b/doc/qtdesignstudio/config/qtdesignstudio.qdocconf @@ -54,6 +54,7 @@ excludedirs += ../../qtcreator/examples/accelbubble \ ../../qtcreator/src/python \ ../../qtcreator/src/qnx \ ../../qtcreator/src/qtquick/creator-only \ + ../../qtcreator/src/user-interface/creator-only \ ../../qtcreator/src/vcs/creator-only \ ../../qtcreator/src/widgets \ ../../qtcreator/src/webassembly diff --git a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc index 4859c20488c..d4dcb9a75ee 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-terms.qdoc @@ -151,12 +151,11 @@ \image studio-design-mode.webp "Design mode" - Read more about modes: + The mode selector is hidden by default. - \list - \li \l{Selecting Modes} - \li \l{Design Views} - \endlist + To show the mode selector, go to \uicontrol Views > + \uicontrol {Mode Selector Style} and select \uicontrol {Icons and Text} + or \uicontrol {Icons Only}. \section1 Project \target glossary-project diff --git a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc index 6fc2014020f..f8f48a27f10 100644 --- a/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc +++ b/doc/qtdesignstudio/src/qtdesignstudio-toc.qdoc @@ -12,7 +12,6 @@ \li \l{Tutorials} \li \l{User Interface} \list - \li \l{Selecting Modes} \li \l{Design Views} \list \li \l{2D} diff --git a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc index cc18d924417..7750e2e4792 100644 --- a/doc/qtdesignstudio/src/views/qtquick-designer.qdoc +++ b/doc/qtdesignstudio/src/views/qtquick-designer.qdoc @@ -10,7 +10,7 @@ /*! \page creator-using-qt-quick-designer.html - \previouspage creator-modes.html + \previouspage creator-quick-tour.html \nextpage qtquick-form-editor.html \title Design Views