qtcreator.qdoc 272 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/****************************************************************************
**
** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial Usage
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in a
** written agreement between you and Nokia.
**
** GNU Free Documentation License
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

28 29 30 31 32 33
// **********************************************************************
// 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.
// **********************************************************************

34

con's avatar
con committed
35 36 37
/*!
    \contentspage{index.html}{Qt Creator}
    \page index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
38
    \nextpage creator-overview.html
con's avatar
con committed
39 40 41

    \title Qt Creator Manual

hjk's avatar
hjk committed
42
    \section1 Version 2.0.90
con's avatar
con committed
43

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

50
    \note Please report bugs and suggestions to the
con's avatar
con committed
51
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
52 53 54
    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
55
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
56
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed
57

58 59
    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
60
    \endraw
61

con's avatar
con committed
62
    \list
Leena Miettinen's avatar
Leena Miettinen committed
63
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
64
       \o \l{Operating Systems and Supported Platforms}
65
       \o \l{Qt Creator User Interface}
66 67
       \o \l{Getting Started}
           \list
68
               \o \l{Building and Running an Example Application}
69
               \o \l{Creating a Qt C++ Application}
70
               \o \l{Creating a Mobile Application with Nokia Qt SDK}
71
               \o \l{Creating a Qt Quick Application}
72
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
73 74 75 76
       \o \l{Managing Projects}
            \list
                \o \l{Creating a Project}
                \o \l{Setting Up a qmake Project}
77
                \o \l{Adding Libraries to qmake Projects}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
78 79
                \o \l{Setting Up a CMake Project}
                \o \l{Setting Up a Generic Project}
Leena Miettinen's avatar
Leena Miettinen committed
80 81
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
82
                \o \l{Managing Sessions}
83
                \o \l{Adding New Custom Wizards}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
84
            \endlist
85 86 87 88
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
89
                \o \l{Using Qt Quick Toolbars}
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
                \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
112 113
       \o \l{Building and Running Applications}
            \list
114
                \o \l{Building for and Running on Multiple Targets}
115 116 117 118 119
                \o \l{Specifying Build Settings}
                \o \l{Specifying Run Settings}
                \o \l{Specifying Editor Settings}
                \o \l{Specifying Dependencies}
            \endlist
120

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
121
       \o \l{Debugging}
122 123 124 125
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
126
                \o \l{Debugger Modes of Operation}
127 128
                \o \l{Using Debugging Helpers}
            \endlist
129
       \o \l{Using the Maemo Emulator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
130
       \o \l{Using Version Control Systems}
131
       \o \l{Creating Task List Files}
132
       \o \l{Using Command Line Options}
133
       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
134 135 136 137 138
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
139 140 141
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
142

con's avatar
con committed
143 144
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
145
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
146 147 148 149 150
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

Leena Miettinen's avatar
Leena Miettinen committed
151 152 153
    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.
154

155
    \image qtcreator-overview.png "Qt Creator overview"
156

Leena Miettinen's avatar
Leena Miettinen committed
157
    \section1 Projects
158

Leena Miettinen's avatar
Leena Miettinen committed
159 160 161 162 163 164 165
    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.
166

167
    Creating a project allows you to:
168

169
        \list
170

171
            \o Group files together
172

173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
            \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.
190

Leena Miettinen's avatar
Leena Miettinen committed
191 192 193 194 195 196
    \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
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214

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

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

219
    \endlist
Leena Miettinen's avatar
Leena Miettinen committed
220

Leena Miettinen's avatar
Leena Miettinen committed
221
    \section2 UI Designer
Leena Miettinen's avatar
Leena Miettinen committed
222

223 224 225 226 227 228 229
    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
230 231 232 233
    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.
234

235 236 237 238 239 240 241
    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
Leena Miettinen's avatar
Leena Miettinen committed
242
    language called \l {http://doc.qt.nokia.com/4.7/qtquick.html}{QML}.
243 244 245 246 247 248 249 250
    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
251
      \section1 Languages
252

Leena Miettinen's avatar
Leena Miettinen committed
253
    You can use the code editor to write code in Qt C++ or in the
Leena Miettinen's avatar
Leena Miettinen committed
254
    \l {http://doc.qt.nokia.com/4.7/qtquick.html}{QML} declarative
Leena Miettinen's avatar
Leena Miettinen committed
255
    programming language.
256

Leena Miettinen's avatar
Leena Miettinen committed
257
    \section2 QML
258

Leena Miettinen's avatar
Leena Miettinen committed
259 260 261 262
    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.
263

Leena Miettinen's avatar
Leena Miettinen committed
264 265 266 267
    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
268

Leena Miettinen's avatar
Leena Miettinen committed
269
    \section1 Targets
Leena Miettinen's avatar
Leena Miettinen committed
270

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

275 276 277 278
    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
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
    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
319

Leena Miettinen's avatar
Leena Miettinen committed
320 321
    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
322

Leena Miettinen's avatar
Leena Miettinen committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
    \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

338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
    You can use the Qt Creator \gui Debug mode to inspect the state of your
    application while debugging. You can interact with the debugger in several
    ways, including the following:

    \list
        \o Go through a program line-by-line or instruction-by-instruction.
        \o Interrupt running programs.
        \o Set breakpoints.
        \o Examine the contents of the call stack.
        \o Examine and modify registers and memory contents of
           the debugged program.
        \o Examine and modify registers and memory contents of
           local and global variables.
        \o Examine the list of loaded shared libraries.
        \o Create snapshots of the current state of the debugged program
           and re-examine them later.
    \endlist

Leena Miettinen's avatar
Leena Miettinen committed
356 357 358
    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.
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373

    In addition to the generic IDE functionality provided by stack view, views for
    locals and watchers, registers, and so on, Qt Creator includes
    features to make debugging Qt-based applications easy. The debugger
    plugin understands the internal layout of several Qt classes, for
    example, QString, the Qt containers, and most importantly QObject
    (and classes derived from it), as well as most containers of the C++
    Standard Library and some gcc and Symbian extensions. This
    deeper understanding is used to present objects of such classes in
    a useful way.

    If you install Qt Creator as part of a Qt SDK, the GNU Symbolic Debugger
    is installed automatically and you should be ready to start debugging after
    you create a new project. However, you can change the setup to use debugging
    tools for Windows, for example.
Leena Miettinen's avatar
Leena Miettinen committed
374 375 376

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

Leena Miettinen's avatar
Leena Miettinen committed
378 379 380 381 382
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
383 384 385 386 387 388 389 390 391 392 393 394
    \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
395
        \o (K)Ubuntu Linux 7.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
           \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
411
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
412
           \endlist
413
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
414 415 416 417 418 419
           \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

420 421 422
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
423 424 425

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

430 431 432 433 434 435 436 437 438 439 440 441 442 443
    \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
444 445 446

    \table
        \header
447 448
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
449 450 451
        \header
            \o Desktop
            \o Symbian
452
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
453 454 455 456
        \row
            \o Windows
            \o Yes
            \o Yes
457
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
458 459 460 461
        \row
            \o Linux
            \o Yes
            \o No
462
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
463 464 465 466
        \row
            \o Mac OS X
            \o Yes
            \o No
Leena Miettinen's avatar
Leena Miettinen committed
467
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
468 469 470 471 472 473 474
    \endtable
*/


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

478
    \title Qt Creator User Interface
con's avatar
con committed
479 480 481

    \image qtcreator-breakdown.png

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
    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.

504 505 506 507 508
    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
509
    \section1 Qt Creator Modes
con's avatar
con committed
510

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
511
    The mode selector allows you to quickly switch between tasks such as
512 513
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
514 515
    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
516

517 518
    You can use Qt Creator in the following modes:

con's avatar
con committed
519
    \list
520
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
521
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
522 523
           application user interfaces. This mode is available for UI files (.ui or
           .qml).
524 525 526
        \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
527
           execution. This mode is available when a project is open.
528
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
529 530
    \endlist

531
    Certain actions in Qt Creator trigger a mode change. Clicking on
532
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
533
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
534 535


536
    \section1 Browsing Project Contents
con's avatar
con committed
537

538
    The sidebar is available in the \gui Edit and \gui Debug modes.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
539 540
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
541

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
542 543 544 545 546 547 548 549 550
    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
551

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
552 553 554 555 556
    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
557
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
558 559 560 561
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
562 563


564
    \section2 Viewing Project Files
con's avatar
con committed
565

566 567 568
    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
569

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
570 571
    You can use the project tree in the following ways:
    \list
572 573
        \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
574
           For example, through the menu of the project root directory you can,
575
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
576 577
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
578 579 580 581
           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
582 583 584 585 586 587
        \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
588 589 590
    \endlist


591
    \section1 Viewing Output
con's avatar
con committed
592

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
593
    The task pane in Qt Creator can display one of the following panes:
594 595 596 597 598
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
599 600
       \o  \gui{General Messages}
       \o  \gui{Version Control}
601 602 603
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
604 605 606
    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
607

Leena Miettinen's avatar
Leena Miettinen committed
608 609 610 611 612
    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.

613 614 615
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

616

617
    \section2 Build Issues
con's avatar
con committed
618

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

623 624 625 626
    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.

627
    \image qtcreator-build-issues.png
con's avatar
con committed
628

629 630 631 632 633 634 635
    To view task lists in the \gui{Build Issues} pane, click
    \inlineimage qtcreator-filter.png
    and select \gui{My Tasks}. Entries from a task list file (.tasks) are
    imported to the pane. Press \key F6 and \key Shift+F6 to jump from one issue
    to the next.

    For more information about creating task files, see \l{Creating Task List Files}.
636

con's avatar
con committed
637 638
    \section2 Search Results

639 640 641 642 643
    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
644
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
645 646 647

    \image qtcreator-search-pane.png

648

con's avatar
con committed
649 650
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
651
    The \gui{Application Output} pane displays the status of a program when
652 653 654
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
655 656 657

    \image qtcreator-application-output.png

658

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
659
    \section2 Compile Output
con's avatar
con committed
660

661 662 663
    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
664 665 666

    \image qtcreator-compile-pane.png

667 668 669 670 671 672 673 674 675 676
    \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.

*/

677

678 679
/*!
    \contentspage index.html
680
    \previouspage creator-task-lists.html
681 682
    \page creator-help.html
    \nextpage creator-tips.html
683

684
    \title Getting Help
con's avatar
con committed
685

686
    Qt Creator comes fully integrated with Qt documentation and
687
    examples using the Qt Help plugin.
688
    \list
689 690 691 692 693
        \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
694

695
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
696

697 698
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
699 700
    \endlist

701 702 703 704 705 706 707 708 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 748
    \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.

749
    \section1 Adding External Documentation
con's avatar
con committed
750

751 752
    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
753 754 755 756 757
    \list 1
        \o Create a .qch file from your documentation.

           For information on how to prepare your documentation and create a
           .qch file, see
Leena Miettinen's avatar
Leena Miettinen committed
758
           \l{http://doc.qt.nokia.com/4.7/qthelp-framework.html}{The Qt Help Framework}.
759
        \o To add the .qch file to Qt Creator, select \gui Tools >
760
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
761
    \endlist
con's avatar
con committed
762

763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
    \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.

778
    \section1 Using Documentation Filters
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817

    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
818

819
*/
820

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
821

822 823 824 825 826
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
    \nextpage creator-usability.html
827

828
    \title Developing Application UI
829

830 831 832
    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.
833

834 835 836 837 838 839 840 841 842 843 844 845 846
    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
Leena Miettinen's avatar
Leena Miettinen committed
847
    language called \l {http://doc.qt.nokia.com/4.7/qtquick.html}{QML}.
848 849 850
    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
851

852
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
853

854
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
855

856
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
857 858 859

    \image qtcreator-formedit.png

860
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
861
    \list 1
862
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
863 864 865 866 867 868 869
           \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

870
    To change \QD properties, select \gui Tools > \gui Options... >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
871 872 873 874 875 876 877 878 879 880 881 882
    \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} >
883
           \gui Preview, or press \key Alt+Shift+R.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
884 885 886 887
        \o To specify embedded device profiles, such as style, font, and screen
           resolution, select \gui{Embedded Design}.
    \endlist

888 889
    To switch between forms and code, use \key Shift+F4.

890
    For more information on \QD, see
Leena Miettinen's avatar
Leena Miettinen committed
891
    \l{http://doc.qt.nokia.com/4.7/designer-manual.html}{Qt Designer Manual}.
892

893
    \section1 Using Qt Quick Designer
894

895
    You can edit .qml files in the visual \QMLD editor or in the
896 897
    code editor.

898
    In \gui Projects, double-click a .qml file to open it in the code
899 900 901
    editor. Then select the \gui {Design} mode to edit the file in the
    visual editor.

902 903 904 905 906 907 908 909
    \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.

910 911 912 913 914 915
    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

916 917
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
918 919 920 921 922 923

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

924
    \o \gui {Properties} pane displays the properties of the selected component.
925 926
     You can also change the properties in the code editor.

927
    \o \gui {State} pane displays the different states of the component. To add
928 929 930 931 932 933
    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
934 935
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
936

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
937 938
/*!
    \contentspage index.html
939
    \previouspage creator-project-wizards.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
940 941
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
942

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
943
    \title Using the Editor
944

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
945
    Qt Creator's code editor is designed to aid you in creating, editing and
946 947 948
    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
949

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
950 951
    \section1 Using the Editor Toolbar

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

    \image qtcreator-editortoolbar-symbols.png

Leena Miettinen's avatar
Leena Miettinen committed
958 959
    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