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

7

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

    \title Qt Creator Manual

con's avatar
con committed
15
    \section1 Version 1.3.82
con's avatar
con committed
16

17 18 19 20 21 22 23 24 25
    Qt Creator provides integrated tools for both application designers
    and developers to create applications for desktop and mobile device
    platforms.

    For application designers, Qt Creator provides an integrated \QMLD
    tool that you can use to design and develop application UIs for mobile
    devices.

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

31
    \note Please report bugs and suggestions to the
con's avatar
con committed
32
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
33 34 35
    You can also join the Qt Creator mailing list. To subscribe,
    send a message with the word \e subscribe to
    \l{mailto:qt-creator-request@trolltech.com}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
36
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
37
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed
38

39 40
    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
41
    \endraw
42

con's avatar
con committed
43
    \list
Leena Miettinen's avatar
Leena Miettinen committed
44
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
       \o \l{Operating Systems and Supported Platforms}
       \o \l{Quick Tour}
       \o \l{Writing a Simple Program}
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
                \o \l{Searching With the Locator}
            \endlist
       \o \l{Managing Projects}
            \list
                \o \l{Creating a Project}
                \o \l{Setting Up a qmake Project}
                \o \l{Setting Up a CMake Project}
                \o \l{Setting Up a Generic Project}
                \o \l{Managing Sessions}
            \endlist
62
       \o \l{Developing Mobile Applications}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
63
            \list
64
                \o \l{Implementing Application UI}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
65 66 67 68 69
                \o \l{Developing Maemo Applications}
                \o \l{Developing Symbian Applications}
            \endlist
       \o \l{Debugging}
       \o \l{Using Version Control Systems}
70
       \o \l{Adding Qt Designer Plugins}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
71 72 73 74 75
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
76 77 78
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
79

con's avatar
con committed
80 81
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
82
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
83 84 85 86 87
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

88 89 90 91 92 93 94 95 96 97 98 99 100 101
  Qt Creator provides you with tools to design and develop animated applications for
  mobile devices and to develop complex applications for multiple desktop
  platforms.

  \section1 Developing for Mobile Devices

  \QMLD allows you to easily develop animations by using a declarative programming
  language called QML. You use a visual editor to create widgets and define changes
  in their state. \QMLD generates the necessary code for you.
  You can edit the code in the code editor to add transitions and interaction. You
  can write JavaScript to implement the application logic.

  \section1 Developing for Desktop Platforms

Leena Miettinen's avatar
Leena Miettinen committed
102 103 104 105
  As an IDE, Qt Creator differs from a text editor in that it knows how to build and run
  applications. It understands the code as code, not just as plain text. This allows
  it to:
  \list
106 107 108 109 110
      \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
111
      \o Rename symbols in an intelligent way, so that other symbols with the same name
112 113
         that belong to other scopes are not renamed
      \o Show you the locations in code where a function is declared or called
Leena Miettinen's avatar
Leena Miettinen committed
114 115 116 117 118 119 120 121 122 123
   \endlist

      \section1 Why Do You Need Projects?

      To be able to build and run applications, Qt Creator needs the same
      information as a compiler would need. This information is specified in the
      project build and run settings.

      Creating a project allows you to:
      \list
124 125 126 127
      \o Group files together
      \o Add custom build steps
      \o Include forms and resource files
      \o Specify settings for running applications
Leena Miettinen's avatar
Leena Miettinen committed
128 129 130 131 132
      \endlist

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

      If you choose to create a QML application, Qt Creator generates a .qml file
      that you can modify with the \QMLD visual editor and the code editor.
Leena Miettinen's avatar
Leena Miettinen committed
138 139 140 141 142
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
    \page creator-os-supported-platforms.html
    \nextpage creator-quick-tour.html

    \title Operating Systems and Supported Platforms

    \section1 Operating Systems

    Qt Creator is available in binary packages for the following operating
    systems:
    \list
        \o Windows XP Service Pack 2
        \o Windows Vista
        \o (K)Ubuntu Linux 7.04 32-bit and 64-bit with the following:
           \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
               \o If you are using QtOpenGL, libglui-dev
           \endlist
173
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
174 175 176 177 178 179
           \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

180 181 182
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
183 184 185

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

190 191 192 193 194 195 196 197 198 199 200 201 202 203
    \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
204 205 206

    \table
        \header
207 208
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
209 210 211
        \header
            \o Desktop
            \o Symbian
212
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
213 214 215 216
        \row
            \o Windows
            \o Yes
            \o Yes
217
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
218 219 220 221
        \row
            \o Linux
            \o Yes
            \o No
222
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
223 224 225 226
        \row
            \o Mac OS X
            \o Yes
            \o No
227
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
228 229 230 231 232 233 234
    \endtable
*/


/*!
    \contentspage index.html
    \previouspage creator-os-supported-platforms.html
con's avatar
con committed
235
    \page creator-quick-tour.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
236
    \nextpage creator-writing-program.html
con's avatar
con committed
237

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
238
    \title Quick Tour
con's avatar
con committed
239

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
240
    The figure below shows some of the components of Qt Creator in
241
    \gui{Edit} mode.
con's avatar
con committed
242 243 244

    \image qtcreator-breakdown.png

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
245
    \section1 Qt Creator Modes
con's avatar
con committed
246

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
247
    The mode selector allows you to quickly switch between tasks such as
248 249
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
250 251
    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
252 253

    \list
254 255
        \o \gui Welcome mode for opening recent sessions and projects.
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
256 257
        \o \gui{\l{Implementing Application UI}{Design}} mode for designing and developing animated applications for
        mobile devices.
258 259 260 261
        \o \gui{\l{Debugging}{Debug}} mode for inspecting the state of your program while
           debugging.
        \o \gui{\l{Managing Projects}{Projects}} mode for configuring project building and
           execution.
262
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
263 264 265
    \endlist

    Certain actions in Qt Creator trigger a mode change. For example,
266
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
267
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
268 269


270
    \section1 Browsing Project Contents
con's avatar
con committed
271

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
272 273
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
274

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
275 276 277 278 279 280 281 282 283
    You can select the content of the sidebar in the sidebar menu:
    \list
        \o \gui Projects shows a list of projects open in the current
           session.
        \o \gui{File System} shows the content of the currently selected
           directory.
        \o \gui Bookmarks shows all bookmarks for the current session.
        \o \gui{Open Documents} shows currently open files.
    \endlist
con's avatar
con committed
284

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
285 286 287 288 289
    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
290
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
291 292 293 294
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
295 296


297
    \section2 Viewing Project Files
con's avatar
con committed
298

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
299 300 301
    When the sidebar shows projects, they are displayed 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
302

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
303 304
    You can use the project tree in the following ways:
    \list
305 306
        \o Double-click a file to open it in an editor.
        \o Right-click an item in the project tree to bring up a
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
307 308
           context menu containing the actions most commonly needed.
           For example, through the menu of the project root directory you can,
309
           build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
310 311
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
312
           and select \gui{Simplify Tree}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
313 314
        \o During a build, the build system automatically generates source
           files. To hide these files, click \inlineimage qtcreator-filter.png
315
           and select \gui{Hide Generated Files}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
316 317 318 319 320 321
        \o To toggle the synchronization of your project tree with the file
           opened in the editor, click
           \inlineimage qtcreator-synchronizefocus.png
           .
        \o To see the absolute path of a file, move the mouse pointer over the
           file name.
con's avatar
con committed
322 323 324
    \endlist


325
    \section1 Viewing Output
con's avatar
con committed
326

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
327
    The task pane in Qt Creator can display one of the following panes:
328
    \gui{Build Issues}, \gui{Search Results}, \gui{Application Output}, and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
329
    \gui{Compile Output}. Output panes are available in all
330
    \l{Qt Creator Modes}{modes}.
con's avatar
con committed
331

332

333
    \section2 Build Issues
con's avatar
con committed
334

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
335 336 337
    The \gui{Build Issues} pane provides a list of errors and warnings
    encoutered during a build. The pane filters out irrelevant output from
    the build tools and presents the issues in an organized way.
con's avatar
con committed
338

339
    \image qtcreator-build-issues.png
con's avatar
con committed
340

341

con's avatar
con committed
342 343
    \section2 Search Results

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
344 345 346 347
    The \gui{Search Results} pane displays the results for global searches
    such as searching within a current document, files on disk, or all
    projects. The figure below shows an example output of search result for all
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
348 349 350

    \image qtcreator-search-pane.png

351

con's avatar
con committed
352 353
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
354
    The \gui{Application Output} pane displays the status of a program when
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
355 356
    it is executed, and the debug output. The figure below shows an example
    output from qDebug().
con's avatar
con committed
357 358 359

    \image qtcreator-application-output.png

360

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
361
    \section2 Compile Output
con's avatar
con committed
362

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
363 364
    The \gui{Compile Output} pane provides all output from the compiler. In
    other words, it is a more detailed version of information displayed in the
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
365
    \gui{Build Issues} pane.
con's avatar
con committed
366 367 368

    \image qtcreator-compile-pane.png

369

370
    \section1 Getting Help
con's avatar
con committed
371

372 373 374
    Qt Creator comes fully integrated with Qt documentation and
    examples using the Qt Help plugin. You can get help in the following
    ways:
con's avatar
con committed
375

376 377 378
    \list

    \o To view documentation, switch to \gui Help mode.
con's avatar
con committed
379

380
    \o To get context sensitive help, move the text cursor to a Qt class or
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
381 382 383
    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.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
384

385 386
    \endlist

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
387
    \image qtcreator-context-sensitive-help.png
con's avatar
con committed
388

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
389
    To select and configure how the documentation is displayed in the
390
    \gui Help mode, select \gui Tools > \gui Options > \gui Help.
con's avatar
con committed
391

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
392
    \section2 Adding External Documentation
con's avatar
con committed
393

394
    You can display external documentation in the Qt Creator \gui Help mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
395 396 397 398 399 400
    To augument or replace the documentation that ships with Qt Creator and Qt:
    \list 1
        \o Create a .qch file from your documentation.

           For information on how to prepare your documentation and create a
           .qch file, see
401
           \l {http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
402
        \o Add the .qch file to Qt Creator by selecting \gui Tools >
403
           \gui Options > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
404
    \endlist
con's avatar
con committed
405 406


407
    \section1 Navigating with Keyboard
408

409 410 411
    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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
412 413 414
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

415 416 417 418 419 420 421 422 423
    \section1 Developing Application UI

    To help you design the user interface of your application, two visual
    editors are integrated into Qt Creator:

    \list
    \o \QD
    \o \QMLD
    \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
424

425
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
426

427
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
428

429
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
430 431 432

    \image qtcreator-formedit.png

433
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
434
    \list 1
435
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
436 437 438 439 440 441 442
           \gui Locked.

           When this option is unchecked, you can change the layout.
        \o Click the header of an element and drag the element to a new
           position.
    \endlist

443
    To change \QD properties, select \gui Tools > \gui Options >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    \gui Designer.
    \list
        \o Set the class properties and code generation preferences in \gui
           {Class Generation}.
        \o Set an additional folder for saving templates in \gui{Template
           Paths}.
        \o Set the grid settings and preview preferences in \gui Forms. To
           preview your form with skins, enable \gui{Print/Preview
           Configuration} and select your skin. Otherwise default preview
           settings are used.

           To preview the settings, select \gui Tools > \gui{Form Editor} >
           \gui Preview, or press \key Ctrl+Alt+R.
        \o To specify embedded device profiles, such as style, font, and screen
           resolution, select \gui{Embedded Design}.
    \endlist

461
    For more information on \QD, see
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
462
    \l{http://doc.trolltech.com/designer-manual.html}{Qt Designer Manual}.
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496

    \section1 Using QML Designer

    You can edit .qml files in either the visual \QMLD editor or in the
    code editor.

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

    \image qmldesigner-visual-editor.png "Visual editor"

    Use the visual editor panes to manage your project:

    \list

    \o \gui {Navigator} pane displays the items on the screen. You can change
    the order of items in the list to change their order on the screen.

    \o \gui {Library} pane displays lists of predefined \gui {Items} and
    imported \gui {Resources} that you can use to design applications. The
    images and other files that you copy to the project folder appear in the
    \gui {Resources} pane.

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

    \o \gui {State} pane displays the different states of the item. To add
    states, click the empty slot. Then modify the new state in the editor.
    In the code editor, you can see the changes recorded as changes to
    the base state.

    \endlist

con's avatar
con committed
497 498
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
499

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
500 501
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
502
    \previouspage creator-writing-program.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
503 504
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
505

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
506
    \title Using the Editor
507

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
508 509 510 511
    Qt Creator's code editor is designed to aid you in creating, editing and
    navigating code. It is fully equipped with syntax checking, code
    completion, context sensitive help and in-line error indicators while you
    are typing.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
512 513


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
514 515 516 517 518 519 520 521 522 523 524
    \section1 Configuring the Editor

    Qt Creator allows you to configure the text editor to suit your specific
    needs. To configure the editor, select  \gui Tools > \gui Options >
    \gui{Text Editor}:
    \list
        \o Set the font preferences and apply syntax highlighting in
           \gui{Font & Colors}.
        \o Set tabs, indentation and the handling of whitespace in
           \gui Behavior.
        \o Set various display properties, such as
525 526
           \l{Highlighting and Folding Blocks}{highlighting and folding blocks},
           text wrapping or \l{Moving to Symbol Definition or Declaration}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
527 528
           {moving to symbol definition or declaration}
           in \gui Display.
529
        \o Enable \l{Code Completion}{code completion} in \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
    \endlist


    \section1 Using the Editor Toolbar

    The editor toolbar is located at the top of the editor view. It is context
    sensitive and shows items relevant to the file currently open in the
    editor.

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
        \o To browse the history of edits for the currently open session, click
           \inlineimage qtcreator-back.png
           and \inlineimage qtcreator-forward.png
           .
        \o To go to any open file, select it from the \gui{Open files}
           drop-down menu.
        \o To jump to any symbol used in the current file, select it from the
           \gui Symbols drop-down menu.
    \endlist

    When you create or edit forms in an .ui file, the toolbar contains
554
    \QD specific tools.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
555 556 557 558

    If you are using a version control system, the toolbar enables you to
    compare the current file with the version in the repository. For more
    information on using Qt Creator with version control systems, see
559
    \l{Using Version Control Systems}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583


    \section1 Splitting the Editor View

    Split the editor view when you want to work on and view multiple files on
    the same screen.

    \image qtcreator-spliteditorview.png

    You can split the editor view in two ways:
    \list
        \o To split the editor view into a top and bottom view, select
           \gui Window > \gui Split or press \key{Ctrl+E, 2}.

           Split command creates views below the currently active editor view.
        \o To split the editor view into adjacent views, select
           \gui Window > \gui{Split Side by Side} or press
           \key{Ctrl+E, 3}.

           Side by side split command creates views to the right of the
           currently active editor view.
    \endlist

    To move between split views, select \gui Window >
584
    \gui{Go to Next Split} or press \key{Ctrl+E, 0}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628

    To remove a split view, place the cursor within the view you want to
    remove and select \gui Window > \gui{Remove Current Split} or press
    \key{Ctrl+E, 0}. To remove all but the currently selected split view,
    select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}.


    \section1 Highlighting and Folding Blocks

    Use block highlighting to visually separate parts of the code that belong
    together. For example, when you place the cursor within the braces,
    the code enclosed in braces is highlighted.

    \image qtcreator-blockhighlighting.png

    To enable block highlighting, select \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Display > \gui{Highlight blocks}.

    Use the folding markers to collapse and expand blocks of code within
    braces. Click the folding marker to collapse or expand a block. In the
    figure above, the folding markers are located between the line number and
    the text pane.

    To show the folding markers, select \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Display > \gui{Display folding markers}.


    \section1 Syntax Checking

    As you write code Qt Creator checks code syntax. When it spots syntax error
    in your code it underlines it and shows error details when you move the
    mouse pointer over the error:
    \list
        \o Syntax errors are underlined in red.

           In the following figure, semicolon is missing at the end of line.

           \image qtcreator-syntaxerror.png
        \o Semantic errors and warnings are underlined in olive.

           In the following figure, the type is unknown.

           \image qtcreator-semanticerror.png
    \endlist
629 630


631 632
    \section1 Code Completion

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
    As you write code Qt Creator provides a list of context-sensitive
    suggestions to the statement where your cursor is.

    \image qtcreator-codecompletion.png

    Set code completion preferences in \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Completion.

    Qt Creator can complete common prefixes before showing a list of
    suggestions. This is especially useful for the classes with several
    similarly named members. To use this functionality, in the code
    completion preferences enable \gui{Autocomplete common prefix}.

    The following table lists available types for code completion and icon
    used for each.
648 649

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
650 651 652
        \header
            \o Icon
            \o Description
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701
        \row
            \i  \inlineimage completion/class.png
            \i  A class
        \row
            \i  \inlineimage completion/enum.png
            \i  An enum
        \row
            \i  \inlineimage completion/enumerator.png
            \i  An enumerator (value of an enum)
        \row
            \i  \inlineimage completion/func.png
            \i  A function
        \row
            \i  \inlineimage completion/func_priv.png
            \i  A private function
        \row
            \i  \inlineimage completion/func_prot.png
            \i  A protected function
        \row
            \i  \inlineimage completion/var.png
            \i  A variable
        \row
            \i  \inlineimage completion/var_priv.png
            \i  A private variable
        \row
            \i  \inlineimage completion/var_prot.png
            \i  A protected variable
        \row
            \i  \inlineimage completion/signal.png
            \i  A signal
        \row
            \i  \inlineimage completion/slot.png
            \i  A slot
        \row
            \i  \inlineimage completion/slot_priv.png
            \i  A private slot
        \row
            \i  \inlineimage completion/slot_prot.png
            \i  A protected slot
        \row
            \i  \inlineimage completion/keyword.png
            \i  A keyword
        \row
            \i  \inlineimage completion/macro.png
            \i  A macro
        \row
            \i  \inlineimage completion/namespace.png
            \i  A namespace
    \endtable
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
702 703


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
704 705 706 707 708 709
    \section1 Moving to Symbol Definition or Declaration

    In Qt Creator you can move directly to the definition or the declaration of
    a symbol by holding the \key Ctrl and clicking the symbol.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
712

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744
    \section1 Using an External Editor

    To open the file you are currently viewing in an external editor, select
    \gui Edit > \gui Advanced > \gui{Open in External Editor}.

    To use the external editor of your choice:
    \list 1
        \o On Windows add the editor path to the \bold Path system variable.
           On Linux and Mac OS X add the editor path to the \bold PATH
           environment variable.
        \o In Qt Creator select \gui Tools > \gui Options... >
           \gui Environment > \gui General.
        \o In \gui{External editor} enter the name of the application followed
           by \key Space and \tt{\bold %f}. For example, to open the file in
           Smultron, enter \tt{\bold{smultron %f}}

           To further define how to open the file in the external editor, you
           can use the following variables separated by space:
           \list
            \o Current line number \tt{\bold %l}
            \o Current column number \tt{\bold %c}
            \o Editor's x position on the screen \tt{\bold %x}
            \o Editor's y position on the screen \tt{\bold %y}
            \o Editor's width in pixels \tt{\bold %w}
            \o Editor's height in pixels \tt{\bold %h}
            \o Editor's width in characters \tt{\bold %W}
            \o Editor's height in characters \tt{\bold %H}
            \o To pass % symbol to the editor \tt{\bold %%}
           \endlist

           \note Not all variables work with all editors.
    \endlist
745 746 747
*/


con's avatar
con committed
748 749
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
750 751 752
    \previouspage creator-editor-using.html
    \page creator-editor-finding.html
    \nextpage creator-editor-refactoring.html
con's avatar
con committed
753

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
754
    \title Finding and Replacing
con's avatar
con committed
755

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
756 757 758 759 760 761 762 763 764 765 766 767
    To search through the currently open file:
    \list 1
        \o Press \key Ctrl+F or select \gui Edit > \gui Find/Replace >
           \gui{Current Document}.
        \o Enter the text you are looking for.

           If the text is found, all occurrences are highlighted as you type.
        \o To go to the next occurrence, click \inlineimage qtcreator-next.png
           , or press \key F3. To go to the previous occurrence click
           \inlineimage qtcreator-previous.png
           , or press \key Shift+F3.
    \endlist
con's avatar
con committed
768

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782
    To narrow your search results, click
    \inlineimage qtcreator-locator-magnify.png
    in the \gui Find/Replace pane and select any of the following
    preferences:
    \list
        \o To make your search case sensitive, select
           \inlineimage qtcreator-editor-casesensitive.png
           .
        \o To search only whole words, select
           \inlineimage qtcreator-editor-wholewords.png
           .
        \o To search using regular expressions, select
           \inlineimage qtcreator-editor-regularexpressions.png
           .
783
           Regular expressions used in Qt Creator are modeled on Perl regular
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
784
           expressions. For more information on using regular expressions, see
785 786
           \l {http://doc.qt.nokia.com/4.6/qregexp.html#details}
           {Detailed Description} in the QRegExp Class Reference.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
787
    \endlist
con's avatar
con committed
788

789 790 791
    \note If you have selected text before selecting \gui Find/Replace, the
    search is conducted within the selection.

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
792 793 794 795 796 797 798 799 800 801 802
    To replace occurrences of the existing text, enter the new text in the
    \gui{Replace with} text box.
    \list
        \o To replace the selected occurrence and move to the next one,
           click \inlineimage qtcreator-next.png
           or press \key Ctrl+=.
        \o To replace the selected occurrence and move to the previous one,
           click \inlineimage qtcreator-previous.png
           .
        \o To replace all occurrences in the file, click \gui{Replace All}.
    \endlist
con's avatar
con committed
803

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
804
    \section1 Advanced Search
con's avatar
con committed
805

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
806 807 808 809
    To search through projects, files on a file system or the currently open
    file:
    \list 1
        \o Press \key Ctrl+Shift+F or select \gui Edit >
810 811
           \gui Find/Replace > \gui{Advanced Find} >
           \gui{Open Advanced Find...}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
        \o Select the scope of your search:
           \list
            \o \gui{All Projects} searches files matching the defined file
               pattern in all currently open projects.

               For example, to search for \tt previewer only in \tt .cpp
               and \tt .h files, enter in \gui{File pattern}
               \tt *.cpp,*.h.

               \image qtcreator-search-allprojects.png

            \o \gui{Current Project} searches files matching the defined file
               pattern only in the project you are currently editing.
            \o \gui{Files on File System} recursively searches files matching
               the defined file pattern in the selected directory.
            \o \gui{Current File} searches only the current file.
           \endlist
        \o Enter the text you are looking for and click \gui Search.

           \image qtcreator-searchresults.png

           A list of files containing the searched text is displayed in the
           \gui{Search Results} pane.
           \list
            \o To see all occurrences in a file, double-click the file name in
               the list.
            \o To go to an occurrence, double-click it.
           \endlist
    \endlist
*/
con's avatar
con committed
842 843


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
844 845 846 847 848
/*!
    \contentspage index.html
    \previouspage creator-editor-finding.html
    \page creator-editor-refactoring.html
    \nextpage creator-editor-locator.html
con's avatar
con committed
849

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
850
    \title Refactoring
851

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
852 853 854 855 856 857 858 859 860
    Code refactoring is the process of changing the code without modifying the
    existing functionality of your application. By refactoring your code you
    can:
    \list
        \o Improve internal quality of your application
        \o Improve performance and extensibility
        \o Improve code readability and maintainability
        \o Simplify code structure
    \endlist
con's avatar
con committed
861

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
862
    \section1 Finding Symbols
con's avatar
con committed
863

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
    To find the use of a specific symbol in your project:
    \list 1
        \o In the editor place the cursor on the symbol and select \gui Tools
           > \gui C++ > \gui{Rename Symbol under Cursor} or press
           \key Ctrl+Shift+U.

           Qt Creator looks for the symbol in the following locations:
           \list
            \o Files listed as a part of the project
            \o Files directly used by the project files (for example, generated
               files)
            \o Header files of used frameworks and libraries
           \endlist
        \o The \gui{Search Results} pane opens and shows the location and
           number of instances of the symbol in the current project.

           \image qtcreator-refactoring-find.png
    \endlist
con's avatar
con committed
882

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
    You can browse the search results in the following ways:
    \list
        \o To go directly to an instance, double-click the instance in the
           \gui{Search Results} pane.
        \o To move between instances, click
           \inlineimage qtcreator-forward.png
           and
           \inlineimage qtcreator-back.png
           in the \gui{Search Results} pane.
        \o To expand and collapse the list of all instances, click
           \inlineimage qtcreator-expand.png
           .
        \o To clear the search results, click \inlineimage qtcreator-clear.png
           .
    \endlist
898

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
899 900 901
    \section1 Renaming Symbols

    To rename a specific symbol in your project:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
902
    \list 1
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
        \o In the editor, place the cursor on the symbol you would like to
           change and select \gui Tools > \gui C++ >
           \gui{Rename Symbol under Cursor} or press \key Ctrl+Shift+R.

           The \gui{Search Results} pane opens and shows the location and
           number of instances of the symbol in the current project.

           \image qtcreator-refactoring-replace.png
        \o To replace all selected instances, enter the name of the new symbol
           in the \gui{Replace with} text box and click \gui Replace.

           To omit an instance, uncheck the check-box next to the instance.

           \note This action replaces all selected instances of the symbol in
           all files listed in the \gui{Search Results} pane. You cannot
           undo this action.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
919
    \endlist
920

921 922 923 924
    \note Renaming local symbols does not open the \gui{Search Results} pane.
    The instances of the symbol are highlighted in code and you can edit the
    symbol. All instances of the local symbol are changed as you type.
*/
925

926 927
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
928 929 930 931 932
    \previouspage creator-editor-locator.html
    \page creator-project-managing.html
    \nextpage creator-project-creating.html

    \title Managing Projects
con's avatar
con committed
933

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
934 935 936 937 938 939 940 941 942 943 944
    Qt Creator allows you to deploy various types of projects and provides a
    platform to work on different types of projects:
    \list
       \o To work with \bold{qmake projects}, open a \c .pro file. For more
          information, see \l{Setting Up a qmake Project}.
       \o To work with \bold{CMake projects} you need to have CMake version
          2.8.0 or later installed. For more information, see
          \l{Setting Up a CMake Project}.
       \o Qt Creator supports generic projects. For more information, see
          \l{Setting Up a Generic Project}.
    \endlist
con's avatar
con committed
945

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
946
    \section1 External Libraries
con's avatar
con committed
947

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
948 949 950
    Through external libraries Qt Creator can support code completion and
    syntax highlighting for external libraries as if they were a part of the
    current project or the Qt library.
con's avatar
con committed
951

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
952 953
    The procedure of adding a library to a project depends on the type of
    project, which influences the build system used.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
954

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
955 956 957 958 959 960 961 962 963 964 965 966 967 968
    \list
       \o For information on adding external libraries to qmake projects, see
          \l{Adding External Libraries to a qmake Project}.
       \o For information on adding external libraries to CMake projects, see
          \l{Adding External Libraries to a CMake Project}.
       \o For information on adding external libraries to generic projects, see
          \l{Adding External Libraries to a Generic Project}.
   \endlist

    \section1 Session Management
    In Qt Creator a session is a collection of bookmarks, breakpoints and
    watchers and can include multiple open projects. To learn about using and
    managing sessions, see \l{Managing Sessions}.
*/
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
969

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
970

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
971 972 973 974 975
/*!
    \contentspage index.html
    \previouspage creator-project-managing.html
    \page creator-project-creating.html
    \nextpage creator-project-qmake.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
976

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
977
    \title Creating a Project
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
978

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
979 980
    To create a new project:
    \list 1
981
        \o Select \gui File > \gui{New File or Project} and select the type of your
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
982
           project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
983

984 985
           The contents of the following dialogs depend on the project type.
           This example uses \gui {Qt Gui Application}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
986

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
987 988
           \image qtcreator-new-project.png
        \o Name the project and set its path. To select the path from a
989
           directory tree, click \gui Browse.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
990

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
           Avoid using spaces and special characters in the project name and
           path.

           \image qtcreator-intro-and-location.png
        \o Specify the name of the class you want to create and using the
           drop-down menu select its base class type.

           Note that the \gui{Header file}, \gui{Source file} and
           \gui{Form file} fields are automatically updated as you name your
           class.

           \image qtcreator-class-info.png
        \o Review the project settings.

1005
           To create the project, click \gui Finish.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1006 1007 1008

           \image qtcreator-new-project-summary.png
    \endlist
1009

con's avatar
con committed
1010 1011
*/

1012

con's avatar
con committed
1013 1014
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1015 1016 1017
    \previouspage creator-project-creating.html
    \page creator-project-qmake.html
    \nextpage creator-project-cmake.html
con's avatar
con committed
1018

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1019
    \title Setting Up a qmake Project
con's avatar
con committed
1020

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093
    \section1 Selecting the Qt Version

    Qt Creator allows you to have multiple versions of Qt installed on
    your computer and use different versions for your projects.

    If Qt Creator finds \bold qmake in the PATH environment variable, it uses
    that version. This \l{glossary-system-qt}{version of Qt} is referred to as
    \bold{Qt in PATH}. If you intend to use only one version of Qt and it is
    already in the PATH and correctly set up for command line use, you do not
    need to manually configure your Qt version.

    \note By default, Qt Creator compiles projects with the
    \l{glossary-default-qt}{default Qt version}. For information on how to
    override this setting, see \l{Build Settings}.

    \section2 Windows

    To add a Qt version for \bold MinGW:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Click \inlineimage qtcreator-windows-add.png
           and enter the name of the version in \gui{Version Name} field.
        \o Enter the qmake binary path in the \gui{qmake Location}.
        \o Enter the MinGW installation path in the \gui{MinGW Directory}.

           \image qtcreator-qt4-qtversions-win-mingw.png
    \endlist

    To add a Qt version for a \bold{Microsoft Visual C++} compiler:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Qt Creator automatically sets the correct environment variables for
           compilation. Select the internal version number of the installed
           Microsoft Visual C++ tool chains using the \gui MSVC drop-down
           box:
           \list
               \o \bold 7.1 for Visual Studio 2003
               \o \bold 8.0 for Visual Studio 2005
               \o \bold 9.0 for Visual Studio 2008
           \endlist

           \note If you are using the
           \bold{Windows SDK for Windows Server 2008}, Qt Creator identifies
           it as version 9.0.

           \image qtcreator-qt4-qtversions-win-msvc.png
    \endlist

    If you are using \bold{Qt for Symbian} and your S60 SDK is registered
    with devices.exe, Qt Creator automatically detects the Qt version. To add a
    Qt for Symbian version:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Select the \gui{S60 SDK} you want the Qt Creator to use.

           \image qtcreator-qt4-qtversions-win-symbian.png
        \o To build an application for your device using GCCE, enter the path
           to the \bold{CSL ARM Toolchain} directory in
           \gui{CSL\\GCCE Directory}.

           You do not need to specify this path if the compiler is included in
           the PATH environment variable.
        \o To build an application for the emulator (WINSCW toolchain), enter
           the path to your Carbide C++ installation directory in
           \gui{Carbide Directory}.

           You need to have Carbide C++ version 2.0 or later installed.
    \endlist

    \section2 Linux
con's avatar
con committed
1094

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1095 1096 1097
    To compile a project in Qt Creator, Linux uses GNU Compiler Collection
    (GCC). Intel Compiler Collection (ICC) is supported as a drop-in
    replacement for GCC.
1098

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168
    To add a Qt version:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Click \inlineimage qtcreator-linux-add.png
           and enter the name of the version in \gui{Version Name}.
        \o Enter the path to the qmake binary in \gui{Path to qmake}.
    \endlist

    \section2 Mac OS X

    To compile a project in Qt Creator, Mac OS X uses GNU Compiler Collection
    (GCC), which is part of Xcode.

    To add a Qt version:
    \list 1
        \o Select \gui{Qt Creator} > \gui Preferences... > \gui{Qt Versions}.
        \o Click \inlineimage qtcreator-macosx-add.png
           and enter the name of the version in \gui{Version Name}.
        \o Enter the path to the qmake binary in \gui{Path to qmake}.

           \image qtcreator-qt4-qtversions.png
    \endlist


    \section1 Setting Up a Project

    To view and modify the settings for currently open projects, switch to the
    \gui Projects mode by pressing \key Ctrl+4.

    \image qtcreator-projectpane.png

    The project pane consists of three tabs
    \list
       \o Targets
       \o Editor Settings
       \o Dependencies
    \endlist

    Use the \gui Build and \gui Run buttons on *Desktop* to switch between
    the build and run settings for the active project.

    If you have multiple projects open in Qt Creator, use
    \gui{Select a Project} option at the top to navigate between different
    project edits.

    \section1 Build Settings

    Different build configurations allow you to quickly switch between
    different build settings. By default, Qt Creator creates \bold debug
    and \bold release build configurations. Both of these configurations use
    the \l{glossary-default-qt}{default Qt version}.

    \image qtcreator-ppbuildsettings.png

    \section2 Adding and Removing Build Configurations

    To add a new build configuration, click \gui Add and select the type of
    configuration you would like add. You can add as many build configurations
    as you need.

    To delete the build configuration currently selected, click \gui Remove.

    \section2 Editing Build Configurations

    To edit a build configuration:
    \list 1
        \o Select the build configuration you want to edit in
           \gui{Edit Build Configuration}.
        \o In section \gui General, you can specify:
1169
        \list
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1170 1171 1172 1173 1174 1175 1176
            \o The \l{glossary-project-qt}{Qt version} you want to use to
               build your project. For more information, see
               \l{Selecting the Qt version}.
            \o The toolchain required to build the project.
            \o If you want to \l{glossary-shadow-build}{shadow build} your
               project, check the \gui{Shadow Build} checkbox and select the
               build directory.
1177
        \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1178
    \endlist
con's avatar
con committed
1179

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1180
    \section2 Build Steps
con's avatar
con committed
1181

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1182 1183 1184 1185
    The build system of Qt Creator is built on qmake and make. In
    \gui{Build Steps} you can change the settings for qmake and make. Qt
    Creator runs the make command using the Qt version defined for the current
    build configuration.
con's avatar
con committed
1186

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1187
    \section2 Clean Steps
con's avatar
con committed
1188

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1189 1190 1191
    The cleaning process is used to remove intermediate files. This process
    might help you to fix obscure issues during the process of building a
    project.
con's avatar
con committed
1192

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205
    You can define the cleaning steps for your builds in the \gui{Clean Steps}:
    \list
        \o To add a clean step using make or a custom process, click
           \gui{Add clean step} and select the type of step you want to add.

           By default, custom steps are disabled. Activate customs steps by
           checking the \gui{Enable Custom Process Step} check-box.
        \o To remove a clean step, click \gui{Remove clean step} and select the
           step you want to remove.
        \o To change the order of steps, click
           \inlineimage qtcreator-movestep.png
           .
    \endlist
con's avatar
con committed
1206

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1207
    \section2 Build Environment
con's avatar
con committed
1208

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1209 1210 1211 1212 1213 1214 1215
    You can specify the environment you want to use for building in the
    \bold{Build Environment} section. By default, the environment in which Qt
    Creator was started is used and modified to include the Qt version.
    Depending on the selected Qt version, Qt Creator automatically sets the
    necessary environment variables. You can edit existing environment
    variables or add, reset and unset new variables based on your project
    requirements.
con's avatar
con committed
1216 1217


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1218
    \section1 Run Settings
con's avatar
con committed
1219

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1220 1221 1222 1223
    Qt Creator automatically creates run configurations for your project.
    These run configurations derive their executable from the parsed .pro
    files. You can also create custom executable run configurations where you
    can set the executable to be run.
1224

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1225
    \image qtcreator-pprunsettings.png
1226

1227

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    \section1 File Encoding

    To define the default file encoding, select the desired encoding in the
    \gui{Editor Settings}. By default, the Qt Creator uses the file encoding
    used by your system.


    \section1 Dependencies

    If you have multiple projects loaded in your session, you can define the
    dependencies between them. This affects the build order of your
    projects.

    \note These dependencies are unrelated to the dependencies inside a qmake
    project.

    To define the dependencies:
    \list 1
        \o Select the project for which you want to configure dependencies.
        \o In the \gui Dependencies section check the checkboxes to select
           other projects as dependencies.
    \endlist


    \section1 Adding External Libraries to a qmake Project

    Through external libraries Qt Creator can support code completion and
    syntax highlighting as if they were part of the current project or the Qt
    library.

    To add an external library:
    \list
        \o Open your project file (.pro) using the \gui Projects pane.
        \o Follow the instructions at \l http://doc.trolltech.com/latest/qmake-project-files.html#declaring-other-libraries
           {Declaring other Libraries}.
    \endlist
1264

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1265 1266
    Syntax completion and highlighting work once your project successfully
    builds and links against the external library.
con's avatar
con committed
1267 1268
*/

1269