qtcreator.qdoc 352 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1 2
/****************************************************************************
**
Leena Miettinen's avatar
Leena Miettinen committed
3 4 5 6
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
Leena Miettinen's avatar
Leena Miettinen committed
7 8
** Contact: Nokia Corporation (qt-info@nokia.com)
**
Leena Miettinen's avatar
Leena Miettinen committed
9
** No Commercial Usage
Leena Miettinen's avatar
Leena Miettinen committed
10
**
Leena Miettinen's avatar
Leena Miettinen committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
Leena Miettinen's avatar
Leena Miettinen committed
15 16
**
** GNU Free Documentation License
Leena Miettinen's avatar
Leena Miettinen committed
17
**
Leena Miettinen's avatar
Leena Miettinen committed
18 19 20 21 22 23 24 25 26 27
** 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.
**
****************************************************************************/

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

con's avatar
con committed
42
    \section1 Version 2.0.95
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
    You can also join the Qt Creator mailing list. To subscribe,
    send a message with the word \e subscribe to
Leena Miettinen's avatar
Leena Miettinen committed
54
    \l{mailto:qt-creator-request@qt.nokia.com}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
55
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
Leena Miettinen's avatar
Leena Miettinen committed
56
    lists, visit \l{http://lists.qt.nokia.com}{http://lists.qt.nokia.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
       \o \l{Managing Projects}
            \list
                \o \l{Creating a Project}
Leena Miettinen's avatar
Leena Miettinen committed
76
                \o \l{Opening a Project}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
77
                \o \l{Setting Up a qmake Project}
78
                \o \l{Adding Libraries to qmake Projects}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
79 80
                \o \l{Setting Up a CMake Project}
                \o \l{Setting Up a Generic Project}
Leena Miettinen's avatar
Leena Miettinen committed
81 82
                \o \l{Setting Up Development Environment for Maemo}
                \o \l{Setting Up Development Environment for Symbian}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
83
                \o \l{Managing Sessions}
84
                \o \l{Adding New Custom Wizards}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
85
            \endlist
86 87 88 89
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
90
                \o \l{Using Qt Quick Toolbars}
91 92 93 94 95 96 97 98 99 100 101
                \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{Developing Qt Quick Applications}
                \list
                    \o \l {Creating Qt Quick Projects}
102
                    \o \l {Using Qt Quick Designer}
103
                    \o \l {Creating Components}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
104 105
                    \o \l {Creating Buttons}
                    \o \l {Creating Scalable Buttons and Borders}
106 107 108
                    \o \l {Creating Screens}
                    \o \l {Animating Screens}
                    \o \l {Adding User Interaction Methods}
Leena Miettinen's avatar
Leena Miettinen committed
109
                    \o \l {Exporting Designs from Graphics Software}
110 111
                    \o \l {Implementing Application Logic}
                \endlist
112 113 114 115 116
           \o \l{Developing Widget Based Applications}
               \list
                   \o \l{Adding Qt Designer Plugins}
               \endlist
           \o \l{Optimizing Applications for Mobile Devices}
117
       \endlist
118 119
       \o \l{Building and Running Applications}
            \list
120 121
                \o \l{Building Applications for Multiple Targets}
                \o \l{Running Applications on Multiple Targets}
122 123 124 125 126
                \o \l{Specifying Build Settings}
                \o \l{Specifying Run Settings}
                \o \l{Specifying Editor Settings}
                \o \l{Specifying Dependencies}
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
127
       \o \l{Debugging}
128 129 130 131
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
132
                \o \l{Debugger Modes of Operation}
133
                \o \l{Using Debugging Helpers}
134
                \o \l{Debugging Qt Quick Projects}
135
            \endlist
136
       \o \l{Using the Maemo Emulator}
137 138 139 140 141 142 143
       \o \l{Deploying Applications to Mobile Devices}
            \list
                \o \l{Deploying Applications to Symbian Devices}
                \o \l{Deploying Applications to Maemo Devices}
                \o \l{Publishing Applications to Ovi Store}
                \o \l{Building with Remote Compiler}
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
144
       \o \l{Using Version Control Systems}
145
       \o \l{Creating Task List Files}
146
       \o \l{Using Command Line Options}
147
       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
148 149 150 151 152
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
153 154 155
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
156

con's avatar
con committed
157 158
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
159
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
160 161 162 163 164
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

Leena Miettinen's avatar
Leena Miettinen committed
165
    Qt Creator is an integrated development environment (IDE) that provides you with
Leena Miettinen's avatar
Leena Miettinen committed
166 167 168 169 170
    tools to design and develop applications with the Qt application framework. Qt is designed for
    developing applications and user interfaces once and deploying them across several
    desktop and mobile operating systems. Qt Creator provides you with tools for
    accomplishing your tasks throughout the whole application development life-cycle,
    from creating a project to deploying the application on the target platforms.
171

172
    \image qtcreator-overview.png "Qt Creator overview"
173

174
    \section1 Cross-platform Development
175

Leena Miettinen's avatar
Leena Miettinen committed
176 177 178 179
    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.

180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    The recommended way to build a project is to use a version control system.
    Store and edit only project source files and the .pro and .pri files (for qmake)
    or CMakeLists.txt and *.cmake files (for CMake). Do not store
    files generated by the build system or Qt Creator, such as makefiles,
    .pro.user, and object files. Other approaches are possible,
    but we recommend that you do not use network resources, for example.

    Qt Creator allows you to specify separate build settings
    for each development platform. By default, \l{glossary-shadow-build}{shadow builds} are used to
    keep the build specific files separate from the source.

    You can create separate versions of project files to keep platform-dependent
    code separate. You can use qmake
    \l{http://qt.nokia.com/doc/4.7/qmake-tutorial.html#adding-platform-specific-source-files}{scopes}
    to select the file to process depending on which platform qmake is run on.

Leena Miettinen's avatar
Leena Miettinen committed
196
    Items such as open files, breakpoints, and watchers are stored in
197 198 199
    sessions. They are not considered to be part of the
    information shared across platforms.

Leena Miettinen's avatar
Leena Miettinen committed
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
    \section1 Creating Projects

    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.

    Creating a project allows you to:

        \list

            \o Group files together

            \o Add custom build steps

            \o Include forms and resource files

            \o Specify settings for running applications

        \endlist

    Setting up a new project in Qt Creator is aided by a wizard that guides
    you step-by-step through the project creation process. In the first step, you
    select the type of the project from the categories: Qt C++ project, Qt Quick
    Project, or other project. Next, you select a location for the project and
    specify settings for it.

    \image qtcreator-new-qt-quick-project-wizard.png

    When you have completed the steps, Qt Creator automatically generates the
    project with required headers, source files, user interface descriptions
    and project files, as defined by the wizard.
    For example, if you choose to create a Qt Quick application, Qt Creator
    generates a QML file that you can modify with the integrated \QMLD.

    \section2 Adding Libraries
235 236 237 238 239 240

    In addition to Qt libraries, you can link your application to other
    libraries, such as system libraries or your own libraries. Further, your
    own libraries might link to other libraries. To be able to compile your
    project, you must add the libraries to your project. This also enables
    code completion and syntax highlighting for the libraries.
Leena Miettinen's avatar
Leena Miettinen committed
241
    The procedure of adding a library to a project depends on the build
242 243
    system that you use.

Leena Miettinen's avatar
Leena Miettinen committed
244
    \section2 Version Control Systems
245

Leena Miettinen's avatar
Leena Miettinen committed
246 247
    Qt Creator uses the version control system's command line clients to access
    your repositories. The following version control systems are supported:
248

Leena Miettinen's avatar
Leena Miettinen committed
249
    \list
250

Leena Miettinen's avatar
Leena Miettinen committed
251
        \o Git
252

Leena Miettinen's avatar
Leena Miettinen committed
253
        \o Subversion
254

Leena Miettinen's avatar
Leena Miettinen committed
255
        \o Perforce
256

Leena Miettinen's avatar
Leena Miettinen committed
257
        \o CVS
258

Leena Miettinen's avatar
Leena Miettinen committed
259
        \o Mercurial
260

Leena Miettinen's avatar
Leena Miettinen committed
261
    \endlist
262

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

Leena Miettinen's avatar
Leena Miettinen committed
269
    \section1 Designing User Interfaces
270

Leena Miettinen's avatar
Leena Miettinen committed
271
    Qt Creator provides two integrated visual editors, \QMLD and \QD.
272

Leena Miettinen's avatar
Leena Miettinen committed
273
    \image qtcreator-ui-designers.png "Qt Quick Designer and Qt Designer"
274

Leena Miettinen's avatar
Leena Miettinen committed
275 276 277 278 279
    Large high-resolution screens, touch input, and significant graphics power
    are becoming common in portable consumer devices, such as mobile
    phones, media players, set-top boxes, and netbooks. To fully benefit from
    these features and to create intuitive, modern-looking, fluid user interfaces,
    you can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.
280

Leena Miettinen's avatar
Leena Miettinen committed
281 282 283 284
    Qt Quick consists of a rich set of user interface elements, a declarative
    language for describing user interfaces, and a language runtime. A
    collection of C++ APIs is used to integrate these high level features with
    classic Qt applications.
285

Leena Miettinen's avatar
Leena Miettinen committed
286 287
    You can edit QML code in the code editor or in the integrated \QMLD.
    The integration includes project management and code completion.
Leena Miettinen's avatar
Leena Miettinen committed
288

Leena Miettinen's avatar
Leena Miettinen committed
289 290 291 292
    If you need a traditional user interface that is clearly structured and
    enforces a platform look and feel, you can use the integrated \QD. You can
    compose and customize your widgets or dialogs and test them using different
    styles and resolutions.
Leena Miettinen's avatar
Leena Miettinen committed
293

Leena Miettinen's avatar
Leena Miettinen committed
294
    \section1 Coding
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312

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

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

317
    \endlist
Leena Miettinen's avatar
Leena Miettinen committed
318

Leena Miettinen's avatar
Leena Miettinen committed
319
    You can use the code editor to write code in Qt C++ or in the
Leena Miettinen's avatar
Leena Miettinen committed
320
    QML declarative programming language.
Leena Miettinen's avatar
Leena Miettinen committed
321 322 323 324
    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
325

Leena Miettinen's avatar
Leena Miettinen committed
326
    \section1 Building
327

Leena Miettinen's avatar
Leena Miettinen committed
328 329 330
    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.
Leena Miettinen's avatar
Leena Miettinen committed
331

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

Leena Miettinen's avatar
Leena Miettinen committed
336 337 338 339
    When you install the \QSDK, the build and run settings for the Maemo and Symbian
    targets are set up automatically. However, you need to install and configure some
    additional software on the devices to be able to connect to them from the
    development PC.
Leena Miettinen's avatar
Leena Miettinen committed
340

Leena Miettinen's avatar
Leena Miettinen committed
341 342
    \note The only supported build system for mobile applications in Qt
    Creator is qmake.
Leena Miettinen's avatar
Leena Miettinen committed
343

Leena Miettinen's avatar
Leena Miettinen committed
344
    \section1 Testing
Leena Miettinen's avatar
Leena Miettinen committed
345

Leena Miettinen's avatar
Leena Miettinen committed
346 347 348 349 350 351
    If you install Qt Creator as part of \QSDK, 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.
    You can connect mobile devices to your development PC and debug processes
    running on the devices.
Leena Miettinen's avatar
Leena Miettinen committed
352

Leena Miettinen's avatar
Leena Miettinen committed
353 354 355
    You can test applications that are intended for mobile devices in the Qt
    Simulator and Maemo Emulator, but you also need to test the applications
    on real devices.
Leena Miettinen's avatar
Leena Miettinen committed
356

Leena Miettinen's avatar
Leena Miettinen committed
357
    \section2 Debuggers
Leena Miettinen's avatar
Leena Miettinen committed
358

Leena Miettinen's avatar
Leena Miettinen committed
359
    Qt Creator is integrated to several external native debuggers:
Leena Miettinen's avatar
Leena Miettinen committed
360 361 362 363 364 365 366

    \list

        \o GNU Symbolic Debugger (gdb)

        \o Microsoft Console Debugger (CDB)

Leena Miettinen's avatar
Leena Miettinen committed
367
        \o internal JavaScript debugger
Leena Miettinen's avatar
Leena Miettinen committed
368 369 370

    \endlist

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    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
389 390 391
    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.
392 393 394 395 396 397 398 399 400 401 402

    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.

Leena Miettinen's avatar
Leena Miettinen committed
403
    \section3 QML Script Console
Leena Miettinen's avatar
Leena Miettinen committed
404

Leena Miettinen's avatar
Leena Miettinen committed
405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
    You can use the Qt Creator \gui Debug mode to inspect the state of
    the application while debugging JavaScript functions. You can set breakpoints,
    view call stack trace, and examine locals and watchers.

    When the application is interrupted by a breakpoint, you can use the \gui {QML
    Script Console} to execute JavaScript expressions in the current context. You can
    type JavaScript expressions and use them to get information about the state of the
    application, such as property values.

    If you change property values or add properties in the code editor, the
    changes are updated in the running application when they are saved.

    \section3 QML Observer

    While the application is running, you can use the \gui {QML Observer} view to
    explore the object structure, debug animations, and inspect colors. When debugging
    complex applications, you can use the observe mode to jump to the position in code
    where an element is defined.

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

    The Qt Simulator is installed as part of the \QSDK. After it is
    installed, you can select it as a build target in Qt Creator.

    \section2 Maemo Emulator

    The Maemo emulator emulates the Nokia N900 device environment. You can test
    applications in conditions practically identical to running the application
    on a Nokia N900 device with the software update release 1.2 (V10.2010.19-1).
    However, it is faster to test on a real device connected to the development
    PC.

    The Maemo Emulator is installed as part of the \QSDK. After it is
    installed and configured, you can start it from Qt Creator.

    \section1 Deploying

    Qt Creator deploy configurations handle the packaging of the application as an
    executable and copying it to a location developers want to run the executable at.
    The files can be copied to a location in the file system of the development PC
    or to a mobile device.

    Qt Creator allows you to create installation packages for Symbian and Maemo
    devices that are suitable for publishing on Ovi Store and other channels.
454

Leena Miettinen's avatar
Leena Miettinen committed
455 456 457 458 459
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
460 461 462 463 464 465 466 467 468 469
    \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
470
        \o Windows 7
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
471 472
        \o Windows XP Service Pack 2
        \o Windows Vista
473
        \o (K)Ubuntu Linux 8.04 (32-bit and 64-bit) or later, with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
474 475 476 477 478 479 480 481 482 483 484 485 486 487 488
           \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
489
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
490
           \endlist
491
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
492 493 494 495 496 497
           \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

498 499
         \omit  ## Are the Xcode tools still needed separately? \endomit

500
    \section1 Compiling Qt Creator from Source
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
501

502 503
    To build Qt Creator itself from the source, see the requirements and
    instructions in the readme file that is located in the source repository.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
504

505 506 507 508 509 510 511 512 513 514 515 516 517 518
    \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
519 520 521

    \table
        \header
522 523
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
524 525 526
        \header
            \o Desktop
            \o Symbian
527
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
528 529 530 531
        \row
            \o Windows
            \o Yes
            \o Yes
532
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
533 534 535 536
        \row
            \o Linux
            \o Yes
            \o No
537
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
538 539 540 541
        \row
            \o Mac OS X
            \o Yes
            \o No
542
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
543 544 545 546 547 548 549
    \endtable
*/


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

553
    \title Qt Creator User Interface
con's avatar
con committed
554 555 556

    \image qtcreator-breakdown.png

557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
    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.
578 579 580 581
    The following image displays an example application in \gui Edit mode
    and \gui Design mode.

    \image qtcreator-qt-quick-editors.png "Edit mode and Design mode"
582

583 584 585 586 587
    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
588
    \section1 Qt Creator Modes
con's avatar
con committed
589

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
590
    The mode selector allows you to quickly switch between tasks such as
591 592
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
593 594
    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
595

596 597
    You can use Qt Creator in the following modes:

con's avatar
con committed
598
    \list
599
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
600
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
601 602
           application user interfaces. This mode is available for UI files (.ui or
           .qml).
603 604
        \o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your program while
           debugging.
605
        \o \gui{\l{Specifying Build Settings}{Projects}} mode for configuring project building and
606
           execution. This mode is available when a project is open.
607
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
608 609
    \endlist

610
    Certain actions in Qt Creator trigger a mode change. Clicking on
611
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
612
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
613 614


615
    \section1 Browsing Project Contents
con's avatar
con committed
616

617
    The sidebar is available in the \gui Edit and \gui Debug modes.
618 619
    Use the sidebar to browse projects, files, and bookmarks, and to view
    the class hierarchy.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
620
    \image qtcreator-sidebar.png
con's avatar
con committed
621

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
622 623 624 625 626
    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{Open Documents} shows currently open files.
627 628 629 630 631 632 633 634 635
        \o \gui Bookmarks shows all bookmarks for the current session.
        \o \gui{File System} shows all files in the currently selected
            directory.
        \o \gui {Class View} shows the class hierarchy of the currently
            open projects.
        \o \gui Outline shows the element hierarchy of a QML file.
        \o \gui {Type Hierarchy} shows the base classes of a class. For
            more information, see \l{Viewing Type Hierarchy}.

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
636
    \endlist
con's avatar
con committed
637

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
638 639 640 641 642
    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
643
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
644 645 646 647
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
648

649 650
    The additional options in each view are described in the following
    sections.
con's avatar
con committed
651

652
    \section2 Viewing Project Files
con's avatar
con committed
653

654 655 656
    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
657

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
658 659
    You can use the project tree in the following ways:
    \list
660 661
        \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
662
           For example, through the menu of the project root directory you can,
663
           among other actions, build, re-build, clean and run the project.
664
        \o To hide the categories and sort project files alphabetically, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
665
           \inlineimage qtcreator-filter.png
666
           and select \gui{Simplify Tree}.
667 668
        \o To hide source files which are automatically generated by the build
           system, during a build, click \inlineimage qtcreator-filter.png
669 670 671
           and select \gui{Hide Generated Files}.
        \o To keep the position in the project tree synchronized with the file
           currently opened in the editor, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
672 673 674 675
           \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
676 677
    \endlist

678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
    \section2 Viewing the File System

    If you cannot see a file in the \gui Projects view, switch to the
    \gui {File System} view, which shows all the files in the file system.

    To keep the position in the tree synchronized with the file
    opened in the editor, click
    \inlineimage qtcreator-synchronizefocus.png
    .

    \section2 Viewing the Class Hierarchy

    The \gui {Class View} shows the class hierarchy of the currently
    open projects. To organize the view by subprojects, click
    \inlineimage qtcreator-show-subprojects.png
    .

    \section2 Viewing QML Elements

    The \gui Outline view shows the element hierarchy in a QML file.

    \list

        \o To see a complete list of all bindings, click
           \inlineimage qtcreator-filter.png
           and select \gui{Show All Bindings}.

        \o To keep the position in the view synchronized with the element
           selected in the editor, click
           \inlineimage qtcreator-synchronizefocus.png
           .

    \endlist
con's avatar
con committed
711

712
    \section1 Viewing Output
con's avatar
con committed
713

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
714
    The task pane in Qt Creator can display one of the following panes:
715 716 717 718 719
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
720 721
       \o  \gui{General Messages}
       \o  \gui{Version Control}
722 723 724
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
725 726 727
    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
728

Leena Miettinen's avatar
Leena Miettinen committed
729 730 731 732 733
    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.

734 735 736
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

737

738
    \section2 Build Issues
con's avatar
con committed
739

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

744 745 746 747
    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.

748
    \image qtcreator-build-issues.png
con's avatar
con committed
749

750 751 752 753 754 755 756
    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}.
757

con's avatar
con committed
758 759
    \section2 Search Results

760 761 762 763 764
    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
765
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
766 767 768

    \image qtcreator-search-pane.png

769

con's avatar
con committed
770 771
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
772
    The \gui{Application Output} pane displays the status of a program when
773 774 775
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
776 777 778

    \image qtcreator-application-output.png

779

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
780
    \section2 Compile Output
con's avatar
con committed
781

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

    \image qtcreator-compile-pane.png

788 789 790 791 792 793 794 795 796 797
    \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.

*/

798

799 800
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
801
    \previouspage creator-cli.html
802 803
    \page creator-help.html
    \nextpage creator-tips.html
804

805
    \title Getting Help
con's avatar
con committed
806

807
    Qt Creator comes fully integrated with Qt documentation and
808
    examples using the Qt Help plugin.
809

810
    \list
811 812 813 814 815 816 817
        \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.
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
818 819
    \endlist

820 821 822 823 824 825 826 827 828
    The following image displays the \gui Search pane in the \gui Help mode.

    \image qtcreator-help-search.png

    The following image displays the context sensitive help in the \gui Edit
    mode.

    \image qtcreator-context-sensitive-help.png

829 830
    \section1 Finding Information in Qt Documentation

831
    Qt Creator, \QSDK and other Qt deliverables contain documentation
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
    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.

877
    \section1 Adding External Documentation
con's avatar
con committed
878

879 880
    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
881 882 883 884 885
    \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
886
           \l{http://doc.qt.nokia.com/4.7/qthelp-framework.html}{The Qt Help Framework}.
887
        \o To add the .qch file to Qt Creator, select \gui Tools >
888
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
889
    \endlist
con's avatar
con committed
890

891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
    \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.

906
    \section1 Using Documentation Filters
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945

    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
946

947
*/
948

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
949

950 951 952 953
/*!
    \contentspage index.html
    \previouspage creator-editor-external.html
    \page creator-design-mode.html
954
    \nextpage creator-visual-editor.html
955

956
    \title Developing Application UI
957

958 959 960 961 962
    Large high-resolution screens, touch input, and significant graphics power
    are becoming common in portable consumer devices, such as mobile
    phones, media players, set-top boxes, and netbooks. To fully benefit from
    these features and to create intuitive, modern-looking, fluid user interfaces,
    you can use \l {http://doc.qt.nokia.com/4.7/qtquick.html}{Qt Quick}.
963

964 965 966 967
    Qt Quick consists of a rich set of user interface elements, a declarative
    language for describing user interfaces, and a language runtime. A
    collection of C++ APIs is used to integrate these high level features with
    classic Qt applications.
968

969
    You can edit QML code in the code editor or in the integrated \QMLD.
970

971
    \image qtcreator-design-mode.png "Design mode"
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
972

973
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
974

975 976 977 978 979
    If you need a traditional user interface that is clearly structured and
    enforces a platform look and feel, you can use the integrated \QD. You can
    compose and customize your widgets or dialogs and test them using different
    styles and resolutions.

980 981 982 983 984
    The following sections describe how to develop application UI:

       \list

           \o \l{Developing Qt Quick Applications}
985 986
           \o \l{Developing Widget Based Applications}
           \o \l{Optimizing Applications for Mobile Devices}
987 988 989 990 991 992 993 994

       \endlist

*/


/*!
    \contentspage index.html
995
    \previouspage quick-application-logic.html
996 997 998
    \page creator-using-qt-designer.html
    \nextpage adding-plugins.html

999 1000 1001 1002 1003 1004 1005
    \title Developing Widget Based Applications

    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.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1006

1007
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1008 1009 1010

    \image qtcreator-formedit.png