qtcreator.qdoc 198 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.84
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
       \o \l{Getting Started}
           \list
49 50
               \o \l{Creating a Qt C++ Application}
               \o \l{Creating a Qt Quick Application}
51
           \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
            \endlist
       \o \l{Debugging}
74 75 76 77 78 79
            \list
                \o \l{Debugging the Example Application}
                \o \l{Interacting with the Debugger}
                \o \l{Setting Up Debugger}
                \o \l{Using Debugging Helpers}
            \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
80
       \o \l{Using Version Control Systems}
81
       \o \l{Adding Qt Designer Plugins}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
82 83 84 85 86
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
87 88 89
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
90

con's avatar
con committed
91 92
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
93
    \previouspage index.html
Leena Miettinen's avatar
Leena Miettinen committed
94 95 96 97 98
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

99 100
  Qt Creator provides you with tools to design and develop user interfaces and
  complex applications for multiple desktop and mobile
101 102
  platforms.

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
  \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.
122 123

  \QMLD allows you to easily develop animations by using a declarative programming
124 125 126 127
  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
128
  in their state. \QMLD generates the necessary code for you.
129 130 131
  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.
132

133
  \section1 Coding Applications
134

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

169
      If you choose to create a Qt Quick application, Qt Creator generates a .qml file
170
      that you can modify with the \QMLD visual editor and the code editor.
Leena Miettinen's avatar
Leena Miettinen committed
171 172 173 174 175
*/

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

213 214 215
         \omit  ## Are the Xcode tools still needed separately? \endomit

    \section1 Build Environment
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
216 217 218

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

223 224 225 226 227 228 229 230 231 232 233 234 235 236
    \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
237 238 239

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


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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
271
    \title Quick Tour
con's avatar
con committed
272

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
273
    The figure below shows some of the components of Qt Creator in
274
    \gui{Edit} mode.
con's avatar
con committed
275 276 277

    \image qtcreator-breakdown.png

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
278
    \section1 Qt Creator Modes
con's avatar
con committed
279

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
280
    The mode selector allows you to quickly switch between tasks such as
281 282
    editing project and source files, designing application UIs,
    configuring how projects are built and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
283 284
    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
285 286

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

298 299
    Certain actions in Qt Creator trigger a mode change. Clicking on
    \gui {Debug} > \gui {Start debugging} > \gui {Start debugging}
300
    automatically switches to \gui {Debug} mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
301 302


303
    \section1 Browsing Project Contents
con's avatar
con committed
304

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
305 306
    Use the sidebar to browse files, projects and bookmarks.
    \image qtcreator-sidebar.png
con's avatar
con committed
307

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
308 309 310 311 312 313 314 315 316
    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
317

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
318 319 320 321 322
    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
323
           . Select new content to view in the split view.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
324 325 326 327
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed
328 329


330
    \section2 Viewing Project Files
con's avatar
con committed
331

332 333 334
    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
335

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
336 337
    You can use the project tree in the following ways:
    \list
338 339
        \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
340
           For example, through the menu of the project root directory you can,
341
           among other actions, build, re-build, clean and run the project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
342 343
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
344 345 346 347
           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
348 349 350 351 352 353
        \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
354 355 356
    \endlist


357
    \section1 Viewing Output
con's avatar
con committed
358

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
359
    The task pane in Qt Creator can display one of the following panes:
360 361 362 363 364 365 366 367
    \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
368

369

370
    \section2 Build Issues
con's avatar
con committed
371

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

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

380
    \image qtcreator-build-issues.png
con's avatar
con committed
381

382

con's avatar
con committed
383 384
    \section2 Search Results

385 386 387 388 389
    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
390
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed
391 392 393

    \image qtcreator-search-pane.png

394

con's avatar
con committed
395 396
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
397
    The \gui{Application Output} pane displays the status of a program when
398 399 400
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().
con's avatar
con committed
401 402 403

    \image qtcreator-application-output.png

404

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
405
    \section2 Compile Output
con's avatar
con committed
406

407 408 409
    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
410 411 412

    \image qtcreator-compile-pane.png

413

414
    \section1 Getting Help
con's avatar
con committed
415

416
    Qt Creator comes fully integrated with Qt documentation and
417
    examples using the Qt Help plugin.
418
    \list
419 420 421 422 423
        \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
424

425
           \image qtcreator-context-sensitive-help.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
426

427 428
        \o To select and configure how the documentation is displayed in the
           \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
429 430
    \endlist

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
431
    \section2 Adding External Documentation
con's avatar
con committed
432

433 434
    You can display external documentation in the \gui Help mode.
    To augment or replace the documentation that ships with Qt Creator and Qt:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
435 436 437 438 439
    \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
440
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}{The Qt Help Framework}.
441
        \o To add the .qch file to Qt Creator, select \gui Tools >
442
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
443
    \endlist
con's avatar
con committed
444

445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
    \section2 Using Documentation Filters

    You can filter the documents displayed in the \gui Help mode to find
    relevant information faster. Select from a list of filters in the
    \gui {Filtered by} field. The contents of the \gui Index and \gui Contents
    pane in the sidebar change accordingly.

    \image qtcreator-help-filters.png "Help filters"

    You can modify the filters to include external documentation, for example,
    or you can define your own filters. To construct filters, you can use the
    filter attributes that are specified in the documentation. Each document
    contains at least one filter attribute. If several documents contain the
    same filter attribute, such as \c tools, you can use that attribute to
    include all those documents.

    To add filters:

    \list 1

        \o Select \gui {Tools > Options... > Help > Filters > Add}.

        \o Enter a name for the filter and press \gui {OK}.

        \o In \gui Attributes, select the documents that you want to include
        in the filter.

        \image qtcreator-help-filter-attributes.png "Help filter attributes"

        \o Click \gui OK.

        \o In the \gui Help mode, select the filter in the \gui {Filtered by}
        field to see the filtered documentation in the sidebar.

    \endlist

    To modify filters, select a filter in \gui Filters, select the attributes,
    and then click \gui Apply.

    To remove filters, select them in \gui Filters, and click \gui Remove.
con's avatar
con committed
485

486
    \section1 Navigating with Keyboard
487

488 489 490
    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
491 492 493
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

494 495 496 497 498 499 500 501 502
    \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
503

504
    The integration includes project management and code completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
505

506
    \section1 Using Qt Designer
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
507

508
    Qt Creator automatically opens all .ui files in \QD.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
509 510 511

    \image qtcreator-formedit.png

512
    To change the layout of \QD user interface elements:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
513
    \list 1
514
        \o Select \gui Tools > \gui{Form Editor} > \gui Views >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
515 516 517 518 519 520 521
           \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

522
    To change \QD properties, select \gui Tools > \gui Options >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
    \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

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

543
    \section1 Using Qt Quick Designer
544 545 546 547

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

548
    In \gui Projects, double-click a .qml file to open it in the code
549 550 551 552 553 554 555 556 557
    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

558 559
    \o \gui {Navigator} pane displays the items in the scene. You can
    show and hide items to focus on specific parts of the application.
560 561 562 563 564 565

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

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

569
    \o \gui {State} pane displays the different states of the component. To add
570 571 572 573 574 575
    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
576 577
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
578

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
579 580
/*!
    \contentspage index.html
581
    \previouspage creator-qml-application.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
582 583
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
584

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
585
    \title Using the Editor
586

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
587
    Qt Creator's code editor is designed to aid you in creating, editing and
588 589 590
    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
591 592


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
593 594 595
    \section1 Configuring the Editor

    Qt Creator allows you to configure the text editor to suit your specific
596
    needs. To configure the editor, select  \gui Tools > \gui{Options...} >
597 598 599
    \gui{Text Editor}

    You can perform the following configuration actions:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
600 601 602 603 604
    \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.
605 606 607
        \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
608 609
           {moving to symbol definition or declaration}
           in \gui Display.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
610
        \o Configure \l{Code Completion}{code completion} in \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
611 612 613 614 615
    \endlist


    \section1 Using the Editor Toolbar

616 617 618
    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
619 620 621 622 623

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
624
        \o To browse forward or backward through your location history, click
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
625 626 627 628 629 630 631 632 633
           \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

634 635
    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
636 637 638 639 640 641 642 643 644


    \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

645
    You can split the editor view in the following ways:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659
    \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 >
660
    \gui{Go to Next Split} or press \key{Ctrl+E, O}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
661 662 663 664 665 666 667 668 669 670 671 672 673 674 675

    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

676
    To enable block highlighting, select \gui Tools > \gui{Options...} >
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
677 678 679 680 681 682 683
    \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.

684 685 686
    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
687 688 689 690


    \section1 Syntax Checking

691 692 693
    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
694 695 696
    \list
        \o Syntax errors are underlined in red.

697 698
           In the following figure, a semicolon is missing at the end of the
           line.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
699 700 701 702 703 704 705 706

           \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
707 708


709 710
    \section1 Code Completion

711 712
    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
713 714 715

    \image qtcreator-codecompletion.png

716 717 718
    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
719

720 721 722 723
    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
724 725 726

    The following table lists available types for code completion and icon
    used for each.
727 728

    \table
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
729 730 731
        \header
            \o Icon
            \o Description
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
        \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
781 782


783 784
    \section1 Using Bookmarks

785
    To insert or delete a bookmark right-click the line number and select
786 787 788 789
    \gui{Toggle Bookmark} or press \key{Ctrl+M}.

    \image qtcreator-togglebookmark.png

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

792
    To go to next bookmark in the current session, press \key{Ctrl+.}.
793 794


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
795 796 797 798 799
    \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.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
803

804 805 806 807 808
    \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}.

809 810
    \note In Qt Creator indexing updates the code automatically. Use
    \gui{Update code model} only as an emergency command.
811 812


813 814
    \section1 Pasting and Fetching Code Snippets

815
    In Qt Creator, you can paste snippets of code to a server or fetch
816 817 818 819 820 821 822 823
    snippets of code from the server. To paste and fetch snippets of code,
    Qt Creator uses the following:
    \list
        \o \gui{CodePaster}
        \o \gui{Pastebin.Com}
        \o \gui{Pastebin.Ca}
    \endlist

824
    To configure the server, select \gui{Tools} > \gui{Options...} >
825 826 827 828 829 830 831 832
    \gui{Code Pasting}.

    To paste a snippet of code onto the server, select \gui{Tools} >
    \gui{Code Pasting} > \gui{Paste Snippet...} or press \key{Alt+C,Alt+P}.

    To fetch a snippet of code from the server, select \gui{Tools} >
    \gui{Code Pasting} > \gui{Fetch Snippet...} or press \key{Alt+C,Alt+F}.

833
    \note To use \gui{Pastebin.Com}, configure the domain
834 835 836
    prefix in \gui{Tools} > \gui{Options...} > \gui{Code Pasting} >
    \gui{Pastebin.com}.

837 838 839 840 841 842 843 844
    For example, you might ask colleagues to review a change that you plan to
    submit to a version control system. If you use the git version control system,
    you can create a \e{diff} view by selecting \gui{Tools} > \gui{Git} >
    \gui{Diff Repository}. You can then upload its contents to the server by choosing
    \gui{Tools} > \gui{Code Pasting} > \gui{Paste Snippet...}. The reviewers can retrieve
    the code snippet by selecting \gui{Tools} > \gui{Code Pasting} > \gui{Fetch Snippet...}.
    If they have the project currently opened in Qt Creator, they can apply and test
    the change by choosing \gui{Tools} > \gui{Git} > \gui{Apply Patch}.
845

846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
    \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
864 865 866 867 868 869 870
    \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
871 872
        \o Add the editor path to the \c{PATH} environment variable of your
           operating system.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
873 874 875 876
        \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
877
           Smultron, enter \tt{\bold{smultron %f}}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
878 879

           To further define how to open the file in the external editor, you
880
           can use the following variables separated by a space:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
881 882 883 884 885 886 887 888 889 890 891 892 893 894
           \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
895 896 897
*/


con's avatar
con committed
898 899
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
900 901 902
    \previouspage creator-editor-using.html
    \page creator-editor-finding.html
    \nextpage creator-editor-refactoring.html
con's avatar
con committed
903

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
904
    \title Finding and Replacing
con's avatar
con committed
905

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
906 907 908
    To search through the currently open file:
    \list 1
        \o Press \key Ctrl+F or select \gui Edit > \gui Find/Replace >
909
           \gui{Find/Replace}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
910 911 912 913 914 915 916 917
        \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
918

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
919 920 921 922 923 924 925 926 927 928 929 930 931 932
    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
           .
933
           Regular expressions used in Qt Creator are modeled on Perl regular
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
934
           expressions. For more information on using regular expressions, see
935 936
           \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
937
    \endlist
con's avatar
con committed
938

939 940 941
    \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
942 943 944 945 946 947 948 949 950 951 952
    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
953

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
954
    \section1 Advanced Search
con's avatar
con committed
955

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
956 957 958 959
    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 >
960 961
           \gui Find/Replace > \gui{Advanced Find} >
           \gui{Open Advanced Find...}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991
        \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
992 993


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
994 995 996 997 998
/*!
    \contentspage index.html
    \previouspage creator-editor-finding.html
    \page creator-editor-refactoring.html
    \nextpage creator-editor-locator.html
con's avatar
con committed
999

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1000
    \title Refactoring
1001

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1002 1003 1004 1005 1006 1007 1008 1009 1010
    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
1011

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1012
    \section1 Finding Symbols
con's avatar
con committed
1013

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1014 1015 1016
    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
Rohan Shetty's avatar