qtcreator.qdoc 409 KB
Newer Older
Leena Miettinen's avatar
Leena Miettinen committed
1
2
/****************************************************************************
**
Leena Miettinen's avatar
Leena Miettinen committed
3
4
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Leena Miettinen's avatar
Leena Miettinen committed
6
**
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

42
    \section1 Version \qtcversion
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}
Leena Miettinen's avatar
Leena Miettinen committed
69
               \o \l{Creating a Qt Widget Based Application}
70
               \o \l{Creating a Mobile Application with 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}
Leena Miettinen's avatar
Leena Miettinen committed
77
                \o \l{Adding New Custom Wizards}
Leena Miettinen's avatar
Leena Miettinen committed
78
                \o \l{Adding Libraries to 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
84
                \o \l{Managing Sessions}
            \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
                \o \l{Searching With the Locator}
                \o \l{Pasting and Fetching Code Snippets}
92
                \o \l{Using Text Editing Macros}
93
94
                \o \l{Configuring the Editor}
                \o \l{Using FakeVim Mode}
Leena Miettinen's avatar
Leena Miettinen committed
95

96
97
98
99
100
101
            \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
                \o \l{Specifying Build Settings}
Leena Miettinen's avatar
Leena Miettinen committed
123
124
125
126
                   \list
                       \o \l{Adding Qt Versions}
                       \o \l{Adding Tool Chains}
                   \endlist
127
128
129
                \o \l{Specifying Editor Settings}
                \o \l{Specifying Dependencies}
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
130
       \o \l{Debugging}
131
132
            \list
                \o \l{Debugging the Example Application}
133
                \o \l{Launching the Debugger}
134
135
136
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
137
                \o \l{Debugging Qt Quick Projects}
138
                \o \l{Detecting Memory Leaks}
139
                \o \l{Troubleshooting Debugger}
140
            \endlist
141
       \o \l{Using the Maemo Emulator}
142
143
144
145
       \o \l{Deploying Applications to Mobile Devices}
            \list
                \o \l{Deploying Applications to Symbian Devices}
                \o \l{Deploying Applications to Maemo Devices}
Leena Miettinen's avatar
Leena Miettinen committed
146
                \o \l{Publishing Maemo Applications to Extras-devel}
147
148
149
                \o \l{Publishing Applications to Ovi Store}
                \o \l{Building with Remote Compiler}
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
150
       \o \l{Using Version Control Systems}
Leena Miettinen's avatar
Leena Miettinen committed
151
       \o \l{Using External Tools}
Leena Miettinen's avatar
Leena Miettinen committed
152
       \o \l{Editing MIME Types}
153
       \o \l{Showing Task List Files in the Build Issues Pane}
154
       \o \l{Using Command Line Options}
155
       \o \l{Getting Help}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
156
       \o \l{Keyboard Shortcuts}
Leena Miettinen's avatar
Leena Miettinen committed
157
158
       \o \l{FAQ}
       \o \l{Tips and Tricks}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
159
160
161
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
162
163
164
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
165

con's avatar
con committed
166
167
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
168
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
169
170
171
172
173
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

Leena Miettinen's avatar
Leena Miettinen committed
174
    Qt Creator is an integrated development environment (IDE) that provides you with
Leena Miettinen's avatar
Leena Miettinen committed
175
176
177
178
179
    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.
180

181
    \image qtcreator-overview.png "Qt Creator overview"
182

183
    \section1 Cross-platform Development
184

Leena Miettinen's avatar
Leena Miettinen committed
185
186
187
188
    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.

189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
    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
205
    Items such as open files, breakpoints, and watchers are stored in
206
207
208
    sessions. They are not considered to be part of the
    information shared across platforms.

Leena Miettinen's avatar
Leena Miettinen committed
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
    \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
Leena Miettinen's avatar
Leena Miettinen committed
231
232
    select the type of the project from the categories: Qt Quick project, Qt widget
    project, or other project. Next, you select a location for the project and
Leena Miettinen's avatar
Leena Miettinen committed
233
234
235
236
237
238
239
240
241
242
243
    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
244
245
246
247
248
249

    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
250
    The procedure of adding a library to a project depends on the build
251
252
    system that you use.

Leena Miettinen's avatar
Leena Miettinen committed
253
    \section2 Version Control Systems
254

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

Leena Miettinen's avatar
Leena Miettinen committed
258
    \list
259

Leena Miettinen's avatar
Leena Miettinen committed
260
        \o Git
261

Leena Miettinen's avatar
Leena Miettinen committed
262
        \o Subversion
263

Leena Miettinen's avatar
Leena Miettinen committed
264
        \o Perforce
265

Leena Miettinen's avatar
Leena Miettinen committed
266
        \o CVS
267

Leena Miettinen's avatar
Leena Miettinen committed
268
        \o Mercurial
269

Leena Miettinen's avatar
Leena Miettinen committed
270
271
        \o Bazaar

Leena Miettinen's avatar
Leena Miettinen committed
272
    \endlist
273

Leena Miettinen's avatar
Leena Miettinen committed
274
275
276
277
278
    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.
279

Leena Miettinen's avatar
Leena Miettinen committed
280
    \section1 Designing User Interfaces
281

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

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

Leena Miettinen's avatar
Leena Miettinen committed
286
287
288
289
290
    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}.
291

Leena Miettinen's avatar
Leena Miettinen committed
292
293
294
295
    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.
296

Leena Miettinen's avatar
Leena Miettinen committed
297
298
    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
299

Leena Miettinen's avatar
Leena Miettinen committed
300
301
302
303
    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
304

Leena Miettinen's avatar
Leena Miettinen committed
305
    \section1 Coding
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323

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

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

328
    \endlist
Leena Miettinen's avatar
Leena Miettinen committed
329

Leena Miettinen's avatar
Leena Miettinen committed
330
    You can use the code editor to write code in Qt C++ or in the
Leena Miettinen's avatar
Leena Miettinen committed
331
    QML declarative programming language.
Leena Miettinen's avatar
Leena Miettinen committed
332
333
334
335
    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
336

Leena Miettinen's avatar
Leena Miettinen committed
337
    \section1 Building
Leena Miettinen's avatar
Leena Miettinen committed
338

Leena Miettinen's avatar
Leena Miettinen committed
339
340
341
    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
342

Leena Miettinen's avatar
Leena Miettinen committed
343
344
345
    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
346

Leena Miettinen's avatar
Leena Miettinen committed
347
348
349
350
    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
351

Leena Miettinen's avatar
Leena Miettinen committed
352
353
    \note The only supported build system for mobile applications in Qt
    Creator is qmake.
Leena Miettinen's avatar
Leena Miettinen committed
354

Leena Miettinen's avatar
Leena Miettinen committed
355
    \section1 Testing
Leena Miettinen's avatar
Leena Miettinen committed
356

Leena Miettinen's avatar
Leena Miettinen committed
357
358
359
360
361
362
    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
363

Leena Miettinen's avatar
Leena Miettinen committed
364
365
366
    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
367

Leena Miettinen's avatar
Leena Miettinen committed
368
    \section2 Debuggers
Leena Miettinen's avatar
Leena Miettinen committed
369

Leena Miettinen's avatar
Leena Miettinen committed
370
    Qt Creator is integrated to several external native debuggers:
Leena Miettinen's avatar
Leena Miettinen committed
371
372
373

    \list

374
        \o GNU Symbolic Debugger (GDB)
Leena Miettinen's avatar
Leena Miettinen committed
375
376
377

        \o Microsoft Console Debugger (CDB)

Leena Miettinen's avatar
Leena Miettinen committed
378
        \o internal JavaScript debugger
Leena Miettinen's avatar
Leena Miettinen committed
379
380
381

    \endlist

382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
    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
400
401
402
    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.
403
404
405
406
407
408
409

    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++
410
    Standard Library and some GCC and Symbian extensions. This
411
412
413
    deeper understanding is used to present objects of such classes in
    a useful way.

Leena Miettinen's avatar
Leena Miettinen committed
414
    \section3 QML Script Console
Leena Miettinen's avatar
Leena Miettinen committed
415

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

447
    The Maemo 5 emulator emulates the Nokia N900 device environment. You can test
Leena Miettinen's avatar
Leena Miettinen committed
448
    applications in conditions practically identical to running the application
449
    on a Nokia N900 device with the software update release 1.3 (V20.2010.36-2).
Leena Miettinen's avatar
Leena Miettinen committed
450
451
452
453
    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
454
    installed, you can start it from Qt Creator.
Leena Miettinen's avatar
Leena Miettinen committed
455
456
457
458
459
460
461
462
463
464

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

Leena Miettinen's avatar
Leena Miettinen committed
466
467
468
469
470
*/

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

509
510
         \omit  ## Are the Xcode tools still needed separately? \endomit

511
    \section1 Compiling Qt Creator from Source
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
512

513
514
    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
515

516
517
518
    \section1 Supported Platforms

    You can develop applications for the following platforms:
519
520
521

    \list

522
523
524
525
526
        \o Desktop

        \o Qt Simulator

        \o Maemo 5
527

528
        \o Symbian
529
530
531

    \endlist

532
    The following table summarizes operating system support for developing
533
    applications for mobile device platforms.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
534
535
536

    \table
        \header
537
538
            \o {1,4} Operating system
            \o {4,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
539
540
        \header
            \o Desktop
541
            \o Qt Simulator
542
            \o Maemo
543
544
            \o Symbian

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
545
546
547
548
        \row
            \o Windows
            \o Yes
            \o Yes
549
            \o Yes
550
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
551
552
553
        \row
            \o Linux
            \o Yes
554
            \o Yes
555
556
            \o Yes
            \o Yes (by using Remote Compiler for building)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
557
558
559
        \row
            \o Mac OS X
            \o Yes
560
            \o Yes
561
562
            \o Yes
            \o Yes (by using Remote Compiler for building)
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
563
564
565
566
567
568
569
    \endtable
*/


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

573
    \title Qt Creator User Interface
con's avatar
con committed
574
575
576

    \image qtcreator-breakdown.png

577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
    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.
598
599
600
601
    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"
602

603
604
605
606
607
    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
608
    \section1 Qt Creator Modes
con's avatar
con committed
609

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
610
    The mode selector allows you to quickly switch between tasks such as
611
612
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
613
614
    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
615

616
617
    You can use Qt Creator in the following modes:

con's avatar
con committed
618
    \list
619
        \o \gui Welcome mode for opening projects.
620
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
621
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
622
623
           application user interfaces. This mode is available for UI files (.ui or
           .qml).
624
625
        \o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your program while
           debugging.
626
        \o \gui{\l{Specifying Build Settings}{Projects}} mode for configuring project building and
627
           execution. This mode is available when a project is open.
628
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
629
630
    \endlist

631
    Certain actions in Qt Creator trigger a mode change. Clicking on
632
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
633
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
634
635


636
    \section1 Browsing Project Contents
con's avatar
con committed
637

638
    The sidebar is available in the \gui Edit and \gui Debug modes.
639
640
    Use the sidebar to browse projects, files, and bookmarks, and to view
    the class hierarchy.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
641
    \image qtcreator-sidebar.png
con's avatar
con committed
642

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
643
644
645
646
647
    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.
648
649
650
651
652
        \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.
653
        \o \gui Outline shows the symbol hierachy of a C++ file and the element hierarchy of a QML file.
654
        \o \gui {Type Hierarchy} shows the base classes of a class.
655

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
656
    \endlist
con's avatar
con committed
657

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
658
659
660
661
662
    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
663
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
664
665
666
667
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
668

669
670
    The additional options in each view are described in the following
    sections.
con's avatar
con committed
671

672
    \section2 Viewing Project Files
con's avatar
con committed
673

674
675
676
    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
677

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
678
679
    You can use the project tree in the following ways:
    \list
680
681
        \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
682
           For example, through the menu of the project root directory you can,
683
           among other actions, build, re-build, clean and run the project.
684
        \o To hide the categories and sort project files alphabetically, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
685
           \inlineimage qtcreator-filter.png
686
           and select \gui{Simplify Tree}.
687
688
        \o To hide source files which are automatically generated by the build
           system, during a build, click \inlineimage qtcreator-filter.png
689
690
691
           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
692
693
694
695
           \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
696
697
    \endlist

698
699
700
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
    \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
731

732
733
734
735
736
    \section2 Viewing Type Hierarchy

    To view the base classes of a class, right-click the class and select
    \gui {Open Type Hierarchy}  or press \key {Ctrl+Shift+T}.

737
    \section1 Viewing Output
con's avatar
con committed
738

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
739
    The task pane in Qt Creator can display one of the following panes:
740
741
742
743
744
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
745
746
       \o  \gui{General Messages}
       \o  \gui{Version Control}
747
748
749
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
750
751
752
    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
753

Leena Miettinen's avatar
Leena Miettinen committed
754
755
756
757
758
    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.

759
760
761
    To open the \gui{General Messages} and \gui{Version Control}
    panes, select \gui {Window > Output Panes}.

762

763
    \section2 Build Issues
con's avatar
con committed
764

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

769
770
771
772
    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.

773
    \image qtcreator-build-issues.png
con's avatar
con committed
774

775
776
777
778
779
780
    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.

781
782
    For more information about creating task files, see
    \l{Showing Task List Files in the Build Issues Pane}.
783

con's avatar
con committed
784
785
    \section2 Search Results

786
787
788
789
790
    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
791
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
792
793
794

    \image qtcreator-search-pane.png

795

con's avatar
con committed
796
797
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
798
    The \gui{Application Output} pane displays the status of a program when
799
800
801
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
802
803
804

    \image qtcreator-application-output.png

805

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
806
    \section2 Compile Output
con's avatar
con committed
807

808
809
810
    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
811
812
813

    \image qtcreator-compile-pane.png

814
815
816
817
818
819
820
821
822
823
    \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.

*/

824

825
826
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
827
    \previouspage creator-cli.html
828
    \page creator-help.html
829
    \nextpage creator-keyboard-shortcuts.html
830

831
    \title Getting Help
con's avatar
con committed
832

833
    Qt Creator comes fully integrated with Qt documentation and
834
    examples using the Qt Help plugin.
835

836
    \list
837
838
839
840
841
842
843
        \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.
844
845
    \endlist

846
847
848
849
850
851
852
853
854
    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

855
856
    \section1 Finding Information in Qt Documentation

857
    Qt Creator, \QSDK and other Qt deliverables contain documentation
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
    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.

903
    \section1 Adding External Documentation
con's avatar
con committed
904

905
906
    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
907
908
909
910
911
    \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
912
           \l{http://doc.qt.nokia.com/4.7/qthelp-framework.html}{The Qt Help Framework}.
913
        \o To add the .qch file to Qt Creator, select \gui Tools >
914
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
915
    \endlist
con's avatar
con committed
916

917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
    \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.

932
    \section1 Using Documentation Filters
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971

    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
972

973
*/
974

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
975

976
977
/*!
    \contentspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
978
    \previouspage creator-editor-fakevim.html
979
    \page creator-design-mode.html
980
    \nextpage creator-visual-editor.html
981

982
    \title Developing Application UI
983

984
985
986
987
988
    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}.
989

990
991
992
993
    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.
994

995
    You can edit QML code in the code editor or in the integrated \QMLD.
996

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

999
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1000

1001
1002
1003
1004
1005
    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.

1006
1007
1008
1009
1010
    The following sections describe how to develop application UI:

       \list

           \o \l{Developing Qt Quick Applications}
1011
1012
           \o \l{Developing Widget Based Applications}
           \o \l{Optimizing Applications for Mobile Devices}
1013
1014
1015
1016
1017
1018
1019
1020

       \endlist

*/


/*!
    \contentspage index.html
1021
    \previouspage quick-application-logic.html