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

15
    \section1 Version 2.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}
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
            \list
            \o \l {Debugging Qt Applications}
96
97
98
99
100
101
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
            \endlist
102
            \if defined(qtquick)
103
            \o \l{Debugging Qt Quick Applications}
104
105
            \endif
            \if defined(qtquick)
106
107
108
                \list
                    \o \l{Using the QML Inspector}
                \endlist
109
            \endif
110
            \endlist
111
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
112
       \o \l{Using Version Control Systems}
113
114

       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
115
116
117
118
119
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
120
121
122
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
123

con's avatar
con committed
124
125
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
126
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
127
128
129
130
131
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

132
133
    Qt Creator provides you with tools to design and develop
    complex applications for multiple desktop and mobile platforms.
134

135
    \image qtcreator-overview.png "Qt Creator overview"
136

137
    \section1 Why Do You Need Projects?
138

139
140
141
142
143
    A \e project is a central concept in Qt Creator that might seem unnecessary
    at the first glance. However, 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.
144

145
    Creating a project allows you to:
146

147
        \list
148

149
            \o Group files together
150

151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
            \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.
168

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
    \section1 Coding Applications

    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
188
         that belong to other scopes are not renamed
Leena Miettinen's avatar
Leena Miettinen committed
189

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

192
    \endlist
Leena Miettinen's avatar
Leena Miettinen committed
193

194
    \section1 Using Integrated Tools
Leena Miettinen's avatar
Leena Miettinen committed
195

196
    The following tools have been integrated with Qt Creator:
197

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
    \list

        \o \QD for designing and building graphical user interfaces (GUIs) from
        Qt widgets.

        \o \e Qt Simulator for testing Qt applications that are intended
        for mobile devices in an environment similar to that of the device.

        \o \e {Version control systems} for accessing your project repositories.

        \o \e {Debugger plugin} for accessing external native debuggers,
        such as the GNU Symbolic Debugger (gdb), the Microsoft Console Debugger (CDB),
        and an internal Java Script debugger, to debug the C++ language.

        \o \e {QML inspector plugin} for debugging the QML language.

    \endlist

    \section1 Deploying Applications

    Qt Creator provides support for building and running Qt applications for
    desktop environment and mobile devices. Build settings allow you to quickly
    switch between build targets.
221

222
223
224
225
226
227
    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.

    You can publish the installation packages on the Ovi Store. For Symbian devices,
    the packages must be signed.
228

Leena Miettinen's avatar
Leena Miettinen committed
229
230
231
232
233
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
234
235
236
237
238
239
240
241
242
243
244
245
    \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
246
        \o (K)Ubuntu Linux 7.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
           \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
262
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
263
           \endlist
264
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
265
266
267
268
269
270
           \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

271
272
273
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
274
275
276

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

281
282
283
284
285
286
287
288
289
290
291
292
293
294
    \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
295
296
297

    \table
        \header
298
299
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
300
301
302
        \header
            \o Desktop
            \o Symbian
303
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
304
305
306
307
        \row
            \o Windows
            \o Yes
            \o Yes
308
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
309
310
311
312
        \row
            \o Linux
            \o Yes
            \o No
313
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
314
315
316
317
        \row
            \o Mac OS X
            \o Yes
            \o No
Leena Miettinen's avatar
Leena Miettinen committed
318
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
319
320
321
322
323
324
325
    \endtable
*/


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

329
    \title Qt Creator User Interface
con's avatar
con committed
330
331
332

    \image qtcreator-breakdown.png

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    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.

355
356
357
358
359
    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
360
    \section1 Qt Creator Modes
con's avatar
con committed
361

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
362
    The mode selector allows you to quickly switch between tasks such as
363
364
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
365
366
    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
367

368
369
    You can use Qt Creator in the following modes:

con's avatar
con committed
370
    \list
371
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
372
        \if defined(qtquick)
373
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
374
375
           application user interfaces. This mode is available for UI files (.ui or
           .qml).
Robert Loehning's avatar
Robert Loehning committed
376
377
        \else
        \o \gui{\l{Using Qt Designer}{Design}} mode for designing and developing
378
379
           application user interfaces.
        \endif
380
381
382
        \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
383
           execution. This mode is available when a project is open.
384
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
385
386
    \endlist

387
388
    Certain actions in Qt Creator trigger a mode change. Clicking on
    \gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
389
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
390
391


392
    \section1 Browsing Project Contents
con's avatar
con committed
393

394
    The sidebar is available in the \gui Edit and \gui Debug modes.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
395
396
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
397

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
398
399
400
401
402
403
404
405
406
    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
407

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
408
409
410
411
412
    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
413
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
414
415
416
417
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
418
419


420
    \section2 Viewing Project Files
con's avatar
con committed
421

422
423
424
    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
425

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
426
427
    You can use the project tree in the following ways:
    \list
428
429
        \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
430
           For example, through the menu of the project root directory you can,
431
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
432
433
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
434
435
436
437
           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
438
439
440
441
442
443
        \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
444
445
446
    \endlist


447
    \section1 Viewing Output
con's avatar
con committed
448

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
449
    The task pane in Qt Creator can display one of the following panes:
450
451
452
453
454
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
455
456
       \o  \gui{General Messages}
       \o  \gui{Version Control}
457
458
459
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
460
461
462
    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
463

464
465
466
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

467

468
    \section2 Build Issues
con's avatar
con committed
469

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

474
475
476
477
    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.

478
    \image qtcreator-build-issues.png
con's avatar
con committed
479

480

con's avatar
con committed
481
482
    \section2 Search Results

483
484
485
486
487
    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
488
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
489
490
491

    \image qtcreator-search-pane.png

492

con's avatar
con committed
493
494
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
495
    The \gui{Application Output} pane displays the status of a program when
496
497
498
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
499
500
501

    \image qtcreator-application-output.png

502

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
503
    \section2 Compile Output
con's avatar
con committed
504

505
506
507
    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
508
509
510

    \image qtcreator-compile-pane.png

511
512
513
514
515
516
517
518
519
520
    \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.

*/

521

522
523
524
525
526
527
528
/*!
    \contentspage index.html
    \previouspage creator-version-control.html
    \page creator-help.html
    \nextpage creator-tips.html

    \title Getting Help
con's avatar
con committed
529

530
    Qt Creator comes fully integrated with Qt documentation and
531
    examples using the Qt Help plugin.
532
    \list
533
534
535
536
537
        \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
538

539
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
540

541
542
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
543
544
    \endlist

545
    \section1 Adding External Documentation
con's avatar
con committed
546

547
548
    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
549
550
551
552
553
    \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
554
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
555
        \o To add the .qch file to Qt Creator, select \gui Tools >
556
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
557
    \endlist
con's avatar
con committed
558

559
    \section1 Using Documentation Filters
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598

    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
599

600
*/
601

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
602

603
604
605
606
607
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
    \nextpage creator-usability.html
608

609
    \title Developing Application UI
610

611
612
613
    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.
614

615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
    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.

    \if defined(qtquick)

    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.

    \endif
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
636

637
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
638

639
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
640

641
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
642
643
644

    \image qtcreator-formedit.png

645
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
646
    \list 1
647
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
648
649
650
651
652
653
654
           \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

655
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
    \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

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

676
677
    \if defined(qtquick)

678
    \section1 Using Qt Quick Designer
679

680
    You can edit .qml files in the visual \QMLD editor or in the
681
682
    code editor.

683
    In \gui Projects, double-click a .qml file to open it in the code
684
685
686
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

687
688
689
690
691
692
693
694
    \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.

695
696
697
698
699
700
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

701
702
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
703
704
705
706
707
708

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

709
    \o \gui {Properties} pane displays the properties of the selected component.
710
711
     You can also change the properties in the code editor.

712
    \o \gui {State} pane displays the different states of the component. To add
713
714
715
716
717
718
    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

con's avatar
con committed
719
720
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
721

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
722
723
/*!
    \contentspage index.html
724
    \previouspage creator-project-managing-sessions.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
725
726
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
727

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
728
    \title Using the Editor
729

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
730
    Qt Creator's code editor is designed to aid you in creating, editing and
731
732
733
    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
734

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
735
736
    \section1 Using the Editor Toolbar

737
738
739
    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
740
741
742
743
744

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
745
        \o To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
746
747
748
749
750
751
752
753
754
           \inlineimage qtcreator-back.png
           and \inlineimage qtcreator-forward.png
           .
        \o To go to any open file, select it from the \gui{Open files}
           drop-down menu.
        \o To jump to any symbol used in the current file, select it from the
           \gui Symbols drop-down menu.
    \endlist

755
756
    When you create or edit forms in a \c{.ui} file, the toolbar contains
    Qt Designer specific tools.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
757
758
759
760
761
762
763
764
765


    \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

766
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
767
768
769
770
771
772
773
774
775
776
777
778
779
780
    \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 >
781
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796

    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

797
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
798
799
800
801
802
803
804
    \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.

805
806
807
    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
808

809
810
811
812
813
    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
814

815
    \section1 Checking Code Syntax
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
816

817
818
819
    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
820
821
822
    \list
        \o Syntax errors are underlined in red.

823
824
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
825
826
827
828
829
830
831
832

           \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
833
834


835
836
837
838
    \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
839
    what you are going to write and complete the code.
Robert Loehning's avatar
Robert Loehning committed
840
841
    \if defined(qtquick)
    The code completion differs somewhat depending on whether you write Qt code or QML code.
842
843
844
    \endif

    \if defined(qtquick)
845
846

    \section2 Completing Qt Code
847

848
849
    \endif

850
851
    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
852
853
854

    \image qtcreator-codecompletion.png

855
856
    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
857

858
859
860
861
    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.
862
    Select \gui Tools > \gui{Options...} > \gui{Text Editor} > \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
863

864
865
866
867
    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
868
869
    The following table lists available types for code completion and icon
    used for each.
870
871

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
872
873
874
        \header
            \o Icon
            \o Description
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
        \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
924

925
926
    \if defined(qtquick)

927
928
929
930
931
932
933
934
935
    \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
936

937
938
    \endif

939
940
    \section1 Using Bookmarks

941
    To insert or delete a bookmark right-click the line number and select
942
943
944
945
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

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

948
    To go to next bookmark in the current session, press \key{Ctrl+.}.
949
950


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
951
952
953
954
955
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
959

960
961
962
    \section1 Using Update Code Model

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

965
    \note In Qt Creator indexing updates the code automatically. Use
966
    \gui{Update Code Model} only as an emergency command.
967

968
969
*/

970

971
972
973
974
975
976
977
/*!
    \contentspage index.html
    \previouspage creator-editor-locator.html
    \page creator-editor-codepasting.html
    \nextpage creator-editor-options.html

    \title Pasting and Fetching Code Snippets
978

979
    In Qt Creator, you can paste snippets of code to a server or fetch
980
981
982
983
984
985
986
987
    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

988
    To configure the server, select \gui{Tools} > \gui{Options...} >
989
990
991
992
993
994
995
996
    \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}.

997
    \note To use \gui{Pastebin.Com}, configure the domain
998
999
1000
    prefix in \gui{Tools} > \gui{Options...} > \gui{Code Pasting} >
    \gui{Pastebin.com}.

1001
    For example, you might ask colleagues to review a change that you plan to
1002
    submit to a version control system. If you use the Git version control system,
1003
1004
1005
1006
1007
1008
    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}.
1009

1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
*/


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

    \title Using FakeVim Mode
1020
1021
1022

    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
1023
    \gui{Edit} > \gui{Advanced} > \gui{Use Vim-style Editing} or press
1024
1025
1026
    \key{Alt+V,Alt+V}.

    In the \gui