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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
|
/****************************************************************************
**
** Copyright (c) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator
**
**
** GNU Free Documentation License
**
** 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.
**
**
****************************************************************************/
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\contentspage index.html
\previouspage creator-overview.html
\page creator-quick-tour.html
\nextpage creator-build-example-application.html
\title User Interface
When you start \QC, it opens to the \gui Welcome mode, where you can:
\list
\o Open recent sessions and projects
\o Create and open projects
\o Open tutorials and example projects
\o Read news from the online community and Qt labs
\o Send feedback to the development team
\endlist
\image qtcreator-breakdown.png
You can use the mode selector (1) to change to another \QC mode.
You can use the kit selector (2) to select the
\l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or
building (5) the application. Output from these actions is displayed in the
output panes (7).
You can use the locator (6) to to browse through projects, files, classes,
methods, documentation, and file systems.
\section1 Modes
The mode selector allows you to quickly switch between tasks such as editing
project and source files, designing application UIs, configuring how
projects are built and executed, and debugging your applications. To change
modes, click the icons, or use the \l{keyboard-shortcuts}
{corresponding keyboard shortcut}.
The following image displays an example application in \gui Edit mode (1)
and \gui Design mode (2).
\image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
You can use \QC in the following modes:
\list
\o \gui Welcome mode for opening projects.
\o \gui{\l{Coding}{Edit}} mode for editing project and source
files.
\o \gui{\l{Designing User Interfaces}{Design}} mode for designing and
developing application user interfaces. This mode is available for
UI files.
\o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
application while debugging.
\o \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
project building and execution. This mode is available when a
project is open.
\o \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
to detect memory leaks and profile C++ or QML code.
\o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
\endlist
Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} >
\gui {Start Debugging} > \gui {Start Debugging} automatically switches to
\gui {Debug} mode.
\section1 Browsing Project Contents
The sidebar is available in the \gui Edit and \gui Debug modes. Use the
sidebar to browse projects, files, and bookmarks, and to view the class
hierarchy.
\image qtcreator-sidebar.png
You can select the content of the sidebar in the sidebar menu (1):
\list
\o \gui Projects shows a list of projects open in the current
session.
\o \gui{Open Documents} shows currently open files.
\o \gui Bookmarks shows all bookmarks for the current session.
\o \gui{File System} shows all files in the currently selected
directory.
\o \gui {Class View} shows the class hierarchy of the currently
open projects.
\o \gui Outline shows the symbol hierachy of a C++ file and the element
hierarchy of a QML file.
\o \gui {Type Hierarchy} shows the base classes of a class.
\endlist
You can change the view of the sidebar in the following ways:
\list
\o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
(\gui {Hide Sidebar/Show Sidebar}) or press \key Alt+0
(\key Cmd+0 on Mac OS X).
\o To split the sidebar, click \inlineimage qtcreator-splitbar.png
(\gui {Split}). Select new content to view in the split view.
\o To close a sidebar view, click
\inlineimage qtcreator-closesidebar.png
(\gui {Close}).
\endlist
The additional options in each view are described in the following
sections.
\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. The files for each
project are grouped according to their file type.
You can use the project tree in the following ways:
\list
\o 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}.
\o 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.
\o To hide the categories and sort project files alphabetically, click
\inlineimage qtcreator-filter.png
(\gui {Filter Tree}) and select \gui{Simplify Tree}.
\o To hide source files which are automatically generated by the build
system, select \gui {Filter Tree > Hide Generated Files}.
\o To keep the position in the project tree synchronized with the file
currently opened in the editor, click
\inlineimage qtcreator-synchronizefocus.png
(\gui {Synchronize with Editor}).
\o To see the absolute path of a file, move the mouse pointer over the
file name.
\endlist
\section2 Viewing the File System
If you cannot see a file in the \gui Projects view, switch to the
\gui {File System} view, which shows all the files in the file system.
To keep the position in the tree synchronized with the file
opened in the editor, select \gui {Synchronize with Editor}.
\section2 Viewing the Class Hierarchy
The \gui {Class View} shows the class hierarchy of the currently
open projects. To organize the view by subprojects, click
\inlineimage qtcreator-show-subprojects.png
(\gui {Show Subprojects}).
\section2 Viewing QML Elements
The \gui Outline view shows the element hierarchy in a QML file.
\list
\o To see a complete list of all bindings, select \gui {Filter Tree >
Show All Bindings}.
\o To keep the position in the view synchronized with the element
selected in the editor, select \gui {Synchronize with Editor}.
\endlist
\section2 Viewing Type Hierarchy
To view the base classes of a class, right-click the class and select
\gui {Open Type Hierarchy} or press \key {Ctrl+Shift+T}.
\section1 Viewing Output
The task pane in \QC can display one of the following panes:
\list
\o \gui{Issues}
\o \gui{Search Results}
\o \gui{Application Output}
\o \gui{Compile Output}
\o \gui {To-Do Entries}
\o \gui{Version Control}
\o \gui{General Messages}
\endlist
Output panes are available in all \l{Modes}{modes}. Click the name of an
output pane to open the pane. To maximize an open output pane, click the
\gui {Maximize Output Pane} button or press \key {Alt+9}.
To search within the \gui{Application Output} and \gui{Compile Output}
panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in
the \gui Find field and click the left and right arrows to search down and
up in the pane.
To open the \gui{General Messages} and \l{Using Version Control Systems}
{Version Control} panes, select
\gui {Window > Output Panes}. To display the \gui {To-Do Entries} pane,
enable the Todo plugin.
\section2 Issues
The \gui{Issues} pane provides lists of following types of issues:
\list
\o \gui Analyzer - Errors encountered while running the
\l{Analyzing Code}{Valgrind code analysis tools}.
\o \gui {Build System} - Errors and warnings encountered during a
build.
\o \gui Compile - Selected output from the compiler. Open the
\gui {Compile Output} pane for more detailed information.
\o \gui {My Tasks} - Entries from a task list file (.tasks) generated
by \l{Showing Task List Files in Issues Pane}
{code scanning and analysis tools}.
\o \gui QML - Errors in QML syntax.
\o \gui {QML Analysis} - Results of the JavaScript
\l{Checking JavaScript and QML Syntax}
{code syntax and validation checks}
\endlist
The pane filters out irrelevant output from the build tools and presents the
issues in an organized way. To further filter the output by type, select
\gui {Filter Tree}
and then select a filter.
\image qtcreator-build-issues.png
Right-clicking on a line brings up a context menu with options to copy
the contents and to show a version control annotation view of the line
that causes the error message.
To jump from one issue to the next or previous one, press \key F6 and
\key Shift+F6.
\section2 Search Results
In the \gui{Search Results} pane, you can search through projects, files on
a file system or the currently open file:
\image qtcreator-search-results.png "Search Results output pane"
The search results are stored in the search history (1) from which you can
select earlier searches.
The figure below shows an example search result for all
occurrences of \c textfinder within the \c "/TextFinder" directory.
\image qtcreator-search-pane.png
\section2 Application Output
The \gui{Application Output} pane displays the status of a program when
it is executed, and the debug output.
\image qtcreator-application-output.png
Select toolbar buttons to run applications, to attach the debugger to the
running application, and to stop running or debugging.
\section2 Compile Output
The \gui{Compile Output} pane provides all output from the compiler.
The \gui{Compile Output} is a more detailed version of information
displayed in the \gui{Issues} pane.
\image qtcreator-compile-pane.png
Double-click on a file name in an error message to open the file in the
code editor.
Select the \gui {Cancel Build} button to cancel the build.
\section2 To-Do List
The \gui {To-Do List Entries} pane lists the BUG, FIXME, NOTE, TODO, and
WARNING keywords from the current file or from all project files. The
keywords are organized into information, warning, and error categories.
\image qtcreator-todo-pane.png
To add keywords, select \gui Tools > \gui Options > \gui {To-Do} > \gui Add.
Set an icon and a line background color for the keyword. To change the icons
and colors set for an existing keyword, select \gui Edit.
To determine whether the keywords in the whole project or in the current
file are displayed by default, select \gui {Scanning scope}.
The Todo plugin is disabled by default. To enable the plugin, select
\gui Help > \gui {About Plugins} > \gui Utilities > \gui Todo and restart
\QC.
In addition, you can open task list files generated by code scanning and
analysis tools in the \gui Issues pane. For more information, see
\l{Showing Task List Files in Issues Pane}.
\section1 Changing Languages
\QC has been localized into several languages. If the system language is one
of the supported languages, it is automatically selected. To change the
language, select \gui {Tools > Options > Environment} and select a language
in the \gui Language field. The change takes effect after you restart \QC.
\section1 Viewing Images
\QC opens image files in the image viewer.
\image qtcreator-image-viewer.png "Image viewer"
Use the toolbar buttons (1) or \l{Keyboard Shortcuts}{keyboard shortcuts}
to:
\list
\o Switch between background and outline modes
\o Zoom in and out
\o Fit images to screen
\o Return to original size
\o Play and pause animated GIF and MNG images
\endlist
\section1 Navigating with Keyboard
\QC caters not only to developers who are used to using the mouse,
but also to developers who are more comfortable with the keyboard. A wide
range of \l{keyboard-shortcuts}{keyboard} and
\l{Searching with the Locator}{navigation} shortcuts are available to help
speed up the process of developing your application.
\section1 Useful Features
For a list of useful \QC features described in other parts of the
documentation, see \l{Tips and Tricks}.
*/
|
