feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe managing workspaces

Browse Source 
Conceptually separate dockable views from sidebar views, because
the former can now be organized using workspaces in the Design
mode (where the sidebars are now disabled).

Fixes: QTCREATORBUG-23582
Change-Id: Iaf310d4fbc9277330708f6756201e4b43dc1eedb
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-02-24 15:38:42 +01:00
parent ac26d3bab9
commit 2c406ff398
7 changed files with 144 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtcreator/images/qtcreator-workspace-manager.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 7.8 KiB

57
doc/qtcreator/src/howto/creator-sidebars.qdoc Normal file
View File

@@ -0,0 +1,57 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator 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.
**
****************************************************************************/
/*!
\contentspage index.html
\page creator-sidebars.html
\previouspage creator-views.html
\nextpage creator-project-managing-workspaces.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 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 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 splitbutton_horizontal.png
(\uicontrol {Split}). Select new content to view in the split view.
\li To close a sidebar view, click \inlineimage splitbutton_closetop.png
(\uicontrol {Close}).
\endlist
*/

12
doc/qtcreator/src/howto/creator-ui.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -87,11 +87,13 @@
\endif
The following sections describe some of these controls in more detail:
The following sections describe some \QC controls in more detail:
\list
\li \l{Selecting Modes}{Mode selector}
\li \l{Browsing Project Contents}{Sidebars}
\li \l{Browsing Project Contents}{Views}
\li \l{Working with Sidebars}{Sidebars}
\li \l{Managing Workspaces}{Workspaces}
\li \l{Viewing Output}{Output panes}
\endlist
@@ -253,7 +255,7 @@
\contentspage index.html
\page creator-modes.html
\previouspage creator-quick-tour.html
\nextpage creator-sidebar-views.html
\nextpage creator-views.html
\title Selecting Modes
@@ -327,7 +329,7 @@
/*!
\contentspage index.html
\page creator-output-panes.html
\previouspage creator-sidebar-views.html
\previouspage creator-project-managing-workspaces.html
\if defined(qtdesignstudio)
\nextpage creator-using-qt-quick-designer.html
\else

47
doc/qtcreator/src/howto/creator-sidebar-views.qdoc → doc/qtcreator/src/howto/creator-views.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -25,22 +25,18 @@
/*!
\contentspage index.html
\page creator-sidebar-views.html
\page creator-views.html
\previouspage creator-modes.html
\nextpage creator-output-panes.html
\nextpage creator-sidebars.html
\title Browsing Project Contents
A left and right sidebar are available in most \QC \l{Selecting Modes}
{modes}. The availability of the sidebars and their contents depend on
the mode.
You can organize \QC views in \l {Working with Sidebars}{sidebars} or as
\l {Managing Workspaces}{workspaces}, depending on the \l{Selecting Modes}
{mode} you are working in. Only views that are relevant to a mode are
available in it.
In the \uicontrol Edit and \uicontrol Design mode, you can use the sidebars
to browse the project contents.
\image qtcreator-sidebar.png
You can select the contents of the sidebars in the sidebar menu (1):
The following views are related to managing projects and files:
\list
\li \uicontrol Projects shows a list of projects open in the current
@@ -72,28 +68,8 @@
\endlist
\endif
For more information about the sidebar views that are only
available when editing QML files in the Design mode, see
\l{Editing QML Files in Design Mode}.
You can change the view of the sidebars in the following ways:
\list
\li To toggle the left sidebar, click \inlineimage 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 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 splitbutton_horizontal.png
(\uicontrol {Split}). Select new content to view in the split view.
\li To close a sidebar view, click \inlineimage splitbutton_closetop.png
(\uicontrol {Close}).
\endlist
For more information about views that are only available when editing QML
files in the Design mode, see \l{Editing QML Files in Design Mode}.
The additional options in each view are described in the following
sections.
@@ -103,7 +79,8 @@
\section1 Viewing Project Files
The sidebar displays projects in a project tree. The project tree contains
The \uicontrol Projects view displays projects in a project tree. The
project tree contains
a list of all projects open in the current session. For each project, the
tree visualizes the build system structure of the project and lists all
files that are part of the project.

64
doc/qtcreator/src/howto/creator-workspaces.qdoc Normal file
View File

@@ -0,0 +1,64 @@
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator 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.
**
****************************************************************************/
/*!
\contentspage index.html
\previouspage creator-sidebars.html
\page creator-project-managing-workspaces.html
\nextpage creator-output-panes.html
\title Managing Workspaces
In the Design and Debug modes, you can arrange a set of \QC
views as a \e workspace on the screen. For a list of views,
select \uicontrol Window > \uicontrol Views.
In \QMLD, you can select the \uicontrol {Restore last workspace on startup}
check box to save the current workspace as a \e default workspace when you
exit \QC and to restore it the next time you start \QC.
To manage workspaces, select \uicontrol Window > \uicontrol Workspaces >
\uicontrol Manage.
\image qtcreator-workspace-manager.png "Workspace Manager"
To save a workspace under a new name, select \uicontrol Clone.
To delete the selected workspace, select \uicontrol Delete.
To switch between workspaces, select \uicontrol {Switch To}.
To create a new workspace:
\list 1
\li Select \uicontrol New.
\li In the \uicontrol {Enter the name of the workspace} field,
enter a name for the workspace.
\li Select \uicontrol Create to create a new empty workspace or
\uicontrol {Create and Open} to create a workspace and to
switch to it.
\endlist
*/

4
doc/qtcreator/src/overview/creator-only/creator-configuring.qdoc
View File

@@ -1,6 +1,6 @@
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
@@ -31,7 +31,7 @@
/*!
\contentspage index.html
\previouspage creator-quick-tour.html
\previouspage creator-output-panes.html
\page creator-configuring.html
\nextpage creator-build-example-application.html

2
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -38,6 +38,8 @@
\list
\li \l{Selecting Modes}
\li \l{Browsing Project Contents}
\li \l{Working with Sidebars}
\li \l{Managing Workspaces}
\li \l{Viewing Output}
\endlist
\li \l{Configuring Qt Creator}