qtcreator.qdoc 185 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
    Qt Creator provides integrated tools for both application designers
18
    and developers to create applications for multiple desktop and mobile device
19 20
    platforms.

21 22 23
    For application designers, Qt Creator provides two integrated
    visual editors, \QD and \QMLD, that you can use to design and develop
    application user interfaces.
24 25

    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 Qt Quick Applications}
67
       \o \l{Developing Mobile Applications}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
68 69 70
            \list
                \o \l{Developing Maemo Applications}
                \o \l{Developing Symbian Applications}
71
                \o \l{Developing Usable Applications}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
72 73 74
            \endlist
       \o \l{Debugging}
       \o \l{Using Version Control Systems}
75
       \o \l{Adding Qt Designer Plugins}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
76 77 78 79 80
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
81 82 83
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
84

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

  \title Introducing Qt Creator

93 94
  Qt Creator provides you with tools to design and develop user interfaces and
  complex applications for multiple desktop and mobile
95 96
  platforms.

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
  \section1 Designing User Interfaces

  Qt Creator provides two integrated visual editors, \QD and \QMLD.

  \QD is a tool for designing and building graphical user interfaces (GUIs) from
  Qt widgets. You can compose and customize your widgets or dialogs and test
  them using different styles and resolutions.

  Widgets and forms created with \QD are integrated seamlessly with programmed code,
  using the Qt signals and slots mechanism, that lets you easily assign behavior to
  graphical elements. All properties set in \QD can be changed dynamically within the code.
  Furthermore, features like widget promotion and custom plugins allow you to use your
  own widgets with \QD.

  UIs that use widgets are clearly structured and enforce a platform look and feel,
  which makes them useful for traditional applications. However, they are static, and
  do not fully make use of the large high-resolution screens, touch input, and significant
  graphics power that are becoming common in portable consumer devices, such as mobile
  phones, media players, set-top boxes, and netbooks.
116 117

  \QMLD allows you to easily develop animations by using a declarative programming
118 119 120 121
  language called \l {http://qt.nokia.com/doc/4.7-snapshot/declarativeui.html}{QML}.
  In QML, a user interface is specified as a tree of objects with properties.

  You use a visual editor to create items, screens, and applications, as well as define changes
122
  in their state. \QMLD generates the necessary code for you.
123 124 125
  You can edit the code in the code editor to add transitions from one state to another,
  and interaction to specify user actions that change the states. You
  can use Qt to implement the application logic.
126

127
  \section1 Coding Applications
128

Leena Miettinen's avatar
Leena Miettinen committed
129 130 131 132
  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
133 134 135 136 137
      \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
138
      \o Rename symbols in an intelligent way, so that other symbols with the same name
139 140
         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
141 142 143 144 145 146 147 148 149 150
   \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
151 152 153 154
      \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
155 156 157 158 159
      \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
160 161 162
      interface (GUI) application, Qt Creator generates an empty .ui file
      that you can modify with the integrated \QD.

163
      If you choose to create a Qt Quick application, Qt Creator generates a .qml file
164
      that you can modify with the \QMLD visual editor and the code editor.
Leena Miettinen's avatar
Leena Miettinen committed
165 166 167 168 169
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
    \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
198
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
199
           \endlist
200
        \o Mac OS 10.5 or later with the following:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
201 202 203 204 205 206
           \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

207 208 209
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
210 211 212

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

217 218 219 220 221 222 223 224 225 226 227 228 229 230
    \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
231 232 233

    \table
        \header
234 235
            \o {1,3} Operating system
            \o {3,1} Platform
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
236 237 238
        \header
            \o Desktop
            \o Symbian
239
            \o Maemo
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
240 241 242 243
        \row
            \o Windows
            \o Yes
            \o Yes
244
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
245 246 247 248
        \row
            \o Linux
            \o Yes
            \o No
249
            \o Yes
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
250 251 252 253
        \row
            \o Mac OS X
            \o Yes
            \o No
254
            \o No
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
255 256 257 258 259 260 261
    \endtable
*/


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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
265
    \title Quick Tour
con's avatar
con committed
266

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
267
    The figure below shows some of the components of Qt Creator in
268
    \gui{Edit} mode.
con's avatar
con committed
269 270 271

    \image qtcreator-breakdown.png

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
272
    \section1 Qt Creator Modes
con's avatar
con committed
273

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
274
    The mode selector allows you to quickly switch between tasks such as
275 276
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
277 278
    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
279 280

    \list
281 282
        \o \gui Welcome mode for opening recent sessions and projects.
        \o \gui{\l{Using the Editor}{Edit}} mode for editing project and source files.
283 284
        \o \gui{\l{Developing Application UI}{Design}} mode for designing and developing
           application user interfaces.
285 286 287 288
        \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.
289
        \o \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
290 291
    \endlist

292 293
    Certain actions in Qt Creator trigger a mode change. Clicking on
    \gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
294
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
295 296


297
    \section1 Browsing Project Contents
con's avatar
con committed
298

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
299 300
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
301

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
302 303 304 305 306 307 308 309 310
    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
311

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
312 313 314 315 316
    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
317
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
318 319 320 321
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
322 323


324
    \section2 Viewing Project Files
con's avatar
con committed
325

326 327 328
    The sidebar displays projects in a project tree. The project tree contains
    a list of all projects open in the current session. The files for each
    project are grouped according to their file type.
con's avatar
con committed
329

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
330 331
    You can use the project tree in the following ways:
    \list
332 333
        \o To bring up a context menu containing the actions most commonly
           needed right-click an item in the project tree.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
334
           For example, through the menu of the project root directory you can,
335
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
336 337
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
338 339 340 341
           and select \gui{Simplify tree}.
        \o To hide source files which are automatically generated by the build
           system, during a build, click \inlineimage qtcreator-filter.png
           and select \gui{Hide generated files}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
342 343 344 345 346 347
        \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
348 349 350
    \endlist


351
    \section1 Viewing Output
con's avatar
con committed
352

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
353
    The task pane in Qt Creator can display one of the following panes:
354 355 356 357 358 359 360 361
    \list
       \o  \gui{Build Issues}
       \o  \gui{Search Results}
       \o  \gui{Application Output}
       \o  \gui{Compile Output}
    \endlist

    Output panes are available in all \l{Qt Creator modes}{modes}.
con's avatar
con committed
362

363

364
    \section2 Build Issues
con's avatar
con committed
365

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

370 371 372 373
    Right-clicking on a line brings up a context menu with options to copy
    the contents and to show a version control annotation view of the
    line that causes the error message.

374
    \image qtcreator-build-issues.png
con's avatar
con committed
375

376

con's avatar
con committed
377 378
    \section2 Search Results

379 380 381 382 383
    The \gui{Search Results} pane displays the results for global searches,
    for example, searching within a current document, files on disk, or all
    projects.

    The figure below shows an example search result for all
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
384
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
385 386 387

    \image qtcreator-search-pane.png

388

con's avatar
con committed
389 390
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
391
    The \gui{Application Output} pane displays the status of a program when
392 393 394
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
395 396 397

    \image qtcreator-application-output.png

398

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
399
    \section2 Compile Output
con's avatar
con committed
400

401 402 403
    The \gui{Compile Output} pane provides all output from the compiler.
    The \gui{Compile Output} is a more detailed version of information
    displayed in the \gui{Build Issues} pane.
con's avatar
con committed
404 405 406

    \image qtcreator-compile-pane.png

407

408
    \section1 Getting Help
con's avatar
con committed
409

410 411
    Qt Creator comes fully integrated with all of Qt's documentation and
    examples using the Qt Help plugin.
412
    \list
413 414 415 416 417
        \o To view documentation, switch to \gui Help mode.
        \o To obtain context sensitive help, move the text cursor to a Qt class
           or function and press \key F1. The documentation is displayed in a
           pane next to the code editor, or, if there is not enough vertical
           space, in the fullscreen \gui Help mode.
con's avatar
con committed
418

419
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
420

421 422
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
423 424
    \endlist

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
425
    \section2 Adding External Documentation
con's avatar
con committed
426

427 428 429
    You can display external documentation in Qt Creator's \gui Help mode.
    Augment or replace the documentation that ships with Qt Creator and Qt by
    performing the following steps:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
430 431 432 433 434
    \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
435
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
436
        \o Add the .qch file to Qt Creator by selecting \gui Tools >
437
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
438
    \endlist
con's avatar
con committed
439 440


441
    \section1 Navigating with Keyboard
442

443 444 445
    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
446 447 448
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

449 450 451 452 453 454 455 456 457
    \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
458

459
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
460

461
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
462

463
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
464 465 466

    \image qtcreator-formedit.png

467
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
468
    \list 1
469
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
470 471 472 473 474 475 476
           \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

477
    To change \QD properties, select \gui Tools > \gui Options >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
    \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

495
    For more information on \QD, see
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
496
    \l{http://doc.trolltech.com/designer-manual.html}{Qt Designer Manual}.
497

498
    \section1 Using Qt Quick Designer
499 500 501 502

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

503
    In \gui Projects, double-click a .qml file to open it in the code
504 505 506 507 508 509 510 511 512
    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

513 514
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
515 516 517 518 519 520

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

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

524
    \o \gui {State} pane displays the different states of the component. To add
525 526 527 528 529 530
    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
531 532
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
533

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
534 535
/*!
    \contentspage index.html
536
    \previouspage creator-qml-application.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
537 538
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
539

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
540
    \title Using the Editor
541

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
542
    Qt Creator's code editor is designed to aid you in creating, editing and
543 544 545
    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
546 547


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
548 549 550
    \section1 Configuring the Editor

    Qt Creator allows you to configure the text editor to suit your specific
551
    needs. To configure the editor, select  \gui Tools > \gui{Options...} >
552 553 554
    \gui{Text Editor}

    You can perform the following configuration actions:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
555 556 557 558 559
    \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.
560 561 562
        \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
563 564
           {moving to symbol definition or declaration}
           in \gui Display.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
565
        \o Configure \l{Code Completion}{code completion} in \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
566 567 568 569 570
    \endlist


    \section1 Using the Editor Toolbar

571 572 573
    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
574 575 576 577 578

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
579
        \o To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
580 581 582 583 584 585 586 587 588
           \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

589 590
    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
591 592 593 594 595 596 597 598 599


    \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

600
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
601 602 603 604 605 606 607 608 609 610 611 612 613 614
    \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 >
615
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630

    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

631
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
632 633 634 635 636 637 638
    \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.

639 640 641
    To show the folding markers, select \gui Tools > \gui{Options...} >
    \gui{Text Editor} > \gui Display > \gui{Display folding markers}. This
    option is enabled by default.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
642 643 644 645


    \section1 Syntax Checking

646 647 648
    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
649 650 651
    \list
        \o Syntax errors are underlined in red.

652 653
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
654 655 656 657 658 659 660 661

           \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
662 663


664 665
    \section1 Code Completion

666 667
    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
668 669 670

    \image qtcreator-codecompletion.png

671 672 673
    Set code completion preferences in \gui Tools > \gui{Options...} >
    \gui{Text Editor} > \gui Completion. To trigger code completion
    manually press \key{Ctrl+Space}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
674

675 676 677 678
    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
679 680 681

    The following table lists available types for code completion and icon
    used for each.
682 683

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
684 685 686
        \header
            \o Icon
            \o Description
687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735
        \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
736 737


738 739
    \section1 Using Bookmarks

740
    To insert or delete a bookmark right-click the line number and select
741 742 743 744
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

745
    To go to previous bookmark in the current session, press \key{Ctrl+,}.
746

747
    To go to next bookmark in the current session, press \key{Ctrl+.}.
748 749


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
750 751 752 753 754
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
758

759 760 761 762 763
    \section1 Using Update Code Model

    To refresh the internal information in Qt Creator pertaining to your code,
    select \gui{Tools} > \gui{C++} > \gui{Update code model}.

764 765
    \note In Qt Creator indexing updates the code automatically. Use
    \gui{Update code model} only as an emergency command.
766 767


768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
    \section1 Using FakeVim Mode

    In the \gui{FakeVim} mode, you can run the main editor in a manner similar
    to the Vim editor. To run the editor in the \gui{FakeVim} mode, select
    \gui{Edit} > \gui{Advanced} > \gui{Toggle vim-style editing} or press
    \key{Alt+V,Alt+V}.

    In the \gui{FakeVim} mode, most keystrokes in the main editor will be
    intercepted and interpreted in a way that resembles Vim.

    To map commands entered on the \gui{FakeVim} command line to actions of the
    Qt Creator core, select \gui{Tools} > \gui{Options...} > \gui{FakeVim} >
    \gui{Ex Command Mapping}.

    To make changes to the \gui{Vim style settings}, select \gui{Tools} >
    \gui{Options...} > \gui{General}.


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
786 787 788 789 790 791 792
    \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
793 794
        \o Add the editor path to the \c{PATH} environment variable of your
           operating system.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
795 796 797 798
        \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
799
           Smultron, enter \tt{\bold{smultron %f}}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
800 801

           To further define how to open the file in the external editor, you
802
           can use the following variables separated by a space:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816
           \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
817 818 819
*/


con's avatar
con committed
820 821
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
822 823 824
    \previouspage creator-editor-using.html
    \page creator-editor-finding.html
    \nextpage creator-editor-refactoring.html
con's avatar
con committed
825

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
826
    \title Finding and Replacing
con's avatar
con committed
827

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
828 829 830
    To search through the currently open file:
    \list 1
        \o Press \key Ctrl+F or select \gui Edit > \gui Find/Replace >
831
           \gui{Find/Replace}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
832 833 834 835 836 837 838 839
        \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
840

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
841 842 843 844 845 846 847 848 849 850 851 852 853 854
    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
           .
855
           Regular expressions used in Qt Creator are modeled on Perl regular
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
856
           expressions. For more information on using regular expressions, see
857 858
           \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
859
    \endlist
con's avatar
con committed
860

861 862 863
    \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
864 865 866 867 868 869 870 871 872 873 874
    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
875

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
876
    \section1 Advanced Search
con's avatar
con committed
877

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
878 879 880 881
    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 >
882 883
           \gui Find/Replace > \gui{Advanced Find} >
           \gui{Open Advanced Find...}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
        \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
914 915


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
916 917 918 919 920
/*!
    \contentspage index.html
    \previouspage creator-editor-finding.html
    \page creator-editor-refactoring.html
    \nextpage creator-editor-locator.html
con's avatar
con committed
921

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
922
    \title Refactoring
923

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
924 925 926 927 928 929 930 931 932
    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
933

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
934
    \section1 Finding Symbols
con's avatar
con committed
935

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
936 937 938
    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
939
           > \gui C++ > \gui{Find Usages} or press
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
940 941 942 943 944 945 946 947 948 949 950 951 952 953
           \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
954

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
955 956 957 958 959 960 961 962 963 964 965 966 967 968 969
    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
970

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
971 972 973
    \section1 Renaming Symbols

    To rename a specific symbol in your project:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
974
    \list 1
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
975 976
        \o In the editor, place the cursor on the symbol you would like to
           change and select \gui Tools > \gui C++ >