qtcreator.qdoc 253 KB
Newer Older
1 2 3 4 5 6
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

7

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

    \title Qt Creator Manual

hjk's avatar
hjk committed
15
    \section1 Version 2.0.90
con's avatar
con committed
16

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

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

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

con's avatar
con committed
35
    \list
Leena Miettinen's avatar
Leena Miettinen committed
36
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
37
       \o \l{Operating Systems and Supported Platforms}
38
       \o \l{Qt Creator User Interface}
39 40
       \o \l{Getting Started}
           \list
41
               \o \l{Building and Running an Example Application}
42
               \o \l{Creating a Qt C++ Application}
43
               \o \l{Creating a Mobile Application with Nokia Qt SDK}
44
               \o \l{Creating a Qt Quick Application}
45
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
46 47 48 49 50 51
       \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
52 53
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
54 55
                \o \l{Managing Sessions}
            \endlist
56 57 58 59
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
60
                \o \l{Using Qt Quick Toolbars}
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
                \o \l{Searching With the Locator}
                \o \l{Pasting and Fetching Code Snippets}
                \o \l{Configuring the Editor}
                \o \l{Using FakeVim Mode}
                \o \l{Using an External Editor}
            \endlist
       \o \l{Developing Application UI}
       \list
           \o \l{Optimizing Applications for Mobile Devices}
           \o \l{Adding Qt Designer Plugins}
           \if defined(qtquick)
           \o \l{Developing Qt Quick Applications}
                \list
                    \o \l {Creating Qt Quick Projects}
                    \o \l {Creating Components}
                    \o \l {Creating Screens}
                    \o \l {Animating Screens}
                    \o \l {Adding User Interaction Methods}
                    \o \l {Implementing Application Logic}
                \endlist
           \endif
       \endlist
83 84
       \o \l{Building and Running Applications}
            \list
85
                \o \l{Building for and Running on Multiple Targets}
86 87 88 89 90
                \o \l{Specifying Build Settings}
                \o \l{Specifying Run Settings}
                \o \l{Specifying Editor Settings}
                \o \l{Specifying Dependencies}
            \endlist
91

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
92
       \o \l{Debugging}
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
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
100
       \o \l{Using Version Control Systems}
101 102

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
111

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

  \title Introducing Qt Creator

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

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

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

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

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

136
    Creating a project allows you to:
137

138
        \list
139

140
            \o Group files together
141

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

            \o Include forms and resource files

            \o Specify settings for running applications

        \endlist

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

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

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

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

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

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

    \list

        \o Enable you to write well formatted code

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

        \o Display inline error and warning messages

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

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

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

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

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

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

192 193 194 195 196 197 198
    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,
Leena Miettinen's avatar
Leena Miettinen committed
199 200 201 202
    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.
203

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
    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.

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

    You use a visual editor to create items, screens, and applications, as well as define changes
    in their state, transitions from one state to another, and user actions that change the
    states. \QMLD generates the necessary code for you.

    You can use Qt or JavaScript to implement the application logic.

con's avatar
con committed
220
      \section1 Languages
221

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

Leena Miettinen's avatar
Leena Miettinen committed
226
    \section2 QML
227

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

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

Leena Miettinen's avatar
Leena Miettinen committed
238
    \section1 Targets
Leena Miettinen's avatar
Leena Miettinen committed
239

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

244 245 246 247
    When you build an application for a mobile device target with a device
    connected to the development PC, Qt Creator generates an installation package,
    installs in on the device, and executes it.

Leena Miettinen's avatar
Leena Miettinen committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
    You can publish the installation packages on the \l{https://publish.ovi.com/info/}{Ovi Store}.
    For Symbian devices, the packages must be signed.

    \section1 Tools

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

    \section2 Version Control Systems

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

    \list

        \o Git

        \o Subversion

        \o Perforce

        \o CVS

        \o Mercurial

    \endlist

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

    \section2 Qt Simulator

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

Leena Miettinen's avatar
Leena Miettinen committed
289 290
    The Qt Simulator is installed as part of the Nokia Qt SDK. After it is
    installed, you can select it as a build target in Qt Creator.
Leena Miettinen's avatar
Leena Miettinen committed
291

Leena Miettinen's avatar
Leena Miettinen committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
    \section1 Debuggers

    Qt Creator does not include a debugger. It provides a debugger plugin that acts
    as an interface between the Qt Creator core and external native debuggers:

    \list

        \o GNU Symbolic Debugger (gdb)

        \o Microsoft Console Debugger (CDB)

        \o internal Java Script debugger

    \endlist

    Qt Creator displays the raw information provided by the native debuggers
    in a clear and concise manner with the goal to simplify the debugging process
    as much as possible without losing the power of the native debuggers.
310
    You can use the native debuggers to debug C++ applications.
Leena Miettinen's avatar
Leena Miettinen committed
311 312 313

    You can connect mobile devices to your development PC and debug processes
    running on the devices.
314

Leena Miettinen's avatar
Leena Miettinen committed
315 316 317 318 319
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
320 321 322 323 324 325 326 327 328 329 330 331
    \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
332
        \o (K)Ubuntu Linux 7.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
           \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
348
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
349
           \endlist
350
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
351 352 353 354 355 356
           \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

357 358 359
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
360 361 362

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

367 368 369 370 371 372 373 374 375 376 377 378 379 380
    \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
381 382 383

    \table
        \header
384 385
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
386 387 388
        \header
            \o Desktop
            \o Symbian
389
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
390 391 392 393
        \row
            \o Windows
            \o Yes
            \o Yes
394
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
395 396 397 398
        \row
            \o Linux
            \o Yes
            \o No
399
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
400 401 402 403
        \row
            \o Mac OS X
            \o Yes
            \o No
Leena Miettinen's avatar
Leena Miettinen committed
404
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
405 406 407 408 409 410 411
    \endtable
*/


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

415
    \title Qt Creator User Interface
con's avatar
con committed
416 417 418

    \image qtcreator-breakdown.png

419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
    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.

441 442 443 444 445
    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
446
    \section1 Qt Creator Modes
con's avatar
con committed
447

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
448
    The mode selector allows you to quickly switch between tasks such as
449 450
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
451 452
    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
453

454 455
    You can use Qt Creator in the following modes:

con's avatar
con committed
456
    \list
457
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
458
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
459 460
           application user interfaces. This mode is available for UI files (.ui or
           .qml).
461 462 463
        \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
464
           execution. This mode is available when a project is open.
465
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
466 467
    \endlist

468
    Certain actions in Qt Creator trigger a mode change. Clicking on
469
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
470
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
471 472


473
    \section1 Browsing Project Contents
con's avatar
con committed
474

475
    The sidebar is available in the \gui Edit and \gui Debug modes.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
476 477
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
478

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
479 480 481 482 483 484 485 486 487
    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
488

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
489 490 491 492 493
    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
494
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
495 496 497 498
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
499 500


501
    \section2 Viewing Project Files
con's avatar
con committed
502

503 504 505
    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
506

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
507 508
    You can use the project tree in the following ways:
    \list
509 510
        \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
511
           For example, through the menu of the project root directory you can,
512
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
513 514
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
515 516 517 518
           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
519 520 521 522 523 524
        \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
525 526 527
    \endlist


528
    \section1 Viewing Output
con's avatar
con committed
529

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
530
    The task pane in Qt Creator can display one of the following panes:
531 532 533 534 535
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
536 537
       \o  \gui{General Messages}
       \o  \gui{Version Control}
538 539 540
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
541 542 543
    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
544

Leena Miettinen's avatar
Leena Miettinen committed
545 546 547 548 549
    To search within the \gui{Application Output} and \gui{Compile Output}
    panes, press \key {Ctrl+F} when the pane is active. Enter search
    criteria in the \gui Find field and click the left and right arrows to
    search down and up in the pane.

550 551 552
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

553

554
    \section2 Build Issues
con's avatar
con committed
555

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

560 561 562 563
    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.

564
    \image qtcreator-build-issues.png
con's avatar
con committed
565

566

con's avatar
con committed
567 568
    \section2 Search Results

569 570 571 572 573
    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
574
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
575 576 577

    \image qtcreator-search-pane.png

578

con's avatar
con committed
579 580
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
581
    The \gui{Application Output} pane displays the status of a program when
582 583 584
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
585 586 587

    \image qtcreator-application-output.png

588

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
589
    \section2 Compile Output
con's avatar
con committed
590

591 592 593
    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
594 595 596

    \image qtcreator-compile-pane.png

597 598 599 600 601 602 603 604 605 606
    \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.

*/

607

608 609 610 611 612
/*!
    \contentspage index.html
    \previouspage creator-version-control.html
    \page creator-help.html
    \nextpage creator-tips.html
613

614
    \title Getting Help
con's avatar
con committed
615

616
    Qt Creator comes fully integrated with Qt documentation and
617
    examples using the Qt Help plugin.
618
    \list
619 620 621 622 623
        \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
624

625
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
626

627 628
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
629 630
    \endlist

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
    \section1 Finding Information in Qt Documentation

    Qt Creator, Qt SDK, Nokia Qt SDK and other Qt deliverables contain documentation
    as .qch files. All the documentation is accessible in the \gui Help mode.

    To find information in the documentation, select:

    \list

        \o \gui Bookmarks to view a list of pages on which you have added bookmarks.

        \o \gui Contents to see all the documentation installed on the development
        PC and to browse the documentation contents.

        \o \gui Index to find information based on a list of keywords in all the
        installed documents.

        \o \gui {Open Pages} to view a list of currently open documentation pages.

        \o \gui Search to search from all the installed documents.

    \endlist

    \section2 Adding Bookmarks to Help Pages

    You can add bookmarks to useful help pages to easily find them later
    in the \gui Bookmarks view. You can either use the page title as the
    bookmark or change it to any text. You can organize the bookmarks in
    folders in the view.

    \image qtcreator-help-add-bookmark-dlg.png "Add Bookmark dialog"

    To add a bookmark to an open help page:

    \list 1

        \o Click the
        \inlineimage qtcreator-help-add-bookmark.png
        (\gui {Add Bookmark}) button on the toolbar.

        \o In the \gui {Add Bookmark} dialog, click \gui OK to save the
        page title as a bookmark in the \gui Bookmarks folder.

    \endlist

    To import and export bookmarks, select \gui {Tools > Options... > Help >
    General Settings > Import} or \gui Export.

679
    \section1 Adding External Documentation
con's avatar
con committed
680

681 682
    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
683 684 685 686 687
    \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
688
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
689
        \o To add the .qch file to Qt Creator, select \gui Tools >
690
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
691
    \endlist
con's avatar
con committed
692

693 694 695 696 697 698 699 700 701 702 703 704 705 706 707
    \section1 Detaching the Help Window

    By default, context-sensitive help is opened in a window next to the
    code editor when you press \key F1. If there is not enough vertical
    space, the help opens in the full-screen help mode.

    You can specify that the help always opens in full-screen mode or
    is detached to an external window. Select \gui {Tools > Options... > Help >
    General Settings} and specify settings for displaying context-sensitive help
    in the \gui {On context help} field. To detach the help window, select
    \gui {Always Show Help in External Window}.

    You can select the help page to open upon startup in the \gui {Home Page}
    field.

708
    \section1 Using Documentation Filters
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747

    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
748

749
*/
750

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
751

752 753 754 755 756
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
    \nextpage creator-usability.html
757

758
    \title Developing Application UI
759

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

764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
    Widgets and forms created with \QD are integrated seamlessly with programmed code,
    using the Qt signals and slots mechanism, that lets you easily assign behavior to
    graphical elements. All properties set in \QD can be changed dynamically within the code.
    Furthermore, features like widget promotion and custom plugins allow you to use your
    own widgets with \QD.

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

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

782
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
783

784
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
785

786
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
787 788 789

    \image qtcreator-formedit.png

790
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
791
    \list 1
792
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
793 794 795 796 797 798 799
           \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

800
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
801 802 803 804 805 806 807 808 809 810 811 812
    \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} >
813
           \gui Preview, or press \key Alt+Shift+R.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
814 815 816 817
        \o To specify embedded device profiles, such as style, font, and screen
           resolution, select \gui{Embedded Design}.
    \endlist

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

821
    \section1 Using Qt Quick Designer
822

823
    You can edit .qml files in the visual \QMLD editor or in the
824 825
    code editor.

826
    In \gui Projects, double-click a .qml file to open it in the code
827 828 829
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

830 831 832 833 834 835 836 837
    \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.

838 839 840 841 842 843
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

844 845
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
846 847 848 849 850 851

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

852
    \o \gui {Properties} pane displays the properties of the selected component.
853 854
     You can also change the properties in the code editor.

855
    \o \gui {State} pane displays the different states of the component. To add
856 857 858 859 860 861
    states, click the empty slot. Then modify the new state in the editor.
    In the code editor, you can see the changes recorded as changes to
    the base state.

    \endlist

con's avatar
con committed
862 863
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
864

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
865 866
/*!
    \contentspage index.html
867
    \previouspage creator-project-managing-sessions.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
868 869
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
870

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
871
    \title Using the Editor
872

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
873
    Qt Creator's code editor is designed to aid you in creating, editing and
874 875 876
    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
877

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
878 879
    \section1 Using the Editor Toolbar

880 881 882
    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
883 884 885

    \image qtcreator-editortoolbar-symbols.png

Leena Miettinen's avatar
Leena Miettinen committed
886 887
    Use the toolbar to navigate between open files and symbols in use.
    To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
888 889 890 891
           \inlineimage qtcreator-back.png
           and \inlineimage qtcreator-forward.png
           .

Leena Miettinen's avatar
Leena Miettinen committed
892 893 894 895 896 897 898 899
    To go to any open file, select it from the \gui{Open files} drop-down menu.
    Right-click the menu title and select \gui {Copy Full Path to Clipboard} to
    copy the path and name of the current file to the clipboard.

    To jump to any symbol used in the current file, select it from the
    \gui Symbols drop-down menu. By default, the symbols are displayed in the
    order in which they appear in the file. Right-click the menu title and select
    \gui {Sort Alphabetically} to arrange the symbols in alphabetic order.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
900 901 902 903 904 905 906 907

    \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

908
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922
    \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 >
923
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
924 925 926 927 928 929 930 931 932 933 934 935 936 937 938

    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

939
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
940 941 942 943 944 945 946
    \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.

947 948 949
    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
950

951 952 953 954 955
    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
956

957
    \section1 Checking Code Syntax
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
958

959 960 961
    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
962 963 964
    \list
        \o Syntax errors are underlined in red.

965 966
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
967 968 969 970 971 972 973 974

           \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
975 976


977 978 979 980
    \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
981
    what you are going to write and complete the code.
Robert Loehning's avatar
Robert Loehning committed
982
    The code completion differs somewhat depending on whether you write Qt code or QML code.
983 984

    \section2 Completing Qt Code
985

986 987
    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
988 989 990

    \image qtcreator-codecompletion.png

991 992
    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
993

994 995 996 997
    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.
998
    Select \gui Tools > \gui{Options...} > \gui{Text Editor} > \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
999

1000 1001 1002 1003
    By default, code completion considers only the first letter case-sensitive.
    To apply full or no