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

Doc: Update Design Views documents

Browse Source 
- Update images, icons, and text.
- Remove summary and context menu topics.
- Reorganize the design views alphabetically in TOC.

Fixes: QDS-12363
Change-Id: I3ddb659ec872ebc554c5e7fbbf7cb31d7ebd9b05
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
This commit is contained in:
Teea Poldsam
2024-04-03 14:57:04 +03:00
committed by Teea Põldsam
parent 7db0c8f742
commit 94b08f3f1d
87 changed files with 211 additions and 948 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/qtcreator/src/user-interface/creator-file-system-view.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2023 The Qt Company Ltd.
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -15,7 +15,11 @@
\title File System
\if defined(qtdesignstudio)
\brief View all the files in the current directory.
\else
\brief Shows all the files in the current directory.
\endif
\if defined(qtcreator)
\note Usually, \l{Navigate with locator}{searching with the locator}
@@ -25,7 +29,7 @@
\image qtcreator-filesystem-view.webp {File System view in the sidebar}
\else
\image qtcreator-filesystem-view-design.png {File System view}
\image filesystem-view-design.webp {File System view}
\endif
To move to the root directory of the file system, select \uicontrol Computer
@@ -52,6 +56,7 @@
The view displays the path to the active file as bread crumbs. You can move
to any directory along the path by clicking it.
\if defined(qtcreator)
\section1 File System Context Menu
Use the context menu functions to:
@@ -64,34 +69,24 @@
that has the file. To specify the terminal to use on Linux and
\macos, select \preferences > \uicontrol Environment >
\uicontrol System.
\if defined(qtcreator)
To use an \l{Terminal} {internal terminal}, select \preferences >
\uicontrol Terminal > \uicontrol {Use internal terminal}.
\endif
\li Search in the selected directory.
\li View file properties, such as name, path, MIME type, default editor,
line endings, indentation, owner, size, last read and modified
dates, and permissions.
\li Create new files. For more information, see
\if defined(qtdesignstudio)
\l{Adding Files to Projects}.
\else
\l{Create files}.
\endif
\li Create new files. For more information, see {Create files}.
\li Rename existing files. To move the file to another directory, enter
the relative or absolute path to its new location in addition to the
new filename.
\li Remove existing files.
\li Create new folders.
\if defined(qtcreator)
\li Compare the selected file with the currently open file in the diff
editor. For more information, see \l{Compare files}.
\endif
\li Display the contents of a particular directory in the view.
\li Collapse all open folders.
\endlist
\if defined(qtcreator)
\section1 File System View Toolbar
The toolbar in the \uicontrol {File System} view has additional

19
doc/qtcreator/src/user-interface/creator-open-documents-view.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2023 The Qt Company Ltd.
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -16,13 +16,26 @@
\title Open Documents
\if defined(qtdesignstudio)
\brief View currently open files.
\else
\brief Shows currently open files.
\endif
\if defined(qtdesignstudio)
\image open-documents-view.webp {Open Documents view}
\else
\image qtcreator-open-documents-view.png {Open Documents view}
\endif
You can use the context menu to apply some of the functions also available
in the \uicontrol File menu and in the \l {File System Context Menu}
{File System} view to the file that you select in the view.
in the \uicontrol File menu and in the
\if defined(qtcreator)
\l {File System Context Menu}{File System}
\else
\uicontrol {File System}
\endif
view to the file that you select in the view.
In addition, you can:

29
doc/qtcreator/src/user-interface/creator-projects-view.qdoc
View File

@@ -1,4 +1,4 @@
// Copyright (C) 2023 The Qt Company Ltd.
// Copyright (C) 2024 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
@@ -15,7 +15,11 @@
\title Projects
\if defined(qtdesignstudio)
\brief View a list of the files contained within the open project.
\else
\brief Shows a list of projects in a project tree.
\endif
\if defined(qtcreator)
The project tree has a list of all projects open in the current
@@ -29,7 +33,7 @@
is the fastest way to find a particular project, file, class, or function,
or almost anything else in your project.
\else
\image qtcreator-projects-view-design.png {Projects view}
\image projects-view-design.webp {Projects view}
\endif
You can use the project tree in the following ways:
@@ -43,14 +47,19 @@
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 open a
\if defined(qtcreator)
\l{Projects View Context Menu}{context menu}
\else
context menu
\endif
that has the actions most commonly needed, right-click an
item in the project tree. For example, through the menu of
the project root directory you can, among other actions, run
and close the project.
\li To see the absolute path of a file, move the mouse pointer over the
file name.
\li To move files from one project to another, drag-and-drop them
\li To move files from one project to another, drag them
in the project tree. \QC makes the necessary changes to project
configuration files.
\endlist
@@ -58,6 +67,7 @@
\note If you cannot see a file in the \l Projects view, switch to the
\uicontrol {File System} view, which shows all the files in the file system.
\if defined(qtcreator)
\section1 Projects View Context Menu
The \uicontrol Projects view has context menus for managing projects,
@@ -65,22 +75,15 @@
projects and subprojects:
\list
\if defined(qtcreator)
\li Set a project as the active project.
\endif
\li Execute \uicontrol Build menu commands.
\li Create new files. For more information, see
\if defined(qtdesignstudio)
\l{Adding Files to Projects}.
\else
\l{Create files}.
\endif
\li Rename existing files. If you change the base name of a
file, \QC displays a list of other files with the same base name
and offers to rename them as well. If you rename a UI file (.ui),
\QC also changes corresponding include statements accordingly.
\li Remove existing files.
\if defined(qtcreator)
\li Remove existing directories from \l{Import an existing project}
{generic projects}.
\li Add existing files and directories.
@@ -88,16 +91,13 @@
\l{Add libraries to qmake projects}.
\li Add and remove subprojects.
\li Find unused functions.
\endif
\li Search in the selected directory.
\li Open a terminal window in the project directory. To specify the
terminal to use on Linux and \macos, select \preferences >
\uicontrol Environment > \uicontrol System.
\if defined(qtcreator)
To use an \l{Terminal}{internal terminal}, select \preferences >
\uicontrol Terminal > \uicontrol {Use internal terminal}.
\endif
\li Open a terminal window in the project directory that you configured
for building or running the project.
\li Expand or collapse the tree view to show or hide all files and
@@ -114,7 +114,6 @@
the \l {File System} view. To view a project in it, select
\uicontrol {Show in File System View}.
\if defined(qtcreator)
\section1 Projects View Toolbar
The toolbar in the \uicontrol Projects view has additional options.