qtcreator.qdoc 155 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
       \o \l{Operating Systems and Supported Platforms}
       \o \l{Quick Tour}
47 48 49 50 51
       \o \l{Getting Started}
           \list
               \o \l{Writing a Simple Program}
               \o \l{Creating an Animated Application}
           \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
52 53 54 55 56 57 58 59 60 61 62 63 64 65
       \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
66
       \o \l{Developing Mobile Applications}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
67
            \list
68
                \o \l{Implementing Application UI}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
69 70 71 72 73
                \o \l{Developing Maemo Applications}
                \o \l{Developing Symbian Applications}
            \endlist
       \o \l{Debugging}
       \o \l{Using Version Control Systems}
74
       \o \l{Adding Qt Designer Plugins}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
75 76 77 78 79
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
80 81 82
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
83

con's avatar
con committed
84 85
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
86
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
87 88 89 90 91
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

92 93 94 95 96 97 98 99 100 101 102 103 104 105
  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
106 107 108 109
  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
110 111 112 113 114
      \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
115
      \o Rename symbols in an intelligent way, so that other symbols with the same name
116 117
         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
118 119 120 121 122 123 124 125 126 127
   \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
128 129 130 131
      \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
132 133 134 135 136
      \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
137 138 139 140 141
      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
142 143 144 145 146
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
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 173 174
    \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
175
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
176
           \endlist
177
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
178 179 180 181 182 183
           \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

184 185 186
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
187 188 189

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

194 195 196 197 198 199 200 201 202 203 204 205 206 207
    \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
208 209 210

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


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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
242
    \title Quick Tour
con's avatar
con committed
243

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
244
    The figure below shows some of the components of Qt Creator in
245
    \gui{Edit} mode.
con's avatar
con committed
246 247 248

    \image qtcreator-breakdown.png

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
249
    \section1 Qt Creator Modes
con's avatar
con committed
250

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

    \list
258 259
        \o \gui Welcome mode for opening recent sessions and projects.
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
260 261
        \o \gui{\l{Implementing Application UI}{Design}} mode for designing and developing animated applications for
        mobile devices.
262 263 264 265
        \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.
266
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
267 268 269
    \endlist

    Certain actions in Qt Creator trigger a mode change. For example,
270
    \gui {Debug} > \gui {Start Debugging} > \gui {Start Debugging}
271
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
272 273


274
    \section1 Browsing Project Contents
con's avatar
con committed
275

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
276 277
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
278

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
279 280 281 282 283 284 285 286 287
    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
288

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


301
    \section2 Viewing Project Files
con's avatar
con committed
302

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
303 304 305
    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
306

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
307 308
    You can use the project tree in the following ways:
    \list
309 310
        \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
311 312
           context menu containing the actions most commonly needed.
           For example, through the menu of the project root directory you can,
313
           build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
314 315
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
316
           and select \gui{Simplify Tree}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
317 318
        \o During a build, the build system automatically generates source
           files. To hide these files, click \inlineimage qtcreator-filter.png
319
           and select \gui{Hide Generated Files}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
320 321 322 323 324 325
        \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
326 327 328
    \endlist


329
    \section1 Viewing Output
con's avatar
con committed
330

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

336

337
    \section2 Build Issues
con's avatar
con committed
338

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

343
    \image qtcreator-build-issues.png
con's avatar
con committed
344

345

con's avatar
con committed
346 347
    \section2 Search Results

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
348 349 350 351
    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
352 353 354

    \image qtcreator-search-pane.png

355

con's avatar
con committed
356 357
    \section2 Application Output

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

    \image qtcreator-application-output.png

364

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
365
    \section2 Compile Output
con's avatar
con committed
366

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
367 368
    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
369
    \gui{Build Issues} pane.
con's avatar
con committed
370 371 372

    \image qtcreator-compile-pane.png

373

374
    \section1 Getting Help
con's avatar
con committed
375

376 377 378
    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
379

380
    \list
con's avatar
con committed
381

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

384
    \o To get context sensitive help, move the text cursor to a Qt class or
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
385 386 387
    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
388

389 390
    \endlist

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

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
396
    \section2 Adding External Documentation
con's avatar
con committed
397

398
    You can display external documentation in the Qt Creator \gui Help mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
399 400 401 402 403 404
    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
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
405
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
406
        \o Add the .qch file to Qt Creator by selecting \gui Tools >
407
           \gui Options > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
408
    \endlist
con's avatar
con committed
409 410


411
    \section1 Navigating with Keyboard
412

413 414 415
    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
416 417 418
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

419 420 421 422 423 424 425 426 427
    \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
428

429
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
430

431
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
432

433
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
434 435 436

    \image qtcreator-formedit.png

437
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
438
    \list 1
439
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
440 441 442 443 444 445 446
           \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

447
    To change \QD properties, select \gui Tools > \gui Options >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
    \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

465
    For more information on \QD, see
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
466
    \l{http://doc.trolltech.com/designer-manual.html}{Qt Designer Manual}.
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482

    \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

483 484
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500

    \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
501 502
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
503

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
504 505
/*!
    \contentspage index.html
506
    \previouspage creator-qml-application.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
507 508
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
509

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
510
    \title Using the Editor
511

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


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
518 519 520 521
    \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 >
522 523 524
    \gui{Text Editor}

    You can perform the following configuration actions:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
525 526 527 528 529
    \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.
530 531 532
        \o Set various display properties, for example,
           \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
533 534
           {moving to symbol definition or declaration}
           in \gui Display.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
535
        \o Configure \l{Code Completion}{code completion} in \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
536 537 538 539 540
    \endlist


    \section1 Using the Editor Toolbar

541 542 543
    The editor toolbar is located at the top of the editor view. The editor
    toolbar is context sensitive and shows items relevant to the file currently
    open in the editor.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558

    \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

559 560
    When you create or edit forms in a \c{.ui} file, the toolbar contains
    Qt Designer specific tools.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
561 562 563 564

    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
565
    \l{Using version control systems}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
566 567 568 569 570 571 572 573 574


    \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

575
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
576 577 578 579 580 581 582 583 584 585 586 587 588 589
    \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 >
590
    \gui{Go to Next Split} or press \key{Ctrl+E, 0}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
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

    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

620 621 622
    As you write code Qt Creator checks code syntax. When Qt Creator spots a
    syntax error in your code it underlines it and shows error details when you
    move the mouse pointer over the error.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
623 624 625 626 627 628 629 630 631 632 633 634
    \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
635 636


637 638
    \section1 Code Completion

639 640
    As you write code, Qt Creator provides a list of context-sensitive
    suggestions to the statement currently under your cursor.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
641 642 643 644 645 646

    \image qtcreator-codecompletion.png

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

647 648 649 650
    When completion is invoked manually, Qt Creator completes the common prefix
    of the list of suggestions. This is especially useful for classes with
    several similarly named members. To disable this functionality, uncheck
    \gui{Autocomplete common prefix} in the code completion preferences.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
651 652 653

    The following table lists available types for code completion and icon
    used for each.
654 655

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
656 657 658
        \header
            \o Icon
            \o Description
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 702 703 704 705 706 707
        \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
708 709


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
710 711 712 713 714
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
718

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
719 720 721 722 723 724 725 726
    \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.
727
           On Linux and Mac OS X add the editor path to the \c{PATH}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
728 729 730 731 732
           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
733
           Smultron, enter \tt{\bold{smultron %f}}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
734 735

           To further define how to open the file in the external editor, you
736
           can use the following variables separated by a space:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
737 738 739 740 741 742 743 744 745 746 747 748 749 750
           \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
751 752 753
*/


con's avatar
con committed
754 755
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
756 757 758
    \previouspage creator-editor-using.html
    \page creator-editor-finding.html
    \nextpage creator-editor-refactoring.html
con's avatar
con committed
759

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
760
    \title Finding and Replacing
con's avatar
con committed
761

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
762 763 764 765 766 767 768 769 770 771 772 773
    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
774

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788
    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
           .
789
           Regular expressions used in Qt Creator are modeled on Perl regular
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
790
           expressions. For more information on using regular expressions, see
791 792
           \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
793
    \endlist
con's avatar
con committed
794

795 796 797
    \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
798 799 800 801 802 803 804 805 806 807 808
    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
809

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
810
    \section1 Advanced Search
con's avatar
con committed
811

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
812 813 814 815
    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 >
816 817
           \gui Find/Replace > \gui{Advanced Find} >
           \gui{Open Advanced Find...}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
        \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
848 849


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
850 851 852 853 854
/*!
    \contentspage index.html
    \previouspage creator-editor-finding.html
    \page creator-editor-refactoring.html
    \nextpage creator-editor-locator.html
con's avatar
con committed
855

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
856
    \title Refactoring
857

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
858 859 860 861 862 863 864 865 866
    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
867

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
868
    \section1 Finding Symbols
con's avatar
con committed
869

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887
    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
888

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
    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
904

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
905 906 907
    \section1 Renaming Symbols

    To rename a specific symbol in your project:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
908
    \list 1
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924
        \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
925
    \endlist
926

927 928 929 930
    \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.
*/
931

932 933
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
934 935 936 937 938
    \previouspage creator-editor-locator.html
    \page creator-project-managing.html
    \nextpage creator-project-creating.html

    \title Managing Projects
con's avatar
con committed
939

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
940 941 942 943 944 945 946 947 948 949 950
    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
951

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
952
    \section1 External Libraries
con's avatar
con committed
953

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
954 955 956
    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
957

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
958 959
    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
960

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
961 962 963 964 965 966 967 968 969 970 971 972 973 974
    \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
975

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
976

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
977 978 979 980 981
/*!
    \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
982

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
983
    \title Creating a Project
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
984

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
985 986
    To create a new project:
    \list 1
987
        \o Select \gui File > \gui{New File or Project} and select the type of your
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
988
           project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
989

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
993 994
           \image qtcreator-new-project.png
        \o Name the project and set its path. To select the path from a
995
           directory tree, click \gui Browse.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
996

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
           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.

1011
           To create the project, click \gui Finish.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1012 1013 1014

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

con's avatar
con committed
1016 1017
*/

1018

con's avatar
con committed
1019 1020
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1021 1022 1023
    \previouspage creator-project-creating.html
    \page creator-project-qmake.html
    \nextpage creator-project-cmake.html
con's avatar
con committed
1024

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1025
    \title Setting Up a qmake Project
con's avatar
con committed
1026

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1027 1028 1029
    \section1 Selecting the Qt Version

    Qt Creator allows you to have multiple versions of Qt installed on
1030
    your computer and use different versions for each of your projects.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1031

1032 1033 1034 1035 1036
    If Qt Creator finds \bold qmake in the \c{PATH} environment variable, it uses
    that version. The \l{glossary-system-qt}{ qmake 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 \c{PATH} and correctly set up for command line use, you do
    not need to manually configure your Qt version.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
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