1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
|
/****************************************************************************
**
** 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.
**
****************************************************************************/
/*!
\page creator-views.html
\previouspage creator-modes.html
\nextpage creator-sidebars.html
\title Browsing Project Contents
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.
The following views are related to managing projects and files:
\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 {Git Branches} shows the local and remote brances for the
project in the Git version control system. For more information, see
\l{Working with Branches}.
\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 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.
In some views, right-clicking opens a context menu that contains functions
for managing the objects listed in the view.
\section1 Viewing Project Files
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.
\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.
\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} >
\uicontrol {Hide Generated Files}.
\li To hide source files which are not enabled for the current target,
select \uicontrol {Filter Tree} > \uicontrol {Hide Disabled Files}.
\li To hide directories that do not contain any files, select
\uicontrol {Filter Tree} > \uicontrol {Hide Empty Directories}.
\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.
\li To move files from one project to another, drag-and-drop them
in the project tree. \QC makes the necessary changes to project
configuration files.
\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}.
\li Rename or remove 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 defined(qtcreator)
\li Remove existing directories from \l{Setting Up a Generic Project}
{generic projects}.
\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 Expand or collapse the tree view to show or hide all files and
folders.
\li Close all files in a project.
\li Close projects. By default, all files in the project are also
closed. To keep them open, deselect the \uicontrol Tools >
\uicontrol Options > \uicontrol {Build & Run} > \uicontrol General
> \uicontrol {Close source files along with project} check box.
\endlist
For managing files and directories, the same functions are available as in
the \uicontrol {File System} view.
\section1 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. To specify the terminal to use on Linux and
\macos, select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment > \uicontrol System.
\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
\section1 Viewing Open Documents
To see a list of open documents, switch to the \uicontrol {Open Documents}
view. You can use the context-menu to perform some of the functions also
available in the \uicontrol File menu and in the context menu in the
\uicontrol {File System} view.
In addition, you can:
\list
\li Copy the full path of the file or just the filename to the
clipboard.
\li Pin files to ensure they stay at the top of the list and are not
closed when \uicontrol {Close All} is used.
\endlist
To specify settings for opening files and handling open files, select
\uicontrol Tools > \uicontrol Options > \uicontrol Environment >
\uicontrol System:
\image qtcreator-options-environment-system.png "Environment options System tab"
\list
\li In the \uicontrol {When files are externally modified} field,
select whether you want to be prompted to reload open files
that were modified externally. For example, when you pull
changes from a version control system.
\li Select the \uicontrol {Auto-save modified files} check box to
automatically save changed files at the intervals specified in
the \uicontrol Interval field.
\li Select the \uicontrol {Auto-suspend unmodified files} check
box to automatically free the resources of open files after
prolonged inactivity. The files are still listed in the
\uicontrol {Open Documents} view. Set the minimum number of files
that should be kept in memory in the \uicontrol {Files to keep open}
field.
\li Select the \uicontrol {Warn before opening text files greater than}
check box to receive warnings about opening big text files.
\li In the \uicontrol {Maximum number of entries in "Recent Files"}
field, set the number of recently opened files listed in
\uicontrol File > \uicontrol {Recent Files}.
\endlist
\section1 Viewing Defined Types and Symbols
The \uicontrol Outline view shows an overview of defined types and other
symbols, as well as their properties and hierarchy in a source 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 type or symbol selected in the
editor, deselect \uicontrol {Synchronize with Editor}.
\endlist
\section1 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.
\section1 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}.
\section1 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}.
To keep the view synchronized with the file currently opened in the editor,
select \uicontrol {Synchronize with Editor}.
*/
|