qtcreator.qdoc 267 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.80
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
    For application designers, Qt Creator provides integrated
    visual editors, \QD
Robert Loehning's avatar
Robert Loehning committed
23
    \if defined(qtquick)
24
    and \QMLD,
Robert Loehning's avatar
Robert Loehning committed
25
    \endif
26
    that you can use to design and develop
27
    application user interfaces.
28 29

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

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

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

con's avatar
con committed
47
    \list
Leena Miettinen's avatar
Leena Miettinen committed
48
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
49
       \o \l{Operating Systems and Supported Platforms}
50
       \o \l{Qt Creator User Interface}
51 52
       \o \l{Getting Started}
           \list
53
               \o \l{Building and Running an Example Application}
54
               \o \l{Creating a Qt C++ Application}
55
               \o \l{Creating a Mobile Application with Nokia Qt SDK}
56
               \o \l{Creating a Qt Quick Application}
57
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
58 59 60 61 62 63
       \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
64 65
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
66 67
                \o \l{Managing Sessions}
            \endlist
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
       \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 {Designing Application UI}
                    \o \l {Creating Components}
                    \o \l {Creating Buttons}
                    \o \l {Creating Scalable Buttons and Borders}
                    \o \l {Creating Screens}
                    \o \l {Creating List Views}
                    \o \l {Animating Screens}
                    \o \l {Adding User Interaction Methods}
                    \o \l {Implementing Application Logic}
                \endlist
           \endif
       \endlist
98 99 100 101 102 103 104 105
       \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
106
       \o \l{Developing Qt Quick Applications}
Leena Miettinen's avatar
Leena Miettinen committed
107
       \o \l{Optimizing Applications for Mobile Devices}
108
       \o \l{Using the Maemo Emulator}
109

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
110
       \o \l{Debugging}
111 112
            \list
            \o \l {Debugging Qt Applications}
113 114 115 116 117 118
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
            \endlist
119 120 121 122 123
            \o \l{Debugging Qt Quick Applications}
                \list
                    \o \l{Using the QML Inspector}
                \endlist
            \endlist
124
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
125
       \o \l{Using Version Control Systems}
126 127

       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
128 129 130 131 132
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
133 134 135
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
136

con's avatar
con committed
137 138
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
139
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
140 141 142 143 144
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

145 146
  Qt Creator provides you with tools to design and develop user interfaces and
  complex applications for multiple desktop and mobile
147 148
  platforms.

149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
  \section1 Designing User Interfaces

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

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

  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.
168 169

  \QMLD allows you to easily develop animations by using a declarative programming
170
  language called \l {http://doc.qt.nokia.com/4.7-snapshot/declarativeui.html}{QML}.
171 172 173
  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
174
  in their state. \QMLD generates the necessary code for you.
175 176 177 178 179

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

180 181
  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
182
  can use Qt or JavaScript to implement the application logic.
183

184
  \section1 Coding Applications
185

Leena Miettinen's avatar
Leena Miettinen committed
186 187 188 189
  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
190 191 192 193 194
      \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
195
      \o Rename symbols in an intelligent way, so that other symbols with the same name
196 197
         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
198 199 200 201 202 203 204 205 206 207
   \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
208 209 210 211
      \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
212 213 214 215 216
      \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
217 218 219
      interface (GUI) application, Qt Creator generates an empty .ui file
      that you can modify with the integrated \QD.

220
      If you choose to create a Qt Quick application, Qt Creator generates a .qml file
221
      that you can modify with the \QMLD visual editor and the code editor.
Leena Miettinen's avatar
Leena Miettinen committed
222 223 224 225 226
*/

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

264 265 266
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
267 268 269

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

274 275 276 277 278 279 280 281 282 283 284 285 286 287
    \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
288 289 290

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


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

322
    \title Qt Creator User Interface
con's avatar
con committed
323 324 325

    \image qtcreator-breakdown.png

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
    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.

348 349 350 351 352
    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
353
    \section1 Qt Creator Modes
con's avatar
con committed
354

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
355
    The mode selector allows you to quickly switch between tasks such as
356 357
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
358 359
    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
360

361 362
    You can use Qt Creator in the following modes:

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

380 381
    Certain actions in Qt Creator trigger a mode change. Clicking on
    \gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
382
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
383 384


385
    \section1 Browsing Project Contents
con's avatar
con committed
386

387
    The sidebar is available in the \gui Edit and \gui Debug modes.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
388 389
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
390

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
391 392 393 394 395 396 397 398 399
    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
400

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
401 402 403 404 405
    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
406
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
407 408 409 410
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
411 412


413
    \section2 Viewing Project Files
con's avatar
con committed
414

415 416 417
    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
418

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


440
    \section1 Viewing Output
con's avatar
con committed
441

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
442
    The task pane in Qt Creator can display one of the following panes:
443 444 445 446 447
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
448 449
       \o  \gui{General Messages}
       \o  \gui{Version Control}
450 451 452
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
453 454 455
    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
456

457 458 459
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

460

461
    \section2 Build Issues
con's avatar
con committed
462

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

467 468 469 470
    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.

471
    \image qtcreator-build-issues.png
con's avatar
con committed
472

473

con's avatar
con committed
474 475
    \section2 Search Results

476 477 478 479 480
    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
481
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
482 483 484

    \image qtcreator-search-pane.png

485

con's avatar
con committed
486 487
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
488
    The \gui{Application Output} pane displays the status of a program when
489 490 491
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
492 493 494

    \image qtcreator-application-output.png

495

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
496
    \section2 Compile Output
con's avatar
con committed
497

498 499 500
    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
501 502 503

    \image qtcreator-compile-pane.png

504 505 506 507 508 509 510 511 512 513
    \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.

*/

514

515 516 517 518 519
/*!
    \contentspage index.html
    \previouspage creator-version-control.html
    \page creator-help.html
    \nextpage creator-tips.html
520

521
    \title Getting Help
con's avatar
con committed
522

523
    Qt Creator comes fully integrated with Qt documentation and
524
    examples using the Qt Help plugin.
525
    \list
526 527 528 529 530
        \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
531

532
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
533

534 535
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
536 537
    \endlist

538
    \section1 Adding External Documentation
con's avatar
con committed
539

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

552
    \section1 Using Documentation Filters
553 554 555 556 557 558 559 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

    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
592

593
*/
594

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
595

596 597 598 599 600
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
    \nextpage creator-usability.html
601

602
    \title Developing Application UI
603 604 605 606 607 608 609 610

    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
611

612
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
613

614
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
615

616
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
617 618 619

    \image qtcreator-formedit.png

620
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
621
    \list 1
622
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
623 624 625 626 627 628 629
           \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

630
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
    \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

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

651
    \section1 Using Qt Quick Designer
652

653
    You can edit .qml files in the visual \QMLD editor or in the
654 655
    code editor.

656
    In \gui Projects, double-click a .qml file to open it in the code
657 658 659
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

660 661 662 663 664 665 666 667
    \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.

668 669 670 671 672 673
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

674 675
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
676 677 678 679 680 681

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

682
    \o \gui {Properties} pane displays the properties of the selected component.
683 684
     You can also change the properties in the code editor.

685
    \o \gui {State} pane displays the different states of the component. To add
686 687 688 689 690 691
    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

692 693 694
    For more information on using the \QMLD visual editor, see
    \l{Developing Qt Quick Applications}.

695 696
    \endif

con's avatar
con committed
697 698
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
699

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
700 701
/*!
    \contentspage index.html
702
    \previouspage creator-project-managing-sessions.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
703 704
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
705

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
706
    \title Using the Editor
707

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
708
    Qt Creator's code editor is designed to aid you in creating, editing and
709 710 711
    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
712

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
713 714
    \section1 Using the Editor Toolbar

715 716 717
    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
718 719 720 721 722

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
723
        \o To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
724 725 726 727 728 729 730 731 732
           \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

733 734
    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
735 736 737 738 739 740 741 742 743


    \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

744
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
745 746 747 748 749 750 751 752 753 754 755 756 757 758
    \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 >
759
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

    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

775
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
776 777 778 779 780 781 782
    \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.

783 784 785
    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
786

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

793
    \section1 Checking Code Syntax
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
794

795 796 797
    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
798 799 800
    \list
        \o Syntax errors are underlined in red.

801 802
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
803 804 805 806 807 808 809 810

           \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
811 812


813 814 815 816 817 818 819 820
    \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
    what you are going to write and complete the code. The code completion
    differs somewhat depending on whether you write Qt code or QML code.

    \section2 Completing Qt Code
821

822 823
    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
824 825 826

    \image qtcreator-codecompletion.png

827 828
    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
829

830 831 832 833
    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.
834
    Select \gui Tools > \gui{Options...} > \gui{Text Editor} > \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
835

836 837 838 839
    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
840 841
    The following table lists available types for code completion and icon
    used for each.
842 843

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
844 845 846
        \header
            \o Icon
            \o Description
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895
        \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
896

897 898 899 900 901 902 903 904 905
    \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
906

907 908
    \section1 Using Bookmarks

909
    To insert or delete a bookmark right-click the line number and select
910 911 912 913
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

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

916
    To go to next bookmark in the current session, press \key{Ctrl+.}.
917 918


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
919 920 921 922 923
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
927

928 929 930 931 932
    \section1 Using Update Code Model

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

933 934
    \note In Qt Creator indexing updates the code automatically. Use
    \gui{Update code model} only as an emergency command.
935

936 937
*/

938

939 940 941 942 943
/*!
    \contentspage index.html
    \previouspage creator-editor-locator.html
    \page creator-editor-codepasting.html
    \nextpage creator-editor-options.html
944

945
    \title Pasting and Fetching Code Snippets
946

947
    In Qt Creator, you can paste snippets of code to a server or fetch
948 949 950 951 952 953 954 955
    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

956
    To configure the server, select \gui{Tools} > \gui{Options...} >
957 958 959 960 961 962 963 964
    \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}.

965
    \note To use \gui{Pastebin.Com}, configure the domain
966 967 968
    prefix in \gui{Tools} > \gui{Options...} > \gui{Code Pasting} >
    \gui{Pastebin.com}.

969
    For example, you might ask colleagues to review a change that you plan to
970
    submit to a version control system. If you use the Git version control system,