qtcreator.qdoc 254 KB
Newer Older
1
2
3
4
5
6
// **********************************************************************
// 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.
// **********************************************************************

7

con's avatar
con committed
8
9
10
/*!
    \contentspage{index.html}{Qt Creator}
    \page index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
11
    \nextpage creator-overview.html
con's avatar
con committed
12
13
14

    \title Qt Creator Manual

hjk's avatar
hjk committed
15
    \section1 Version 2.0.1 (Draft)
con's avatar
con committed
16

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
17
    Qt Creator provides a cross-platform, complete integrated development
18
19
    environment (IDE) for application developers to create applications for
    multiple desktop and mobile device platforms. It is available for Linux,
20
    Mac OS X and Windows operating systems. For more information, see
21
    \l{Operating Systems and Supported Platforms}.
con's avatar
con committed
22

23
    \note Please report bugs and suggestions to the
con's avatar
con committed
24
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
25
26
27
    You can also join the Qt Creator mailing list. To subscribe,
    send a message with the word \e subscribe to
    \l{mailto:qt-creator-request@trolltech.com}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
28
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
29
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed
30

31
32
    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
33
    \endraw
34

con's avatar
con committed
35
    \list
Leena Miettinen's avatar
Leena Miettinen committed
36
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
37
       \o \l{Operating Systems and Supported Platforms}
38
       \o \l{Qt Creator User Interface}
39
40
       \o \l{Getting Started}
           \list
41
               \o \l{Building and Running an Example Application}
42
               \o \l{Creating a Qt C++ Application}
43
               \o \l{Creating a Mobile Application with Nokia Qt SDK}
44
               \if defined(qtquick)
45
               \o \l{Creating a Qt Quick Application}
Kai Koehne's avatar
Kai Koehne committed
46
               \endif
47
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
48
49
50
51
52
53
       \o \l{Managing Projects}
            \list
                \o \l{Creating a Project}
                \o \l{Setting Up a qmake Project}
                \o \l{Setting Up a CMake Project}
                \o \l{Setting Up a Generic Project}
Leena Miettinen's avatar
Leena Miettinen committed
54
55
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
56
57
                \o \l{Managing Sessions}
            \endlist
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
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
                \o \l{Searching With the Locator}
                \o \l{Pasting and Fetching Code Snippets}
                \o \l{Configuring the Editor}
                \o \l{Using FakeVim Mode}
                \o \l{Using an External Editor}
            \endlist
       \o \l{Developing Application UI}
       \list
           \o \l{Optimizing Applications for Mobile Devices}
           \o \l{Adding Qt Designer Plugins}
           \if defined(qtquick)
           \o \l{Developing Qt Quick Applications}
                \list
                    \o \l {Creating Qt Quick Projects}
                    \o \l {Creating Components}
                    \o \l {Creating Screens}
                    \o \l {Animating Screens}
                    \o \l {Adding User Interaction Methods}
                    \o \l {Implementing Application Logic}
                \endlist
           \endif
       \endlist
84
85
86
87
88
89
90
91
       \o \l{Building and Running Applications}
            \list
                \o \l{Building for Multiple Targets}
                \o \l{Specifying Build Settings}
                \o \l{Specifying Run Settings}
                \o \l{Specifying Editor Settings}
                \o \l{Specifying Dependencies}
            \endlist
92

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
93
       \o \l{Debugging}
94
95
96
97
98
99
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
            \endlist
100
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
101
       \o \l{Using Version Control Systems}
102
103

       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
104
105
106
107
108
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
109
110
111
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
112

con's avatar
con committed
113
114
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
115
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
116
117
118
119
120
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

Leena Miettinen's avatar
Leena Miettinen committed
121
122
123
    Qt Creator is an integrated development environment (IDE) that provides you with
    tools to design and develop complex applications for multiple desktop and mobile
    platforms.
124

125
    \image qtcreator-overview.png "Qt Creator overview"
126

Leena Miettinen's avatar
Leena Miettinen committed
127
    \section1 Projects
128

Leena Miettinen's avatar
Leena Miettinen committed
129
130
131
132
133
134
135
    One of the major advantages of Qt Creator is that it allows a team of developers
    to share a project across different development platforms with a common tool
    for development and debugging.

    But why do you need projects? To be able to build and run applications,
    Qt Creator needs the same information as a compiler would need. This information
    is specified in the project build and run settings.
136

137
    Creating a project allows you to:
138

139
        \list
140

141
            \o Group files together
142

143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
            \o Add custom build steps

            \o Include forms and resource files

            \o Specify settings for running applications

        \endlist

    You can either create a project from scratch or import an existing
    project. Qt Creator generates all the necessary files, depending on the type of
    project you create. For example, if you choose to create a graphical user
    interface (GUI) application, Qt Creator generates an empty .ui file
    that you can modify with the integrated \QD.

    Qt Creator is integrated with cross-platform systems for build automation: qmake and
    CMake. In addition, you can import generic projects that do not use qmake or CMake,
    and specify that Qt Creator ignores your build system.
160

Leena Miettinen's avatar
Leena Miettinen committed
161
162
163
164
165
166
    \section1 Editors

    Qt Creator comes with a code editor and an integrated \QD for designing and building
    graphical user interfaces (GUIs) from Qt widgets.

    \section2 Code Editor
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184

    As an IDE, Qt Creator differs from a text editor in that it knows how to build and run
    applications. It understands the C++ and QML languages as code, not just as plain text. This allows
    it to:

    \list

        \o Enable you to write well formatted code

        \o Anticipate what you are going to write and complete the code

        \o Display inline error and warning messages

        \o Enable you to semantically navigate to classes, functions, and symbols

        \o Provide you with context-sensitive help on classes, functions, and symbols

        \o Rename symbols in an intelligent way, so that other symbols with the same name
185
         that belong to other scopes are not renamed
Leena Miettinen's avatar
Leena Miettinen committed
186

187
        \o Show you the locations in code where a function is declared or called
Leena Miettinen's avatar
Leena Miettinen committed
188

189
    \endlist
Leena Miettinen's avatar
Leena Miettinen committed
190

Leena Miettinen's avatar
Leena Miettinen committed
191
    \section2 UI Designer
Leena Miettinen's avatar
Leena Miettinen committed
192

Leena Miettinen's avatar
Leena Miettinen committed
193
194
195
196
197
198
199
    You can use \QD to compose and customize widgets or dialogs and test
    them using different styles and resolutions. Widgets and forms created with \QD are
    integrated seamlessly with programmed code,
    using the Qt signals and slots mechanism, that lets you easily assign behavior to
    graphical elements. All properties set in \QD can be changed dynamically within the code.
    Furthermore, features like widget promotion and custom plugins allow you to use your
    own widgets with \QD.
200

Leena Miettinen's avatar
Leena Miettinen committed
201
    \section1 Languages
202

Leena Miettinen's avatar
Leena Miettinen committed
203
204
205
    You can use the code editor to write code in Qt C++ or in the
    \l {http://doc.qt.nokia.com/4.7-snapshot/declarativeui.html}{QML} declarative
    programming language.
206

Leena Miettinen's avatar
Leena Miettinen committed
207
    \section2 QML
208

Leena Miettinen's avatar
Leena Miettinen committed
209
    You can use QML to build highly dynamic, custom user interfaces from a rich set
210
    of QML elements. QML helps programmers and designers collaborate to build the
Leena Miettinen's avatar
Leena Miettinen committed
211
212
    fluid user interfaces that are becoming common in portable consumer devices, such as
    mobile phones, media players, set-top boxes and netbooks.
213

Leena Miettinen's avatar
Leena Miettinen committed
214
215
216
217
    QML is an extension to JavaScript, that provides a mechanism to declaratively build
    an object tree of QML elements. QML improves the integration between JavaScript and
    Qt's existing QObject based type system, adds support for automatic property bindings
    and provides network transparency at the language level.
218

Leena Miettinen's avatar
Leena Miettinen committed
219
    \section1 Targets
220
221

    Qt Creator provides support for building and running Qt applications for
Leena Miettinen's avatar
Leena Miettinen committed
222
223
    desktop environment (Windows, Linux, and Mac OS) and mobile devices (Symbian, Maemo,
    and MeeGo). Build settings allow you to quickly switch between build targets.
224

225
226
227
228
    When you build an application for a mobile device target with a device
    connected to the development PC, Qt Creator generates an installation package,
    installs in on the device, and executes it.

Leena Miettinen's avatar
Leena Miettinen committed
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
    You can publish the installation packages on the \l{https://publish.ovi.com/info/}{Ovi Store}.
    For Symbian devices, the packages must be signed.

    \section1 Tools

    Qt Creator is integrated with a set of helpful tools, such as version control
    systems and Qt Simulator.

    \section2 Version Control Systems

    The recommended way to build a project is to use a version control system.
    Qt Creator uses the version control system's command line clients to access
    your repositories. The following version control systems are supported:

    \list

        \o Git

        \o Subversion

        \o Perforce

        \o CVS

        \o Mercurial

    \endlist

    The functions available to you in Qt Creator depend on the version control
    system. Basic functions are available for all the supported systems. They include
    comparing files with the latest versions stored in the repository and displaying the
    differences, viewing versioning history and change details, annotating files,
    and committing and reverting changes.

    \section2 Qt Simulator

    You can use the Qt Simulator to test Qt applications that are intended
    for mobile devices in an environment similar to that of the device. You
    can change the information that the device has about its configuration
    and environment.

    The Qt Simulator is installed as part of the Nokia Qt SDK. After it is
    installed, you can select it as a build target in Qt Creator.

    \section1 Debuggers

275
276
277
278
279
    Qt Creator provides means to help you with debugging your application.
    It interfaces the GNU Symbolic Debugger (gdb) and the Microsoft Console
    Debugger (CDB) to debug native C++ applications and an internal debugger
    for Java Script. This includes the ability to connect mobile devices to
    your development PC and debug applications running on the devices.
Leena Miettinen's avatar
Leena Miettinen committed
280
281
282
283

    Qt Creator displays the raw information provided by the native debuggers
    in a clear and concise manner with the goal to simplify the debugging process
    as much as possible without losing the power of the native debuggers.
284

Leena Miettinen's avatar
Leena Miettinen committed
285
286
287
288
289
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
290
291
292
293
294
295
296
297
298
299
300
301
    \page creator-os-supported-platforms.html
    \nextpage creator-quick-tour.html

    \title Operating Systems and Supported Platforms

    \section1 Operating Systems

    Qt Creator is available in binary packages for the following operating
    systems:
    \list
        \o Windows XP Service Pack 2
        \o Windows Vista
302
        \o (K)Ubuntu Linux 7.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
           \list
               \o g++
               \o make
               \o libglib2.0-dev
               \o libSM-dev
               \o libxrender-dev
               \o libfontconfig1-dev
               \o libxext-dev
               \o libfreetype6-dev
               \o libx11-dev
               \o libxcursor-dev
               \o libxfixes-dev
               \o libxft-dev
               \o libxi-dev
               \o libxrandr-dev
318
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
319
           \endlist
320
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
321
322
323
324
325
326
           \list
               \o Xcode tools for your Mac OS X version available from your Mac
                  OS X installation DVDs or at \l http://developer.apple.com.
           \endlist
    \endlist

327
328
329
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
330
331
332

    To build Qt Creator itself from the source, you need:
    \list
333
        \o Qt 4.7 or later
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
334
335
336
        \o On Windows, MinGW 4.4 or Microsoft Visual Studio 2008
    \endlist

337
338
339
340
341
342
343
344
345
346
347
348
349
350
    \section1 Supported Mobile Device Platforms
    You can develop applications for the following mobile device
    platforms:

    \list

    \o Symbian

    \o Maemo and Maemo Application Development and Debugging Environment (MADDE)

    \endlist

    The following table summarizes operating system support for building
    applications for mobile device platforms.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
351
352
353

    \table
        \header
354
355
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
356
357
358
        \header
            \o Desktop
            \o Symbian
359
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
360
361
362
363
        \row
            \o Windows
            \o Yes
            \o Yes
364
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
365
366
367
368
        \row
            \o Linux
            \o Yes
            \o No
369
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
370
371
372
373
        \row
            \o Mac OS X
            \o Yes
            \o No
Leena Miettinen's avatar
Leena Miettinen committed
374
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
375
376
377
378
379
380
381
    \endtable
*/


/*!
    \contentspage index.html
    \previouspage creator-os-supported-platforms.html
con's avatar
con committed
382
    \page creator-quick-tour.html
383
    \nextpage creator-getting-started.html
con's avatar
con committed
384

385
    \title Qt Creator User Interface
con's avatar
con committed
386
387
388

    \image qtcreator-breakdown.png

389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
    When you start Qt Creator, it opens to the \gui Welcome mode, where you can:

    \list

        \o Open tutorials and example projects

        \o View tips and hints on using Qt Creator

        \o Create and open projects

        \o Send feedback to the development team

        \o Open recent sessions and projects

        \o Read news from the Qt labs

        \o Ask for support

    \endlist

    You can use the mode selector to change to another Qt Creator mode.

411
412
413
414
415
    Qt Creator 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 Qt Creator.

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
416
    \section1 Qt Creator Modes
con's avatar
con committed
417

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
418
    The mode selector allows you to quickly switch between tasks such as
419
420
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
421
422
    executed, and debugging your applications. To change modes, click the
    icons, or use the \l{keyboard-shortcuts}{corresponding keyboard shortcut}.
con's avatar
con committed
423

424
425
    You can use Qt Creator in the following modes:

con's avatar
con committed
426
    \list
427
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
428
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
Kai Koehne's avatar
Kai Koehne committed
429
           application user interfaces. This mode is available for UI files.
430
431
432
        \o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your program while
           debugging.
        \o \gui{\l{Managing Projects}{Projects}} mode for configuring project building and
433
           execution. This mode is available when a project is open.
434
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
435
436
    \endlist

437
    Certain actions in Qt Creator trigger a mode change. Clicking on
438
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
439
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
440
441


442
    \section1 Browsing Project Contents
con's avatar
con committed
443

444
    The sidebar is available in the \gui Edit and \gui Debug modes.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
445
446
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
447

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
448
449
450
451
452
453
454
455
456
    You can select the content of the sidebar in the sidebar menu:
    \list
        \o \gui Projects shows a list of projects open in the current
           session.
        \o \gui{File System} shows the content of the currently selected
           directory.
        \o \gui Bookmarks shows all bookmarks for the current session.
        \o \gui{Open Documents} shows currently open files.
    \endlist
con's avatar
con committed
457

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
458
459
460
461
462
    You can change the view of the sidebar in the following ways:
    \list
        \o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
           or press \key Alt+0 (\key Cmd+0 on Mac OS X).
        \o To split the sidebar, click \inlineimage qtcreator-splitbar.png
463
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
464
465
466
467
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
468
469


470
    \section2 Viewing Project Files
con's avatar
con committed
471

472
473
474
    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.
con's avatar
con committed
475

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
476
477
    You can use the project tree in the following ways:
    \list
478
479
        \o To bring up a context menu containing the actions most commonly
           needed right-click an item in the project tree.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
480
           For example, through the menu of the project root directory you can,
481
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
482
483
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
484
485
486
487
           and select \gui{Simplify tree}.
        \o To hide source files which are automatically generated by the build
           system, during a build, click \inlineimage qtcreator-filter.png
           and select \gui{Hide generated files}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
488
489
490
491
492
493
        \o To toggle the synchronization of your project tree with the file
           opened in the editor, click
           \inlineimage qtcreator-synchronizefocus.png
           .
        \o To see the absolute path of a file, move the mouse pointer over the
           file name.
con's avatar
con committed
494
495
496
    \endlist


497
    \section1 Viewing Output
con's avatar
con committed
498

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
499
    The task pane in Qt Creator can display one of the following panes:
500
501
502
503
504
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
505
506
       \o  \gui{General Messages}
       \o  \gui{Version Control}
507
508
509
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
510
511
512
    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}.
con's avatar
con committed
513

Leena Miettinen's avatar
Leena Miettinen committed
514
515
516
517
518
    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.

519
520
521
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

522

523
    \section2 Build Issues
con's avatar
con committed
524

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
525
    The \gui{Build Issues} pane provides a list of errors and warnings
526
    encountered during a build. The pane filters out irrelevant output from
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
527
    the build tools and presents the issues in an organized way.
con's avatar
con committed
528

529
530
531
532
    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.

533
    \image qtcreator-build-issues.png
con's avatar
con committed
534

535

con's avatar
con committed
536
537
    \section2 Search Results

538
539
540
541
542
    The \gui{Search Results} pane displays the results for global searches,
    for example, searching within a current document, files on disk, or all
    projects.

    The figure below shows an example search result for all
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
543
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
544
545
546

    \image qtcreator-search-pane.png

547

con's avatar
con committed
548
549
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
550
    The \gui{Application Output} pane displays the status of a program when
551
552
553
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
554
555
556

    \image qtcreator-application-output.png

557

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
558
    \section2 Compile Output
con's avatar
con committed
559

560
561
562
    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{Build Issues} pane.
con's avatar
con committed
563
564
565

    \image qtcreator-compile-pane.png

566
567
568
569
570
571
572
573
574
575
    \section1 Navigating with Keyboard

    Qt Creator 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.

*/

576

577
578
579
580
581
582
583
/*!
    \contentspage index.html
    \previouspage creator-version-control.html
    \page creator-help.html
    \nextpage creator-tips.html

    \title Getting Help
con's avatar
con committed
584

585
    Qt Creator comes fully integrated with Qt documentation and
586
    examples using the Qt Help plugin.
587
    \list
588
589
590
591
592
        \o To view documentation, switch to \gui Help mode.
        \o To obtain context sensitive help, move the text cursor to a Qt class
           or function and press \key F1. The documentation is displayed in a
           pane next to the code editor, or, if there is not enough vertical
           space, in the fullscreen \gui Help mode.
con's avatar
con committed
593

594
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
595

596
597
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
598
599
    \endlist

600
    \section1 Adding External Documentation
con's avatar
con committed
601

602
603
    You can display external documentation in the \gui Help mode.
    To augment or replace the documentation that ships with Qt Creator and Qt:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
604
605
606
607
608
    \list 1
        \o Create a .qch file from your documentation.

           For information on how to prepare your documentation and create a
           .qch file, see
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
609
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
610
        \o To add the .qch file to Qt Creator, select \gui Tools >
611
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
612
    \endlist
con's avatar
con committed
613

614
    \section1 Using Documentation Filters
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653

    You can filter the documents displayed in the \gui Help mode to find
    relevant information faster. Select from a list of filters in the
    \gui {Filtered by} field. The contents of the \gui Index and \gui Contents
    pane in the sidebar change accordingly.

    \image qtcreator-help-filters.png "Help filters"

    You can modify the filters to include external documentation, for example,
    or you can define your own filters. To construct filters, you can use the
    filter attributes that are specified in the documentation. Each document
    contains at least one filter attribute. If several documents contain the
    same filter attribute, such as \c tools, you can use that attribute to
    include all those documents.

    To add filters:

    \list 1

        \o Select \gui {Tools > Options... > Help > Filters > Add}.

        \o Enter a name for the filter and press \gui {OK}.

        \o In \gui Attributes, select the documents that you want to include
        in the filter.

        \image qtcreator-help-filter-attributes.png "Help filter attributes"

        \o Click \gui OK.

        \o In the \gui Help mode, select the filter in the \gui {Filtered by}
        field to see the filtered documentation in the sidebar.

    \endlist

    To modify filters, select a filter in \gui Filters, select the attributes,
    and then click \gui Apply.

    To remove filters, select them in \gui Filters, and click \gui Remove.
con's avatar
con committed
654

655
*/
656

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
657

658
659
660
661
662
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
    \nextpage creator-usability.html
663

664
    \title Developing Application UI
665

666
667
668
    You can use the integrated \QD to design and build graphical user interfaces (GUIs) from
    Qt widgets. You can compose and customize your widgets or dialogs and test
    them using different styles and resolutions.
669

670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
    Widgets and forms created with \QD are integrated seamlessly with programmed code,
    using the Qt signals and slots mechanism, that lets you easily assign behavior to
    graphical elements. All properties set in \QD can be changed dynamically within the code.
    Furthermore, features like widget promotion and custom plugins allow you to use your
    own widgets with \QD.

    UIs that use widgets are clearly structured and enforce a platform look and feel,
    which makes them useful for traditional applications. However, they are static, and
    do not fully make use of the large high-resolution screens, touch input, and significant
    graphics power that are becoming common in portable consumer devices, such as mobile
    phones, media players, set-top boxes, and netbooks.

    You can easily develop animations by using a declarative programming
    language called \l {http://doc.qt.nokia.com/4.7-snapshot/declarativeui.html}{QML}.
    In QML, a user interface is specified as a tree of objects with properties.
    You can edit QML code in the code editor. You
    can use Qt or JavaScript to implement the application logic.

688
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
689

690
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
691

692
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
693
694
695

    \image qtcreator-formedit.png

696
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
697
    \list 1
698
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
699
700
701
702
703
704
705
           \gui Locked.

           When this option is unchecked, you can change the layout.
        \o Click the header of an element and drag the element to a new
           position.
    \endlist

706
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
    \gui Designer.
    \list
        \o Set the class properties and code generation preferences in \gui
           {Class Generation}.
        \o Set an additional folder for saving templates in \gui{Template
           Paths}.
        \o Set the grid settings and preview preferences in \gui Forms. To
           preview your form with skins, enable \gui{Print/Preview
           Configuration} and select your skin. Otherwise default preview
           settings are used.

           To preview the settings, select \gui Tools > \gui{Form Editor} >
           \gui Preview, or press \key Ctrl+Alt+R.
        \o To specify embedded device profiles, such as style, font, and screen
           resolution, select \gui{Embedded Design}.
    \endlist

724
    For more information on \QD, see
725
    \l{http://doc.qt.nokia.com/4.7-snapshot/designer-manual.html}{Qt Designer Manual}.
726

Kai Koehne's avatar
Kai Koehne committed
727
    \if defined(qtquick)
728
    \section1 Using Qt Quick Designer
729

730
    You can edit .qml files in the visual \QMLD editor or in the
731
732
    code editor.

733
    In \gui Projects, double-click a .qml file to open it in the code
734
735
736
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

737
738
739
740
741
742
743
744
    \note The visual \QMLD editor is provided as an experimental plugin that you must
    enable to be able to edit QML files in the \gui Design mode. Enabling the
    visual editor can negatively affect the overall stability of Qt Creator.

    To enable or disable the \QMLD visual editor, select
    \gui {Help > About Plugins... > Qt Quick > QmlDesigner}. You must restart Qt Creator
    to enable or disable the visual editor.

745
746
747
748
749
750
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

751
752
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
753
754
755
756
757
758

    \o \gui {Library} pane displays lists of predefined \gui {Items} and
    imported \gui {Resources} that you can use to design applications. The
    images and other files that you copy to the project folder appear in the
    \gui {Resources} pane.

759
    \o \gui {Properties} pane displays the properties of the selected component.
760
761
     You can also change the properties in the code editor.

762
    \o \gui {State} pane displays the different states of the component. To add
763
764
765
766
767
    states, click the empty slot. Then modify the new state in the editor.
    In the code editor, you can see the changes recorded as changes to
    the base state.

    \endlist
Kai Koehne's avatar
Kai Koehne committed
768
    \endif
769

con's avatar
con committed
770
771
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
772

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
773
774
/*!
    \contentspage index.html
775
    \previouspage creator-project-managing-sessions.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
776
777
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
778

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
779
    \title Using the Editor
780

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
781
    Qt Creator's code editor is designed to aid you in creating, editing and
782
783
784
    navigating code.  Qt Creator's code editor is fully equipped with syntax
    checking, code completion, context sensitive help and in-line error
    indicators while you are typing.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
785

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
786
787
    \section1 Using the Editor Toolbar

788
789
790
    The editor toolbar is located at the top of the editor view. The editor
    toolbar is context sensitive and shows items relevant to the file currently
    open in the editor.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
791
792
793

    \image qtcreator-editortoolbar-symbols.png

Leena Miettinen's avatar
Leena Miettinen committed
794
795
    Use the toolbar to navigate between open files and symbols in use.
    To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
796
797
798
799
           \inlineimage qtcreator-back.png
           and \inlineimage qtcreator-forward.png
           .

Leena Miettinen's avatar
Leena Miettinen committed
800
801
802
803
804
805
806
807
    To go to any open file, select it from the \gui{Open files} drop-down menu.
    Right-click the menu title and select \gui {Copy Full Path to Clipboard} to
    copy the path and name of the current file to the clipboard.

    To jump to any symbol used in the current file, select it from the
    \gui Symbols drop-down menu. By default, the symbols are displayed in the
    order in which they appear in the file. Right-click the menu title and select
    \gui {Sort Alphabetically} to arrange the symbols in alphabetic order.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
808
809
810
811
812
813
814
815
816


    \section1 Splitting the Editor View

    Split the editor view when you want to work on and view multiple files on
    the same screen.

    \image qtcreator-spliteditorview.png

817
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
818
819
820
821
822
823
824
825
826
827
828
829
830
831
    \list
        \o To split the editor view into a top and bottom view, select
           \gui Window > \gui Split or press \key{Ctrl+E, 2}.

           Split command creates views below the currently active editor view.
        \o To split the editor view into adjacent views, select
           \gui Window > \gui{Split Side by Side} or press
           \key{Ctrl+E, 3}.

           Side by side split command creates views to the right of the
           currently active editor view.
    \endlist

    To move between split views, select \gui Window >
832
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847

    To remove a split view, place the cursor within the view you want to
    remove and select \gui Window > \gui{Remove Current Split} or press
    \key{Ctrl+E, 0}. To remove all but the currently selected split view,
    select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}.


    \section1 Highlighting and Folding Blocks

    Use block highlighting to visually separate parts of the code that belong
    together. For example, when you place the cursor within the braces,
    the code enclosed in braces is highlighted.

    \image qtcreator-blockhighlighting.png

848
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
849
850
851
852
853
854
855
    \gui{Text Editor} > \gui Display > \gui{Highlight blocks}.

    Use the folding markers to collapse and expand blocks of code within
    braces. Click the folding marker to collapse or expand a block. In the
    figure above, the folding markers are located between the line number and
    the text pane.

856
857
858
    To show the folding markers, select \gui Tools > \gui{Options...} >
    \gui{Text Editor} > \gui Display > \gui{Display folding markers}. This
    option is enabled by default.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
859

860
861
862
863
864
    When the cursor is on a brace, the matching brace is animated
    by default. To turn off the animation and just highlight the block and
    the braces, select \gui {Tools > Options... > Text Editor > Display} and
    deselect \gui {Animate matching parentheses}.

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
865

866
    \section1 Checking Code Syntax
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
867

868
869
870
    As you write code Qt Creator checks code syntax. When Qt Creator spots a
    syntax error in your code it underlines it and shows error details when you
    move the mouse pointer over the error.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
871
872
873
    \list
        \o Syntax errors are underlined in red.

874
875
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
876
877
878
879
880
881
882
883

           \image qtcreator-syntaxerror.png
        \o Semantic errors and warnings are underlined in olive.

           In the following figure, the type is unknown.

           \image qtcreator-semanticerror.png
    \endlist
884
885


886
887
888
889
    \section1 Completing Code

    Qt Creator understands the code as code, not just as plain text. This
    allows it to help you to write well formatted code and to anticipate
890
    what you are going to write and complete the code.
Robert Loehning's avatar
Robert Loehning committed
891
    The code completion differs somewhat depending on whether you write Qt code or QML code.
892
893

    \section2 Completing Qt Code
894

895
896
    As you write code, Qt Creator provides a list of context-sensitive
    suggestions to the statement currently under your cursor.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
897
898
899

    \image qtcreator-codecompletion.png

900
901
    To open the list of suggestions at any time, press \key{Ctrl+Space}.
    If only one option is available, Qt Creator inserts it automatically.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
902

903
904
905
906
    When completion is invoked manually, Qt Creator completes the common prefix
    of the list of suggestions. This is especially useful for classes with
    several similarly named members. To disable this functionality, uncheck
    \gui{Autocomplete common prefix} in the code completion preferences.
907
    Select \gui Tools > \gui{Options...} > \gui{Text Editor} > \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
908

909
910
911
912
    By default, code completion considers only the first letter case-sensitive.
    To apply full or no case-sensitivity, select the option in the
    \gui {Case-sensitivity} field.

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
913
914
    The following table lists available types for code completion and icon
    used for each.
915
916

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
917
918
919
        \header
            \o Icon
            \o Description
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
        \row
            \i  \inlineimage completion/class.png
            \i  A class
        \row
            \i  \inlineimage completion/enum.png
            \i  An enum
        \row
            \i  \inlineimage completion/enumerator.png
            \i  An enumerator (value of an enum)
        \row
            \i  \inlineimage completion/func.png
            \i  A function
        \row
            \i  \inlineimage completion/func_priv.png
            \i  A private function
        \row
            \i  \inlineimage completion/func_prot.png
            \i  A protected function
        \row
            \i  \inlineimage completion/var.png
            \i  A variable
        \row
            \i  \inlineimage completion/var_priv.png
            \i  A private variable
        \row
            \i  \inlineimage completion/var_prot.png
            \i  A protected variable
        \row
            \i  \inlineimage completion/signal.png
            \i  A signal
        \row
            \i  \inlineimage completion/slot.png
            \i  A slot
        \row
            \i  \inlineimage completion/slot_priv.png
            \i  A private slot
        \row
            \i  \inlineimage completion/slot_prot.png
            \i  A protected slot
        \row
            \i  \inlineimage completion/keyword.png
            \i  A keyword
        \row
            \i  \inlineimage completion/macro.png
            \i  A macro
        \row
            \i  \inlineimage completion/namespace.png
            \i  A namespace
    \endtable
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
969

970
971
972
973
974
975
976
977
978
    \section2 Completing QML Code

    As you write QML code, Qt Creator suggests properties, IDs, and code
    snippets to complete the code. The snippets can consist of multiple
    fields that you specify values for. Select an item in the list and press
    \key Tab or \key Enter to complete the code. Press \key Tab to
    move between the fields and specify values for them.

    \image qmldesigner-code-completion.png "Completing QML code"
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
979

980
981
    \section1 Using Bookmarks

982
    To insert or delete a bookmark right-click the line number and select
983
984
985
986
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

987
    To go to previous bookmark in the current session, press \key{Ctrl+,}.
988

989
    To go to next bookmark in the current session, press \key{Ctrl+.}.
990
991


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
992
993
994
995
996
    \section1 Moving to Symbol Definition or Declaration

    In Qt Creator you can move directly to the definition or the declaration of
    a symbol by holding the \key Ctrl and clicking the symbol.

997
    To enable this moving function, in \gui Tools > \gui{Options...} >
998
    \gui{Text Editor} > \gui Behavior select \gui{Enable mouse navigation}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
999

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1000

1001
1002
1003
    \section1 Using Update Code Model

    To refresh the internal information in Qt Creator pertaining to your code,
1004
    select \gui{Tools} > \gui{C++} > \gui{Update Code Model}.
1005

1006
    \note In Qt Creator indexing updates the code automatically. Use
1007
    \gui{Update Code Model} only as an emergency command.
1008

1009
1010
*/

1011

1012
1013
1014
1015
1016
1017
1018
/*!
    \contentspage index.html
    \previouspage creator-editor-locator.html
    \page creator-editor-codepasting.html
    \nextpage creator-editor-options.html

    \title Pasting and Fetching Code Snippets
1019

1020
    In Qt Creator, you can paste snippets of code to a server or fetch
1021
1022
1023
1024
1025
1026
1027
1028
    snippets of code from the server. To paste and fetch snippets of code,
    Qt Creator uses the following:
    \list
        \o \gui{CodePaster}
        \o \gui{Pastebin.Com}
        \o \gui{Pastebin.Ca}
    \endlist

1029
    To configure the server, select \gui{Tools} > \gui{Options...} >
1030
1031
1032
1033
1034
1035
1036
1037
    \gui{Code Pasting}.

    To paste a snippet of code onto the server, select \gui{Tools} >
    \gui{Code Pasting} > \gui{Paste Snippet...} or press \key{Alt+C,Alt+P}.

    To fetch a snippet of code from the server, select \gui{Tools} >
    \gui{Code Pasting} > \gui{Fetch Snippet...} or press \key{Alt+C,Alt+F}.

1038
    \note To use \gui{Pastebin.Com}, configure the domain
1039
1040
1041
    prefix in \gui{Tools} > \gui{Options...} > \gui{Code Pasting} >
    \gui{Pastebin.com}.

1042
    For example, you might ask colleagues to review a change that you plan to
1043
    submit to a version control system. If you use the Git version control system,
1044
1045
1046
1047
1048
1049
    you can create a \e{diff} view by selecting \gui{Tools} > \gui{Git} >
    \gui{Diff Repository}. You can then upload its contents to the server by choosing
    \gui{Tools} > \gui{Code Pasting} > \gui{Paste Snippet...}. The reviewers can retrieve
    the code snippet by selecting \gui{Tools} > \gui{Code Pasting} > \gui{Fetch Snippet...}.
    If they have the project currently opened in Qt Creator, they can apply and test
    the change by choosing \gui{Tools} > \gui{Git} > \gui{Apply Patch}.
1050

1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
*/


/*!
    \contentspage index.html
    \previouspage creator-editor-options.html
    \page creator-editor-fakevim.html
    \nextpage creator-editor-external.html

    \title Using FakeVim Mode
1061
1062
1063

    In the \gui{FakeVim} mode, you can run the main editor in a manner similar
    to the Vim editor. To run the editor in the \gui{FakeVim} mode, select
1064
    \gui{Edit} > \gui{Advanced} > \gui{Use Vim-style Editing} or press
1065
1066
1067
    \key{Alt+V,Alt+V}.

    In the \gui{FakeVim} mode, most keystrokes in the main editor will be
1068
1069
1070
    intercepted and interpreted in a way that resembles Vim. Documentation for
    Vim is not included in Qt Creator. For more information on using Vim,
    see \l{http://www.vim.org/docs.php}{Documentation} on the Vim web site.
1071
1072
1073
1074
1075

    To map commands entered on the \gui{FakeVim} command line to actions of the
    Qt Creator core, select \gui{Tools} > \gui{Options...} > \gui{FakeVim} >
    \gui{Ex Command Mapping}.

1076
1077
1078
1079
1080
1081
    To make changes to the Vim-style settings, select \gui{Tools} >
    \gui{Options...} > \gui FakeVim > \gui{General}.

    To use a Vim-style color scheme, select \gui {Tools > Options... >
    Text Editor > Fonts & Color}. In the \gui {Color Scheme} list, select
    \gui {Vim (dark)}.
1082

1083
1084
1085
    To quit the FakeVim mode, click \gui {Quit FakeVim} or press
    \key{Alt+V,Alt+V}.

1086
1087
1088
1089
1090
1091