qtcreator.qdoc 260 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.0
con's avatar
con committed
16

17
    Qt Creator provides integrated tools for both application designers
18
    and developers to create applications for multiple desktop and mobile device
19
20
    platforms.

21
22
23
    For application designers, Qt Creator provides an integrated
    visual editor, \QD, \if defined(qtquick) and \QMLD \endif
    that you can use to design and develop
24
    application user interfaces.
25
26

    For application developers,
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
27
    Qt Creator provides a cross-platform, complete integrated development
28
29
    environment (IDE) that is available for Linux,
    Mac OS X and Windows operating systems. For more information, see
30
    \l{Operating Systems and Supported Platforms}.
con's avatar
con committed
31

32
    \note Please report bugs and suggestions to the
con's avatar
con committed
33
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
34
35
36
    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
37
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
38
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed
39

40
41
    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
42
    \endraw
43

con's avatar
con committed
44
    \list
Leena Miettinen's avatar
Leena Miettinen committed
45
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
46
47
       \o \l{Operating Systems and Supported Platforms}
       \o \l{Quick Tour}
48
49
       \o \l{Getting Started}
           \list
50
               \o \l{Building and Running an Example Application}
51
               \o \l{Creating a Qt C++ Application}
52
               \o \l{Creating a Mobile Application with Nokia Qt SDK}
53
               \if defined(qtquick)
54
               \o \l{Creating a Qt Quick Application}
55
               \endif
56
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
57
58
59
60
61
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
                \o \l{Searching With the Locator}
62
63
64
65
                \o \l{Pasting and Fetching Code Snippets}
                \o \l{Configuring the Editor}
                \o \l{Using FakeVim Mode}
                \o \l{Using an External Editor}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
66
67
68
69
70
71
72
            \endlist
       \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
73
74
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
75
76
                \o \l{Managing Sessions}
            \endlist
77
78
79
80
81
82
83
84
       \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
85
       \if defined(qtquick)
86
       \o \l{Developing Qt Quick Applications}
87
       \endif
Leena Miettinen's avatar
Leena Miettinen committed
88
       \o \l{Optimizing Applications for Mobile Devices}
89
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
90
       \o \l{Debugging}
91
92
            \list
            \o \l {Debugging Qt Applications}
93
94
95
96
97
98
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
            \endlist
99
            \if defined(qtquick)
100
            \o \l{Debugging Qt Quick Applications}
101
102
            \endif
            \if defined(qtquick)
103
104
105
                \list
                    \o \l{Using the QML Inspector}
                \endlist
106
            \endif
107
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
108
       \o \l{Using Version Control Systems}
109
       \o \l{Adding Qt Designer Plugins}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
110
111
112
113
114
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
115
116
117
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
118

con's avatar
con committed
119
120
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
121
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
122
123
124
125
126
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

127
128
  Qt Creator provides you with tools to design and develop user interfaces and
  complex applications for multiple desktop and mobile
129
130
  platforms.

131
132
  \section1 Designing User Interfaces

133
134
  \if defined(qtquick)

135
136
  Qt Creator provides two integrated visual editors, \QD and \QMLD.

137
138
  \endif

139
140
141
142
143
144
145
146
147
148
  \QD is a tool for designing and building graphical user interfaces (GUIs) from
  Qt widgets. You can compose and customize your 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.

149
150
    \if defined(qtquick)

151
152
153
154
155
  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.
156
157

  \QMLD allows you to easily develop animations by using a declarative programming
158
  language called \l {http://doc.qt.nokia.com/4.7-snapshot/declarativeui.html}{QML}.
159
160
161
  In QML, a user interface is specified as a tree of objects with properties.

  You use a visual editor to create items, screens, and applications, as well as define changes
162
  in their state. \QMLD generates the necessary code for you.
163
164
165
166
167

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

168
169
  You can edit the code in the code editor to add transitions from one state to another,
  and interaction to specify user actions that change the states. You
170
  can use Qt or JavaScript to implement the application logic.
171

172
173
  \endif

174
  \section1 Coding Applications
175

Leena Miettinen's avatar
Leena Miettinen committed
176
177
178
179
  As an IDE, Qt Creator differs from a text editor in that it knows how to build and run
  applications. It understands the code as code, not just as plain text. This allows
  it to:
  \list
180
181
182
183
184
      \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
185
      \o Rename symbols in an intelligent way, so that other symbols with the same name
186
187
         that belong to other scopes are not renamed
      \o Show you the locations in code where a function is declared or called
Leena Miettinen's avatar
Leena Miettinen committed
188
189
190
191
192
193
194
195
196
197
   \endlist

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

      Creating a project allows you to:
      \list
198
199
200
201
      \o Group files together
      \o Add custom build steps
      \o Include forms and resource files
      \o Specify settings for running applications
Leena Miettinen's avatar
Leena Miettinen committed
202
203
204
205
206
      \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
207
208
209
      interface (GUI) application, Qt Creator generates an empty .ui file
      that you can modify with the integrated \QD.

210
211
      \if defined(qtquick)

212
      If you choose to create a Qt Quick application, Qt Creator generates a .qml file
213
      that you can modify with the \QMLD visual editor and the code editor.
214
215

      \endif
Leena Miettinen's avatar
Leena Miettinen committed
216
217
218
219
220
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
221
222
223
224
225
226
227
228
229
230
231
232
    \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
233
        \o (K)Ubuntu Linux 7.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
           \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
249
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
250
           \endlist
251
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
252
253
254
255
256
257
           \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

258
259
260
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
261
262
263

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

268
269
270
271
272
273
274
275
276
277
278
279
280
281
    \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
282
283
284

    \table
        \header
285
286
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
287
288
289
        \header
            \o Desktop
            \o Symbian
290
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
291
292
293
294
        \row
            \o Windows
            \o Yes
            \o Yes
295
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
296
297
298
299
        \row
            \o Linux
            \o Yes
            \o No
300
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
301
302
303
304
        \row
            \o Mac OS X
            \o Yes
            \o No
Leena Miettinen's avatar
Leena Miettinen committed
305
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
306
307
308
309
310
311
312
    \endtable
*/


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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
316
    \title Quick Tour
con's avatar
con committed
317

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
318
    The figure below shows some of the components of Qt Creator in
319
    \gui{Edit} mode.
con's avatar
con committed
320
321
322

    \image qtcreator-breakdown.png

323
324
325
326
327
    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
328
    \section1 Qt Creator Modes
con's avatar
con committed
329

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
330
    The mode selector allows you to quickly switch between tasks such as
331
332
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
333
334
    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
335
336

    \list
337
338
        \o \gui Welcome mode for opening recent sessions and projects.
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
339
        \if defined(qtquick)
340
341
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
           application user interfaces.
342
343
344
345
346
           \else
            \o \gui{\l{Using Qt Designer}{Design}} mode for designing and developing
           application user interfaces.
           \endif
        \endif
347
348
349
350
        \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
           execution.
351
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
352
353
    \endlist

354
355
    Certain actions in Qt Creator trigger a mode change. Clicking on
    \gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
356
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
357
358


359
    \section1 Browsing Project Contents
con's avatar
con committed
360

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
361
362
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
363

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
364
365
366
367
368
369
370
371
372
    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
373

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
374
375
376
377
378
    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
379
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
380
381
382
383
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
384
385


386
    \section2 Viewing Project Files
con's avatar
con committed
387

388
389
390
    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
391

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
392
393
    You can use the project tree in the following ways:
    \list
394
395
        \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
396
           For example, through the menu of the project root directory you can,
397
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
398
399
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
400
401
402
403
           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
404
405
406
407
408
409
        \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
410
411
412
    \endlist


413
    \section1 Viewing Output
con's avatar
con committed
414

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
415
    The task pane in Qt Creator can display one of the following panes:
416
417
418
419
420
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
421
422
       \o  \gui{General Messages}
       \o  \gui{Version Control}
423
424
425
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
426
427
428
    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
429

430
431
432
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

433

434
    \section2 Build Issues
con's avatar
con committed
435

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

440
441
442
443
    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.

444
    \image qtcreator-build-issues.png
con's avatar
con committed
445

446

con's avatar
con committed
447
448
    \section2 Search Results

449
450
451
452
453
    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
454
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
455
456
457

    \image qtcreator-search-pane.png

458

con's avatar
con committed
459
460
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
461
    The \gui{Application Output} pane displays the status of a program when
462
463
464
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
465
466
467

    \image qtcreator-application-output.png

468

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
469
    \section2 Compile Output
con's avatar
con committed
470

471
472
473
    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
474
475
476

    \image qtcreator-compile-pane.png

477

478
    \section1 Getting Help
con's avatar
con committed
479

480
    Qt Creator comes fully integrated with Qt documentation and
481
    examples using the Qt Help plugin.
482
    \list
483
484
485
486
487
        \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
488

489
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
490

491
492
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
493
494
    \endlist

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
495
    \section2 Adding External Documentation
con's avatar
con committed
496

497
498
    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
499
500
501
502
503
    \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
504
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
505
        \o To add the .qch file to Qt Creator, select \gui Tools >
506
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
507
    \endlist
con's avatar
con committed
508

509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
    \section2 Using Documentation Filters

    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
549

550
    \section1 Navigating with Keyboard
551

552
553
554
    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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
555
556
557
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

558
559
    \if defined(qtquick)

560
561
562
563
564
565
566
567
568
    \section1 Developing Application UI

    To help you design the user interface of your application, two visual
    editors are integrated into Qt Creator:

    \list
    \o \QD
    \o \QMLD
    \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
569

570
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
571

572
573
    \endif

574
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
575

576
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
577
578
579

    \image qtcreator-formedit.png

580
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
581
    \list 1
582
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
583
584
585
586
587
588
589
           \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

590
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
    \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

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

611
612
    \if defined(qtquick)

613
    \section1 Using Qt Quick Designer
614

615
    You can edit .qml files in the visual \QMLD editor or in the
616
617
    code editor.

618
    In \gui Projects, double-click a .qml file to open it in the code
619
620
621
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

622
623
624
625
626
627
628
629
    \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.

630
631
632
633
634
635
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

636
637
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
638
639
640
641
642
643

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

644
    \o \gui {Properties} pane displays the properties of the selected component.
645
646
     You can also change the properties in the code editor.

647
    \o \gui {State} pane displays the different states of the component. To add
648
649
650
651
652
653
    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

654
655
    \endif

con's avatar
con committed
656
657
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
658

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
659
660
/*!
    \contentspage index.html
661
    \previouspage creator-qml-application.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
662
663
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
664

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
665
    \title Using the Editor
666

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
667
    Qt Creator's code editor is designed to aid you in creating, editing and
668
669
670
    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
671

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
672
673
    \section1 Using the Editor Toolbar

674
675
676
    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
677
678
679
680
681

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
682
        \o To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
683
684
685
686
687
688
689
690
691
           \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

692
693
    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
694
695
696
697
698
699
700
701
702


    \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

703
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
704
705
706
707
708
709
710
711
712
713
714
715
716
717
    \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 >
718
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733

    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

734
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
735
736
737
738
739
740
741
    \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.

742
743
744
    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
745

746
747
748
749
750
    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
751

752
    \section1 Checking Code Syntax
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
753

754
755
756
    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
757
758
759
    \list
        \o Syntax errors are underlined in red.

760
761
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
762
763
764
765
766
767
768
769

           \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
770
771


772
773
774
775
    \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
776
777
778
779
780
    what you are going to write and complete the code.
    \if defined(qtquick) The code completion differs somewhat depending on whether you write Qt code or QML code.
    \endif

    \if defined(qtquick)
781
782

    \section2 Completing Qt Code
783

784
785
    \endif

786
787
    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
788
789
790

    \image qtcreator-codecompletion.png

791
792
    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
793

794
795
796
797
    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.
798
    Select \gui Tools > \gui{Options...} > \gui{Text Editor} > \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
799

800
801
802
803
    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
804
805
    The following table lists available types for code completion and icon
    used for each.
806
807

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
808
809
810
        \header
            \o Icon
            \o Description
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
        \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
860

861
862
    \if defined(qtquick)

863
864
865
866
867
868
869
870
871
    \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
872

873
874
    \endif

875
876
    \section1 Using Bookmarks

877
    To insert or delete a bookmark right-click the line number and select
878
879
880
881
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

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

884
    To go to next bookmark in the current session, press \key{Ctrl+.}.
885
886


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
887
888
889
890
891
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
895

896
897
898
    \section1 Using Update Code Model

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

901
    \note In Qt Creator indexing updates the code automatically. Use
902
    \gui{Update Code Model} only as an emergency command.
903

904
905
*/

906

907
908
909
910
911
912
913
/*!
    \contentspage index.html
    \previouspage creator-editor-locator.html
    \page creator-editor-codepasting.html
    \nextpage creator-editor-options.html

    \title Pasting and Fetching Code Snippets
914

915
    In Qt Creator, you can paste snippets of code to a server or fetch
916
917
918
919
920
921
922
923
    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

924
    To configure the server, select \gui{Tools} > \gui{Options...} >
925
926
927
928
929
930
931
932
    \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}.

933
    \note To use \gui{Pastebin.Com}, configure the domain
934
935
936
    prefix in \gui{Tools} > \gui{Options...} > \gui{Code Pasting} >
    \gui{Pastebin.com}.

937
    For example, you might ask colleagues to review a change that you plan to
938
    submit to a version control system. If you use the Git version control system,
939
940
941
942
943
944
    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}.
945

946
947
948
949
950
951
952
953
954
955
*/


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

    \title Using FakeVim Mode
956
957
958

    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
959
    \gui{Edit} > \gui{Advanced} > \gui{Use Vim-style Editing} or press
960
961
962
    \key{Alt+V,Alt+V}.

    In the \gui{FakeVim} mode, most keystrokes in the main editor will be
963
964
965
    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.
966
967
968
969
970

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

971
972
973
974
975
976
    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)}.
977

978
979
980
    To quit the FakeVim mode, click \gui {Quit FakeVim} or press
    \key{Alt+V,Alt+V}.

981
982
983
984
985
986
987
988
    */


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

990
    \title Using an External Editor
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
991
992
993
994
995
996

    To open the file you are currently viewing in an external editor, select
    \gui Edit > \gui Advanced > \gui{Open in External Editor}.

    To use the external editor of your choice:
    \list 1
997
998
        \o Add the editor path to the \c{PATH} environment variable of your
           operating system.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
999
1000
1001
1002
        \o In Qt Creator select \gui Tools > \gui Options... >
           \gui Environment > \gui General.
        \o In \gui{External editor} enter the name of the application followed
           by \key Space and \tt{\bold %f}. For example, to open the file in
1003
           Smultron, enter \tt{\bold{smultron %f}}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1004
1005

           To further define how to open the file in the external editor, you
1006
           can use the following variables separated by a space:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
           \list
            \o Current line number \tt{\bold %l}
            \o Current column number \tt{\bold %c}
            \o Editor's x position on the screen \tt{\bold %x}
            \o Editor's y position on the screen \tt{\bold %y}
            \o Editor's width in pixels \tt{\bold %w}
            \o Editor's height in pixels \tt{\bold %h}
            \o Editor's width in characters \tt{\bold %W}
            \o Editor's height in characters \tt{\bold %H}
            \o To pass % symbol to the editor \tt{\bold %%}
           \endlist

           \note Not all variables work with all editors.
    \endlist
1021
1022
1023
*/


1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
/*!
    \contentspage index.html
    \previouspage creator-editor-codepasting.html
    \page creator-editor-options.html
    \nextpage creator-editor-fakevim.html

    \title Configuring the Editor

    Qt Creator allows you to configure the text editor to suit your specific
    needs. To configure the editor, select  <