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

Doc: Use defines to show and hide info about Edit mode

Browse Source 
Move the descriptions of sidebar views to
creator-sidebar-views.qdocinc to be able to include them
in the "Working in Edit Mode" topic in the Qt Design Studio
Manual.

Restructure the section and update the screenshot. A different
screenshot for the Qt Design Studio Manual will be added in
its doc sources.

Change-Id: Icd33c580c040ffefa5563fea723bd02e2d2ce520
Reviewed-by: Thomas Hartmann <thomas.hartmann@qt.io>
This commit is contained in:
Leena Miettinen
2018-08-22 15:45:57 +02:00
parent 9550f3ac95
commit 2dba79df26
7 changed files with 360 additions and 317 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/images/qtcreator-editortoolbar-symbols.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 51 KiB

78
doc/src/cpp/creator-sidebar-cpp-views.qdocinc
View File

@@ -1,78 +0,0 @@
/****************************************************************************
**
** Copyright (C) 2018 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.
**
****************************************************************************/
/*!
//! [cpp sidebar views]
The following views display additional information about C++ code:
\list
\li \uicontrol {Class View} shows the class hierarchy of the currently
open projects.
\li \uicontrol Tests lists autotests and Qt Quick tests in the project.
For more information, see \l {Running Autotests}.
\li \uicontrol {Type Hierarchy} shows the base classes of a class.
\li \uicontrol {Include Hierarchy} shows which files are included in
the current file and which files include the current file.
\endlist
//! [cpp sidebar views]
//! [class view]
\section2 Viewing the Class Hierarchy
The \uicontrol {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png
(\uicontrol {Show Subprojects}).
To visit all parts of a namespace, double-click on the namespace item
multiple times.
//! [class view]
//! [type hierarchy view]
\section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select
\uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
//! [type hierarchy view]
//! [include hierarchy view]
\section2 Viewing Include Hierarchy
To view which files are included in the current file and which files include
the current file, right-click in the editor and select
\uicontrol {Open Include Hierarchy} or press \key {Ctrl+Shift+I}.
//! [include hierarchy view]
*/

46
doc/src/editors/creator-coding-edit-mode.qdoc
View File

@@ -46,7 +46,11 @@
toolbar is context sensitive and shows items relevant to the file currently toolbar is context sensitive and shows items relevant to the file currently
open in the editor. open in the editor.
\if defined(qtcreator)
\image qtcreator-editortoolbar-symbols.png \image qtcreator-editortoolbar-symbols.png
\else
\image studio-edit-mode.png
\endif
Use the toolbar to navigate between open files and symbols in use. To browse Use the toolbar to navigate between open files and symbols in use. To browse
backward or forward through your location history, click backward or forward through your location history, click
@@ -58,36 +62,38 @@
menu (1). Right-click the menu title and select \uicontrol {Copy Full Path} menu (1). Right-click the menu title and select \uicontrol {Copy Full Path}
to copy the path and name of the current file to the clipboard. to copy the path and name of the current file to the clipboard.
Code might be interpreted differently in different contexts. A file can be
used by different projects or subprojects with different defines, or it can
be included in the context of C, C++, Objective-C, or Objective-C++. To
change the active parse context, select an available parse context in the
\uicontrol {Active Parse Context} menu (3). The menu is visible only when
several parse contexts are available. To reset the parse context,
right-click on the menu to open a context menu, and then select
\uicontrol {Clear Preferred Parse Context}.
If the information needed for parsing the project is still incomplete or
incorrect, select \uicontrol {Additional Preprocessor Directives} (2) to
add preprocessor directives.
To jump to any symbol used in the current file, select it from the To jump to any symbol used in the current file, select it from the
\uicontrol Symbols drop-down menu (4). By default, the symbols are displayed \uicontrol Symbols drop-down menu (2). By default, the symbols are displayed
in the order in which they appear in the file. Right-click the menu title in the order in which they appear in the file. Right-click the menu title
and select \uicontrol {Sort Alphabetically} to arrange the symbols in and select \uicontrol {Sort Alphabetically} to arrange the symbols in
alphabetic order. alphabetic order.
To jump to a line and column in the current file, select the line and column To jump to a line and column in the current file, select the line and column
indicator (5) or press \key {Ctrl+L} (or \key {Cmd+L} on \macos) to open the indicator (3) or press \key {Ctrl+L} (or \key {Cmd+L} on \macos) to open the
locator. Enter the line number and column number in the locator, separated locator. Enter the line number and column number in the locator, separated
by a colon (:). by a colon (:).
To show the file encoding of the current file on the editor toolbar (6), \if defined(qtcreator)
Code might be interpreted differently in different contexts. A file can be
used by different projects or subprojects with different defines, or it can
be included in the context of C, C++, Objective-C, or Objective-C++. To
change the active parse context, select an available parse context in the
\uicontrol {Active Parse Context} menu (4). The menu is visible only when
several parse contexts are available. To reset the parse context,
right-click on the menu to open a context menu, and then select
\uicontrol {Clear Preferred Parse Context}.
If the information needed for parsing the project is still incomplete or
incorrect, select \uicontrol {Additional Preprocessor Directives} to
add preprocessor directives.
To show the file encoding of the current file on the editor toolbar (5),
select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} > select \uicontrol Tools > \uicontrol Options > \uicontrol {Text Editor} >
\uicontrol Display > \uicontrol {Display file encoding}. To change the \uicontrol Display > \uicontrol {Display file encoding}. To change the
encoding, click it on the toolbar and select new encoding in the encoding, click it on the toolbar and select new encoding in the
\uicontrol {Text Encoding} dialog. To reload the file with the selected \uicontrol {Text Encoding} dialog. To reload the file with the selected
encoding, select \uicontrol {Reload with Encoding}. To save the file with encoding, select \uicontrol {Reload with Encoding}. To save the file with
the new encoding, select \uicontrol {Save with Encoding}. the new encoding, select \uicontrol {Save with Encoding}.
\endif
\note Other convenient ways of navigating in \QC are provided by the \note Other convenient ways of navigating in \QC are provided by the
\l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts} \l{Searching with the Locator}{locator}, \l{Keyboard Shortcuts}
@@ -139,6 +145,7 @@
split view, select \uicontrol Window > \uicontrol {Remove All Splits} or split view, select \uicontrol Window > \uicontrol {Remove All Splits} or
press \key {Ctrl+E, 1}. press \key {Ctrl+E, 1}.
\if defined(qtcreator)
\section1 Using Bookmarks \section1 Using Bookmarks
To insert or delete a bookmark: To insert or delete a bookmark:
@@ -173,6 +180,7 @@
\image qtcreator-bookmarks-view.png \image qtcreator-bookmarks-view.png
\section1 Moving to Symbol Definition or Declaration \section1 Moving to Symbol Definition or Declaration
You can move directly to the definition or the declaration of a symbol by You can move directly to the definition or the declaration of a symbol by
@@ -230,4 +238,12 @@
\QC underlines semantic errors in olive in the C++ code editor. To check the \QC underlines semantic errors in olive in the C++ code editor. To check the
correct paths for includes that are not resolved or that are resolved to the correct paths for includes that are not resolved or that are resolved to the
wrong file, select \uicontrol {Project Parts} > \uicontrol {Header Paths}. wrong file, select \uicontrol {Project Parts} > \uicontrol {Header Paths}.
\endif
\if defined(qtdesignstudio)
\include creator-sidebar-views.qdocinc using sidebar views
\include creator-sidebar-views.qdocinc projects view
\include creator-sidebar-views.qdocinc file system view
\include creator-sidebar-views.qdocinc outline view
\endif
*/ */

8
doc/src/editors/creator-coding.qdoc
View File

@@ -34,7 +34,6 @@
\page creator-coding.html \page creator-coding.html
\if defined(qtdesignstudio) \if defined(qtdesignstudio)
\previouspage creator-keyboard-shortcuts.html \previouspage creator-keyboard-shortcuts.html
\nextpage
\else \else
\previouspage creator-usability.html \previouspage creator-usability.html
\endif \endif
@@ -67,20 +66,25 @@
can easily find and rename symbols and apply predefined actions to can easily find and rename symbols and apply predefined actions to
refactor code. refactor code.
\if defined(qtcreator)
\li \l{Beautifying Source Code} \li \l{Beautifying Source Code}
Beautifying code means applying indentation and style to source Beautifying code means applying indentation and style to source
code files. You can use the Artistic Style, ClangFormat, or code files. You can use the Artistic Style, ClangFormat, or
Uncrustify tool to format source files. Uncrustify tool to format source files.
\endif
\li \l{Configuring the Editor} \li \l{Configuring the Editor}
You can change the fonts, colors, highlighting, and indentation. You can change the fonts, colors, highlighting, and indentation.
\if defined(qtcreator)
If you are used to the Vim editor, you can even run the main If you are used to the Vim editor, you can even run the main
editor in a manner similar to it in the \uicontrol{FakeVim} mode. editor in a manner similar to it in the \uicontrol{FakeVim} mode.
\endif
\endlist \endlist
\if defined(qtcreator)
\section1 Related Topics \section1 Related Topics
\list \list
@@ -107,5 +111,5 @@
in Qt applications. in Qt applications.
\endlist \endlist
\endif
*/ */

4
doc/src/editors/creator-editors-writing-code.qdoc
View File

@@ -84,6 +84,7 @@
few people can visualize the color \c {#18793f}. To easily edit few people can visualize the color \c {#18793f}. To easily edit
these properties, you can use the Qt Quick Toolbars. these properties, you can use the Qt Quick Toolbars.
\if defined(qtcreator)
\li \l{Pasting and Fetching Code Snippets} \li \l{Pasting and Fetching Code Snippets}
You can cooperate with other developers by pasting and fetching You can cooperate with other developers by pasting and fetching
@@ -97,6 +98,7 @@
keyboard sequence as a macro. You can then play the macro to keyboard sequence as a macro. You can then play the macro to
repeat the sequence. You can save the latest macro and assign a repeat the sequence. You can save the latest macro and assign a
keyboard shortcut for running it or run it from the locator. keyboard shortcut for running it or run it from the locator.
\endif
\endlist \endlist
@@ -109,12 +111,14 @@
You can use a diff editor to compare two versions of a file and You can use a diff editor to compare two versions of a file and
view the differences side-by-side in the \uicontrol Edit mode. view the differences side-by-side in the \uicontrol Edit mode.
\if defined(qtcreator)
\li \l{Parsing C++ Files with the Clang Code Model} \li \l{Parsing C++ Files with the Clang Code Model}
The Clang code model provides some of the services previously The Clang code model provides some of the services previously
provided by the built-in C/C++ code model, such as code provided by the built-in C/C++ code model, such as code
completion, syntactic and semantic highlighting, diagnostics, completion, syntactic and semantic highlighting, diagnostics,
tooltips, outline of symbols, and renaming of local symbols. tooltips, outline of symbols, and renaming of local symbols.
\endif
\endlist \endlist

229
doc/src/howto/creator-only/creator-ui.qdoc
View File

@@ -112,228 +112,13 @@
\uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to
\uicontrol {Debug} mode. \uicontrol {Debug} mode.
\section1 Browsing Project Contents \include creator-sidebar-views.qdocinc using sidebar views
\include creator-sidebar-views.qdocinc projects view
A left and right sidebar are available in most \QC modes. The availability \include creator-sidebar-views.qdocinc file system view
of the sidebars and their contents depend on the mode. \include creator-sidebar-views.qdocinc outline view
\include creator-sidebar-views.qdocinc class view
In the \uicontrol Edit mode, you can use the sidebars to browse projects, \include creator-sidebar-views.qdocinc type hierarchy view
files, and bookmarks, and to view the class hierarchy. \include creator-sidebar-views.qdocinc include hierarchy view
\image qtcreator-sidebar.png
You can select the contents of the sidebars in the sidebar menu (1):
\list
\li \uicontrol Projects shows a list of projects open in the current
session and the project files needed by the build system.
\li \uicontrol{Open Documents} shows currently open files.
\li \uicontrol Bookmarks shows all bookmarks for the current session.
\li \uicontrol{File System} shows all files in the currently selected
directory.
\li \uicontrol Outline shows an overview of defined types and other
symbols, as well as their properties and hierarchy in a source file.
\endlist
\include creator-sidebar-cpp-views.qdocinc cpp sidebar views
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
The additional options in each view are described in the following
sections.
In some views, right-clicking opens a context menu that contains functions
for managing the objects listed in the view.
\section2 Viewing Project Files
The sidebar 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.
Some build systems support adding and removing files to a project in \QC
(currently qmake and Qbs). The faithful display of the project structure
allows to specify exactly where a new file should be placed in the build
system.
If the project is under version control, information from the version control system
might be displayed in brackets after the project name. This is currently implemented for
Git (the branch name or a tag is displayed) and ClearCase (the view name is displayed).
You can use the project tree in the following ways:
\list
\li To open files that belong to a 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
and image files in the \l{Viewing Images}{image viewer}.
\li To bring up a context menu containing 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,
build, re-build, clean and run the project.
\li To hide the categories and sort project files alphabetically, click
\inlineimage filtericon.png
(\uicontrol {Filter Tree}) and select \uicontrol{Simplify Tree}.
\li To hide source files which are automatically generated by the build
system, select \uicontrol {Filter Tree > Hide Generated Files}.
\li To stop synchronizing the position in the project tree with the file
currently opened in the editor, deselect \inlineimage linkicon.png
(\uicontrol {Synchronize with Editor}). You can specify a keyboard
shortcut to use when synchronization is needed. Select
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol Keyboard, and then search for
\uicontrol {Show in Explorer}.
\li To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
Files that are not sources or data can be still included into a project's
distribution tarball by adding their paths to the \c DISTFILES variable in
the .pro file. This way they also become known to \QC, so that they are
visible in the \uicontrol Projects view and are known to the locator and search.
The \uicontrol Projects view contains context menus for managing projects,
subprojects, folders, and files. The following functions are available for
managing projects and subprojects:
\list
\li Set a project as the active project.
\li Execute the \uicontrol Build menu commands.
\li Add subprojects, libraries, directories, and files.
\li Remove subprojects.
\li Search from the selected directory.
\li Close projects.
\endlist
For managing files and directories, the same functions are available as in
the \uicontrol {File System} view. In addition, you can remove and rename
files.
\section2 Viewing the File System
If you cannot see a file in the \uicontrol Projects view, switch to the
\uicontrol {File System} view, which shows all the files in the file system.
\image qtcreator-filesystem-view.png
By default, the contents of the directory that contains the file currently
active in the editor are displayed. To stop the synchronization, delesect
the \uicontrol {Synchronize Root Directory with Editor} button.
The path to the active file is displayed
as bread crumbs. You can move to any directory along the path by clicking
it. To hide the bread crumbs, select \inlineimage filtericon.png
(\uicontrol Options) and then deselect the \uicontrol {Show Bread Crumbs}
check box.
To move to the root directory of the
file system, select \uicontrol Computer in the menu (1). Select
\uicontrol Home to move to the user's home directory. Further, you can
select a project to move to an open project or \uicontrol Projects to open
the \uicontrol Projects view.
By default, folders are separated from files and listed first in the view.
To list all items in alphabetic order, select \uicontrol Options and then
deselect the \uicontrol {Show Folders on Top} check box.
To also show hidden files, select \uicontrol Options >
\uicontrol {Show Hidden Files}.
To stop the synchronization with the file currently opened in the editor,
deselect \uicontrol {Synchronize with Editor}.
Use the context menu functions to:
\list
\li Open files with the default editor or some other editor.
\li Open a project located in the selected directory.
\li Show the file or directory in the file explorer.
\li Open a terminal window in the selected directory or in the directory
that contains the file.
\li Search from the selected directory.
\li View file properties, such as MIME type, default editor, and size.
\li Create new files. For more information, see
\l{Adding Files to Projects}.
\li Rename or remove existing files.
\li Create new folders.
\li Compare the selected file with the currently open file in the diff
editor. For more information, see \l{Comparing Files}.
\li Display the contents of a particular directory in the view.
\li Collapse all open folders.
\endlist
\section2 Viewing QML Types
The \uicontrol Outline view shows the type hierarchy in a QML file.
\list
\li To see a complete list of all bindings, select \uicontrol {Filter Tree >
Show All Bindings}.
\li To stop the synchronization with the QML type selected in the
editor, deselect \uicontrol {Synchronize with Editor}.
\endlist
\include creator-sidebar-cpp-views.qdocinc class view
\include creator-sidebar-cpp-views.qdocinc type hierarchy view
\include creator-sidebar-cpp-views.qdocinc include hierarchy view
\section1 Viewing Output \section1 Viewing Output

312
doc/src/howto/creator-sidebar-views.qdocinc Normal file
View File

@@ -0,0 +1,312 @@
/****************************************************************************
**
** Copyright (C) 2018 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.
**
****************************************************************************/
/*!
//! [using sidebar views]
\section1 Browsing Project Contents
A left and right sidebar are available in most \QC modes. The availability
of the sidebars and their contents depend on the mode.
In the \uicontrol Edit 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):
\list
\li \uicontrol Projects shows a list of projects open in the current
session and the project files needed by the build system.
\li \uicontrol{Open Documents} shows currently open files.
\if defined(qtcreator)
\li \uicontrol Bookmarks shows all bookmarks for the current session.
\endif
\li \uicontrol{File System} shows all files in the currently selected
directory.
\li \uicontrol Outline shows an overview of defined types and other
symbols, as well as their properties and hierarchy in a source file.
\endlist
\if defined(qtcreator)
The following views display additional information about C++ code:
\list
\li \uicontrol {Class View} shows the class hierarchy of the currently
open projects.
\li \uicontrol Tests lists autotests and Qt Quick tests in the project.
For more information, see \l {Running Autotests}.
\li \uicontrol {Type Hierarchy} shows the base classes of a class.
\li \uicontrol {Include Hierarchy} shows which files are included in
the current file and which files include the current file.
\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
The additional options in each view are described in the following
sections.
In some views, right-clicking opens a context menu that contains functions
for managing the objects listed in the view.
//! [using sidebar views]
//! [projects view]
\section2 Viewing Project Files
The sidebar 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.
\if defined(qtcreator)
Some build systems support adding and removing files to a project in \QC
(currently qmake and Qbs). The faithful display of the project structure
allows to specify exactly where a new file should be placed in the build
system.
\endif
\if defined(qtcreator)
If the project is under version control, information from the version
control system might be displayed in brackets after the project name.
This is currently implemented for Git (the branch name or a tag is
displayed) and ClearCase (the view name is displayed).
\else
If the project is under Git version control, the currently checked out
branch or tag is displayed in brackets after the project name.
\endif
You can use the project tree in the following ways:
\list
\li To open files that belong to a 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
and image files in the \l{Viewing Images}{image viewer}.
\li To bring up a context menu containing 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 hide the categories and sort project files alphabetically, click
\inlineimage filtericon.png
(\uicontrol {Filter Tree}) and select \uicontrol{Simplify Tree}.
\li To hide source files which are automatically generated by the build
system, select \uicontrol {Filter Tree > Hide Generated Files}.
\li To stop synchronizing the position in the project tree with the file
currently opened in the editor, deselect \inlineimage linkicon.png
(\uicontrol {Synchronize with Editor}). You can specify a keyboard
shortcut to use when synchronization is needed. Select
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol Keyboard, and then search for
\uicontrol {Show in Explorer}.
\li To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
\if defined(qtcreator)
Files that are not sources or data can be still included into a project's
distribution tarball by adding their paths to the \c DISTFILES variable in
the .pro file. This way they also become known to \QC, so that they are
visible in the \uicontrol Projects view and are known to the locator and
search.
\endif
The \uicontrol Projects view contains context menus for managing projects,
subprojects, folders, and files. The following functions are available for
managing projects and subprojects:
\list
\li Set a project as the active project.
\li Execute the \uicontrol Build menu commands.
\li Create new files. For more information, see
\l{Adding Files to Projects}.
\if defined(qtcreator)
\li Add existing files and directories.
\li Add libraries. For more information, see
\l{Adding Libraries to Projects}.
\li Add and remove subprojects.
\endif
\li Search from the selected directory.
\li Close projects.
\endlist
For managing files and directories, the same functions are available as in
the \uicontrol {File System} view. In addition, you can remove and rename
files.
//! [projects view]
//! [file system view]
\section2 Viewing the File System
If you cannot see a file in the \uicontrol Projects view, switch to the
\uicontrol {File System} view, which shows all the files in the file system.
\image qtcreator-filesystem-view.png
By default, the contents of the directory that contains the file currently
active in the editor are displayed. To stop the synchronization, delesect
the \uicontrol {Synchronize Root Directory with Editor} button.
The path to the active file is displayed
as bread crumbs. You can move to any directory along the path by clicking
it. To hide the bread crumbs, select \inlineimage filtericon.png
(\uicontrol Options) and then deselect the \uicontrol {Show Bread Crumbs}
check box.
To move to the root directory of the
file system, select \uicontrol Computer in the menu (1). Select
\uicontrol Home to move to the user's home directory. Further, you can
select a project to move to an open project or \uicontrol Projects to open
the \uicontrol Projects view.
By default, folders are separated from files and listed first in the view.
To list all items in alphabetic order, select \uicontrol Options and then
deselect the \uicontrol {Show Folders on Top} check box.
To also show hidden files, select \uicontrol Options >
\uicontrol {Show Hidden Files}.
To stop the synchronization with the file currently opened in the editor,
deselect \uicontrol {Synchronize with Editor}.
Use the context menu functions to:
\list
\li Open files with the default editor or some other editor.
\li Open a project located in the selected directory.
\li Show the file or directory in the file explorer.
\li Open a terminal window in the selected directory or in the directory
that contains the file.
\li Search from the selected directory.
\li View file properties, such as MIME type, default editor, and size.
\li Create new files. For more information, see
\l{Adding Files to Projects}.
\li Rename or remove existing files.
\li Create new folders.
\li Compare the selected file with the currently open file in the diff
editor. For more information, see \l{Comparing Files}.
\li Display the contents of a particular directory in the view.
\li Collapse all open folders.
\endlist
//! [file system view]
//! [outline view]
\section2 Viewing QML Types
The \uicontrol Outline view shows the type hierarchy in a QML file.
\list
\li To see a complete list of all bindings, select
\uicontrol {Filter Tree} > \uicontrol {Show All Bindings}.
\li To stop the synchronization with the QML type selected in the
editor, deselect \uicontrol {Synchronize with Editor}.
\endlist
//! [outline view]
//! [class view]
\section2 Viewing the Class Hierarchy
The \uicontrol {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png
(\uicontrol {Show Subprojects}).
To visit all parts of a namespace, double-click on the namespace item
multiple times.
//! [class view]
//! [type hierarchy view]
\section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select
\uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
//! [type hierarchy view]
//! [include hierarchy view]
\section2 Viewing Include Hierarchy
To view which files are included in the current file and which files include
the current file, right-click in the editor and select
\uicontrol {Open Include Hierarchy} or press \key {Ctrl+Shift+I}.
//! [include hierarchy view]
*/