creator-ui.qdoc 13.3 KB
Newer Older
1
2
3
4
/****************************************************************************
**
** This file is part of Qt Creator
**
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
**
**
** 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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
30
    \nextpage creator-build-example-application.html
31
32
33
34
35
36
37

    \title User Interface

    When you start \QC, it opens to the \gui Welcome mode, where you can:

    \list

38
39
40
        \o  Open recent sessions and projects

        \o  Create and open projects
41
42
43

        \o  Open tutorials and example projects

44
        \o  Read news from the online community and Qt labs
45
46
47
48
49

        \o  Send feedback to the development team

    \endlist

50
    \image qtcreator-breakdown.png
51

52
    You can use the mode selector (1) to change to another \QC mode.
53

54
55
    You can use the kit selector (2) to select the
    \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or
56
57
58
59
60
    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.
61
62
63
64
65
66
67
68
69

    \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}.

70
71
72
73
74
    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"

75
76
77
78
79
80
    You can use \QC in the following modes:

    \list

        \o  \gui Welcome mode for opening projects.

81
        \o  \gui{\l{Coding}{Edit}} mode for editing project and source
82
83
            files.

84
        \o  \gui{\l{Designing User Interfaces}{Design}} mode for designing and
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
            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

114
    You can select the content of the sidebar in the sidebar menu (1):
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

    \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
143
144
            (\gui {Hide Sidebar/Show Sidebar}) or press \key Alt+0
            (\key Cmd+0 on Mac OS X).
145
146

        \o  To split the sidebar, click \inlineimage qtcreator-splitbar.png
147
            (\gui {Split}). Select new content to view in the split view.
148
149
150

        \o  To close a sidebar view, click
            \inlineimage qtcreator-closesidebar.png
151
            (\gui {Close}).
152
153
154
155
156
157
158
159
160
161
162
163

    \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.

Leena Miettinen's avatar
Leena Miettinen committed
164

165
166
167
168
    You can use the project tree in the following ways:

    \list

Leena Miettinen's avatar
Leena Miettinen committed
169
170
171
172
173
        \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}.

174
175
176
177
178
179
180
        \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
181
            (\gui {Filter Tree}) and select \gui{Simplify Tree}.
182
183

        \o  To hide source files which are automatically generated by the build
184
            system, select \gui {Filter Tree > Hide Generated Files}.
185
186
187
188

        \o  To keep the position in the project tree synchronized with the file
            currently opened in the editor, click
            \inlineimage qtcreator-synchronizefocus.png
189
            (\gui {Synchronize with Editor}).
190
191
192
193
194
195
196
197
198
199
200
201

        \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
202
    opened in the editor, select \gui {Synchronize with Editor}.
203
204
205
206
207
208

    \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
209
    (\gui {Show Subprojects}).
210
211
212
213
214
215
216

    \section2 Viewing QML Elements

    The \gui Outline view shows the element hierarchy in a QML file.

    \list

217
218
        \o  To see a complete list of all bindings, select \gui {Filter Tree >
            Show All Bindings}.
219
220

        \o  To keep the position in the view synchronized with the element
221
            selected in the editor, select \gui {Synchronize with Editor}.
222
223
224
225
226
227
228
229
230
231
232
233
234
235

    \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

Leena Miettinen's avatar
Leena Miettinen committed
236
       \o  \gui{Issues}
237
238
239
240
241
242
243

       \o  \gui{Search Results}

       \o  \gui{Application Output}

       \o  \gui{Compile Output}

244
       \o  \gui {To-Do Entries}
245
246
247

       \o  \gui{Version Control}

248
249
       \o  \gui{General Messages}

250
251
252
253
254
255
256
257
258
259
260
    \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.

261
262
    To open the \gui{General Messages} and \l{Using Version Control Systems}
    {Version Control} panes, select
263
264
    \gui {Window > Output Panes}. To display the \gui {To-Do Entries} pane,
    enable the Todo plugin.
265

Leena Miettinen's avatar
Leena Miettinen committed
266
    \section2 Issues
267

Leena Miettinen's avatar
Leena Miettinen committed
268
    The \gui{Issues} pane provides lists of following types of issues:
269

Leena Miettinen's avatar
Leena Miettinen committed
270
    \list
271

Leena Miettinen's avatar
Leena Miettinen committed
272
273
274
275
276
277
278
279
280
281
282
283
284
285
        \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.
286

Leena Miettinen's avatar
Leena Miettinen committed
287
        \o  \gui {QML Analysis} - Results of the JavaScript
Leena Miettinen's avatar
Leena Miettinen committed
288
289
            \l{Checking JavaScript and QML Syntax}
            {code syntax and validation checks}
Leena Miettinen's avatar
Leena Miettinen committed
290
291
292
293
294

    \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
295
    \gui {Filter Tree}
Leena Miettinen's avatar
Leena Miettinen committed
296
297
298
299
300
301
302
    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.
303

Leena Miettinen's avatar
Leena Miettinen committed
304
305
    To jump from one issue to the next or previous one, press \key F6 and
    \key Shift+F6.
306
307
308

    \section2 Search Results

309
310
311
312
313
314
315
    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.
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332

    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

    \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
Leena Miettinen's avatar
Leena Miettinen committed
333
    displayed in the \gui{Issues} pane.
334
335
336

    \image qtcreator-compile-pane.png

337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
    \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}.

360
361
362
363
364
365
366
    \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.

Leena Miettinen's avatar
Leena Miettinen committed
367
368
369
370
371
372
    \section1 Viewing Images

    \QC opens image files in the image viewer.

    \image qtcreator-image-viewer.png "Image viewer"

373
374
    Use the toolbar buttons (1) or \l{Keyboard Shortcuts}{keyboard shortcuts}
    to:
Leena Miettinen's avatar
Leena Miettinen committed
375
376
377
378
379
380
381
382
383
384
385
386
387

    \list

        \o  Switch between background and outline modes

        \o  Zoom in and out

        \o  Fit images to screen

        \o  Return to original size

    \endlist

388
389
390
391
392
    \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
393
    \l{Searching with the Locator}{navigation} shortcuts are available to help
394
395
    speed up the process of developing your application.

396
397
398
399
400
    \section1 Useful Features

    For a list of useful \QC features described in other parts of the
    documentation, see \l{Tips and Tricks}.

401
*/