qtcreator.qdoc 80 KB
Newer Older
con's avatar
con committed
1 2 3
/*!
    \contentspage{index.html}{Qt Creator}
    \page index.html
4
    \nextpage creator-quick-tour.html
con's avatar
con committed
5 6 7

    \title Qt Creator Manual

con's avatar
con committed
8
    \section1 Version 1.3.0
con's avatar
con committed
9 10 11 12 13

    The goal of Qt Creator is to provide a cross-platform, complete Integrated
    Development Environment (IDE) to develop Qt projects. It is available for
    the Linux, Mac OS X and Windows platforms.

14
    \note Please report bugs and suggestions to the
con's avatar
con committed
15
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
16 17 18 19 20
    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}
    {qt-creator-request@trolltech.com}. For more information on Qt mailing
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed
21

22 23
    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
24
    \endraw
25

con's avatar
con committed
26
    \list
27 28 29
       \o   \l{A Quick Tour of Qt Creator}
       \o   \l{Creating a Project in Qt Creator}
       \o   \l{The Code Editor}
con's avatar
con committed
30
       \o   \l{Project Settings}
31 32 33 34
       \o   \l{Qt Version Management}
       \o   \l{Writing a Simple Program with Qt Creator}
       \o   \l{Qt Creator and Version Control Systems}
       \o   \l{Navigating Quickly Around Your Code with Locator}
35
       \o   \l{Session Management in Qt Creator}
36
       \o   \l{Debugging with Qt Creator}
37 38
       \o   \l{CMake Support in Qt Creator}
       \o   \l{Support for Generic Projects in Qt Creator}
39
       \o   \l{Development of Qt for Symbian Based Applications}
40
       \o   \l{Handling External Libraries}
41 42 43 44
       \o   \l{Tips and Tricks}
       \o   \l{Keyboard Shortcuts}
       \o   \l{Glossary}
       \o   \l{Supported Platforms}
45
       \o   \l{Known Issues}
46
       \o   \l{Acknowledgements}
con's avatar
con committed
47 48 49 50 51 52
    \endlist
*/

/*!
    \contentspage index.html
    \page creator-quick-tour.html
53
    \nextpage creator-code-editor.html
con's avatar
con committed
54

55
    \title A Quick Tour of Qt Creator
con's avatar
con committed
56

57 58
    The labeled screenshot below shows some of the components of Qt Creator, in
    \gui Edit mode.
con's avatar
con committed
59 60 61

    \image qtcreator-breakdown.png

Kavindra Palaraja's avatar
Kavindra Palaraja committed
62
    \section1 The Mode Selectors
con's avatar
con committed
63

64 65
    When working in Qt Creator, you can be in one of six modes: \bold Welcome,
    \bold Edit, \bold Debug, \bold Projects, \bold Help, and \bold Output.
con's avatar
con committed
66

67 68
    Mode selectors allow you to quickly switch between tasks: Editing, browsing
    the Qt Creator manual, setting up the build environment, etc. You can
con's avatar
con committed
69 70 71 72 73 74 75 76
    activate a mode by either clicking on its mode selector, or using the
    \l{keyboard-shortcuts}{corresponding shortcut}. Certain actions also
    trigger a mode change, e.g., \gui{Debug}/\gui{Start Debugging} will switch
    to the \gui Debug mode.

    \list

    \o \gui{Welcome Mode} - Displays a welcome screen allowing you to quickly
77 78
    load recent sessions or individual projects. This is the mode you will see
    if Qt Creator is run without command line switches.
con's avatar
con committed
79

80 81
    \o \gui{Edit Mode} - Lets you edit both project and source files. A sidebar
    on the left provides different views to navigate between files.
con's avatar
con committed
82 83

    \o \gui{Debug Mode} - Provides various ways to inspect the state of the
84 85
    program while debugging. See \l{Debugging With Qt Creator} for a hands-on
    description of how to use this mode.
con's avatar
con committed
86

87
    \o \gui{Projects Mode} - Lets you configure how projects can be built and
88
    executed. Under the list of projects, there are tabs to configure the
89
    build, run, and editor settings.
con's avatar
con committed
90 91 92 93

    \o \gui{Help Mode} - Shows any documentation registered by Qt Assistant,
    such as the Qt library and Qt Creator documentation.

94 95 96
    \o \gui{Output Mode} - Lets you examine various data in detail, for example
    build issues as well as compile and application output. This information
    is also available in the output panes.
con's avatar
con committed
97 98 99 100 101 102

    \endlist


    \section1 The Output Panes

103 104
    The task pane in Qt Creator can display one of four different panes:
    \gui{Build Issues}, \gui{Search Results}, \gui{Application Output}, and
105
    \gui{Compile Output}. These panes are available in all modes.
con's avatar
con committed
106

107

108
    \section2 Build Issues
con's avatar
con committed
109

110 111 112
    The \gui{Build Issues} pane provides a list of issues, e.g., error messages
    or warnings that need to be fixed. It filters out irrelevant output from
    the compiler and collects them in an organized way.
con's avatar
con committed
113

114
    \image qtcreator-build-issues.png
con's avatar
con committed
115

116

con's avatar
con committed
117 118
    \section2 Search Results

119 120 121 122
    The \gui{Search Results} pane displays the results for global searches such
    as searching within a current document, files on disk, or all projects. In
    the screenshot below, we searched for all occurrences of \c{textfinder}
    within the \c{"/TextFinder"} folder.
con's avatar
con committed
123 124 125

    \image qtcreator-search-pane.png

126

con's avatar
con committed
127 128
    \section2 Application Output

129 130
    The \gui{Application Output} pane displays the status of the program when
    it is executed and debug output, e.g., output from qDebug().
con's avatar
con committed
131 132 133

    \image qtcreator-application-output.png

134

135
    \section2 Compile
con's avatar
con committed
136

137 138
    The \gui{Compile Output} pane provides all the output from the compiler. In
    other words, it is a more verbose version of information displayed in the
139
    \gui{Build Issues}
con's avatar
con committed
140 141 142

    \image qtcreator-compile-pane.png

143

con's avatar
con committed
144 145 146 147 148 149 150
    \section1 Qt Help Integration

    Qt Creator comes fully integrated with all of Qt's documentation and
    examples via the Qt Help plugin. To view the documentation, you can switch
    to the \gui{Help} mode. To obtain context sensitive help, move your text
    cursor to a Qt class or function and press \key{F1}. The documentation
    will be displayed within a panel on the right, as shown in the screenshot
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
151
    below. If there is enough vertical space, it will be shown in the
152
    fullscreen help mode.
con's avatar
con committed
153 154 155 156 157 158 159 160 161 162 163 164

    External Documentation provided by the user can be used to augment or
    replace the documentation shipped with Qt Creator and Qt.

    \image qtcreator-context-sensitive-help.png


    \section1 Qt Designer Integration

    Qt Creator is fully integrated with Qt Designer to help you design user
    interface forms just like you would with the standalone version. The Qt
    Designer integration also includes project management and code completion.
165
    For more information on Qt Designer, you can refer to
166
    \l{http://doc.trolltech.com/designer-manual.html}{The Designer Manual}.
con's avatar
con committed
167 168 169 170 171

    \image qtcreator-formedit.png


    \section1 Keyboard Navigation
172

173 174 175 176 177
    Qt Creator caters not only to developers who are used to using the mouse,
    but also to developers who are more comfortable with the keyboard. A wide
    range of \l{keyboard-shortcuts}{keyboard} and
    \l{Navigating Quickly Around Your Code with Locator}{navigation} shortcuts
    are available to help speed up the process of developing your application.
con's avatar
con committed
178 179
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
180 181
/*!
    \contentspage index.html
182 183
    \previouspage creator-quick-tour.html
    \page creator-code-editor.html
184
    \nextpage creator-project-pane.html
185 186 187

    \title The Code Editor

188 189 190 191 192
    Qt Creator's code editor is designed to aid the developer to create, edit,
    and navigate code. It is fully equipped with syntax highlighting, code
    completion, context sensitive help, as well as inline error indicators
    while you are typing. The screenshots below show the various dialogs within
    which you can configure your editor.
193

194 195 196
    \table
        \row
            \i  \inlineimage qtcreator-texteditor-fonts.png
197 198 199
            \i  \inlineimage qtcreator-texteditor-behavior.png
        \row
            \i  \inlineimage qtcreator-texteditor-display.png
200 201 202 203
            \i  \inlineimage qtcreator-texteditor-completion.png
    \endtable

    The table below lists keyboard shortcuts supported by the code editor.
204 205 206 207

    \table
        \row
            \i  Block navigation
dt's avatar
dt committed
208 209
            \i  To navigate between blocks, e.g., from one \bold{\{} to another
                \bold{\}} , use \key{Ctrl+[} and \key{Ctrl+]}.
210 211 212 213
        \row
            \i  Block selection
            \i  To select a current block, use \key{Ctrl+U}. Pressing
                \key{Ctrl+U} again extends the selection to the parent block.
214
                To deselect, use \key{Ctrl+Shift+U}.
215 216
        \row
            \i  Moving lines up and down
217
            \i  Use \key{Ctrl+Shift+Up} and \key{Ctrl+Shift+Down}
218 219 220

        \row
            \i  Completion
221
            \i  Use \key{Ctrl+Space}
222 223

        \row
224
            \i  Indenting Blocks
225
            \i  Use \key{Ctrl+I}
226 227 228 229 230

        \row
            \i  Collapse
            \i  Use \key{Ctrl+\<}

231
        \row
232 233
            \i  Commenting or uncommenting blocks
            \i  Use \key{Ctrl+\/}
234

235 236 237 238
        \row
            \i  Delete a line
            \i  Use \key{Shift+Del}

239
        \row
240
            \i  Switch between header file and source file
241 242 243
            \i  Use \key{F4}.

        \row
244
            \i  Increasing and decreasing font size
245 246 247
            \i  Use \key{Ctrl+Scroll Wheel}

        \row
248
            \i  Follow symbols under the cursor
249 250 251
            \i  Use \key{F2} and \key{Shift+F2}. This feature works with
                namespaces, classes, methods, variables, include statements,
                and macros.
252

253 254 255 256 257
        \row
            \i  Switch to an external editor
            \i  Select \gui{Open in external editor} from the
                \gui{Edit -> Advanced} menu.
    \endtable
258

259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
    \section1 Code Completion

    The completion popup shows possible completions to a certain statement.
    These completions include classes, namespaces, functions, variables,
    macros and keywords. Listed below are the icons used in the completion box
    and their meaning.

    \table
        \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
316 317 318
*/


con's avatar
con committed
319 320
/*!
    \contentspage index.html
321
    \previouspage creator-code-editor.html
322
    \page creator-project-pane.html
323
    \nextpage creator-version-management.html
con's avatar
con committed
324

325
    \title Project Settings
con's avatar
con committed
326 327 328

    \table
        \row
329 330 331
            \i  \note This page describes Qt Creator's support for \c qmake.
                For information on CMake support, see
                \l{CMake Support in Qt Creator}.
con's avatar
con committed
332 333
    \endtable

334 335
    To modify the project settings of your project, switch to the \gui{Projects}
    mode using the mouse or \key{Ctrl+4}.
con's avatar
con committed
336

337
    \image qtcreator-projectpane.png
con's avatar
con committed
338

339 340 341 342 343
    The project pane is divided into two areas. At the top the currently active
    settings are shown. The active build or run configuration for all projects
    can be changed there. The bottom area allows you to quickly get an overview
    of the build, run and editor settings as well as the dependencies between your
    projects. It also allows you to edit those settings.
con's avatar
con committed
344

345
    \section1 Build Settings
con's avatar
con committed
346

347 348 349 350 351 352 353 354
    Build configurations allow you to quickly switch between different build
    settings. By default Qt Creator Qt Creator creates a \bold{debug} and
    \bold{release} build configuration. Both these configurations use the
    \l{glossary-default-qt}{Default Qt Version}. Action items to create, clone,
    or delete build configurations can be found at the top. You can have as
    many build configurations as needed. To edit settings click on the
    \gui{Show Details} button. Here you can specify which
    \l{glossary-project-qt}{Qt version} to use to build your project, or whether
355
    to \l{glossary-shadow-build}{shadow build} the project, for instance.
con's avatar
con committed
356

357
    \image qtcreator-ppbuildsettings.png
con's avatar
con committed
358

359 360 361 362 363
    The build system of Qt Creator is built on top of \c qmake and \c make. The
    settings for \c qmake and \c make can be changed. Qt Creator will run the
    make command using the correct Qt version.

    In the \bold{Build Environment} section you can specify the environment used
con's avatar
con committed
364 365
    for building. By default the environment in which Qt Creator was started
    is used and modified to include the Qt version. Depending on the selected
366
    Qt version, Qt Creator will automatically set the necessary environment
con's avatar
con committed
367 368
    variables.

369
    \section1 Run Settings
con's avatar
con committed
370

371 372 373 374 375
    \image qtcreator-pprunsettings.png
    Qt Creator automatically creates run configurations for your project.
    These run configurations derive their executable
    from the parsed .pro files. You can also create \bold{custom executable}
    run configurations where you can freely set the executable to be run.
con's avatar
con committed
376

377 378 379 380
    \section1 Dependencies

    If you have multiple projects loaded in your session, you can configure
    dependencies between them. This will affect the build order of your
381
    projects. To do this, go the the \bold{Dependencies} section after selecting
382 383
    the project for which you want to configure the dependencies, and then use
    the checkboxes to check which of the other projects is a dependency.
384
    \note This is unrelated to the dependencies inside a qmake project.
385 386
*/

387

388 389
/*!
    \contentspage index.html
390
    \previouspage creator-project-pane.html
391 392
    \page creator-version-management.html
    \nextpage creator-creating-project.html
con's avatar
con committed
393

394
    \title Qt Version Management
con's avatar
con committed
395 396 397 398 399 400

    Qt Creator allows you to use multiple versions of Qt installed on your hard
    disk and switch between them easily.

    Qt Creator automatically detects if \c qmake is in the environment variable
    \c PATH. This \l{glossary-system-qt}{version of Qt} is referred to as
401
    \bold{Qt in PATH}. If you intend to use only one version of Qt - it is
con's avatar
con committed
402 403 404 405
    already in your path and correctly set up for command line usage - you do
    not need to manually configure your Qt version.

    Otherwise, you can add your Qt version in
406 407
    \gui{Tools -> Options... -> Qt Versions} on Windows and Linux or
    in \gui{Qt Creator -> Preferences... -> Qt Versions} on Mac OS X.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
408

409 410
    The detailed settings depend on your Operating system and on the targeted
    tool chain
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
411

412 413 414 415 416
        \table
        \row
            \i \image qtcreator-qt4-qtversions.png
               On Linux and Mac OS X, simply set the \gui{Path to QMake}
               to the \c qmake binary of the Qt installation. If a Qt is
417
               found in the \c PATH environment variable, it will show up
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
418 419
               automatically as \gui{Qt in PATH}.

420 421 422 423
               On both platforms, the platforms Gnu Compiler Collection (GCC)
               is used to compile Qt. On Mac OS, the GCC compiler is part of XCode.
               On Linux, the Intel Compiler (ICC) is supported as a drop-in replacement
               for GCC.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
424

425 426
        \row
            \i \image qtcreator-qt4-qtversions-win-mingw.png
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
427
               If you are on the Windows platform and used MinGW
428
               to compile Qt, you need to additionally tell Qt Creator
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
429
               where MinGW is installed.  This is done by setting the
430 431 432 433
               \gui{MinGW Directory}.
        \row
            \i \image qtcreator-qt4-qtversions-win-msvc.png
               If your Qt version is compiled with Microsoft Visual C++'s
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
434
               compiler, Qt Creator will automatically set the correct
435
               environment variables for compilation. The \gui{MSVC}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
436
               dropdown box indicates the internal Version Number of the
437
               installed Microsoft Visual C++ tool chains:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
438

439 440 441 442 443
               \list
                   \o  \bold{7.1}: Visual Studio 2003
                   \o  \bold{8.0}: Visual Studio 2005
                   \o  \bold{9.0}: Visual Studio 2008
               \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
444

445 446 447 448 449
               If you are using the \c{Windows SDK for Windows Server 2008}
               instead of Visual Studio, it will identify as version 9.0.
        \row
            \i \image qtcreator-qt4-qtversions-win-symbian.png
               If you are using Qt for Symbian and your S60 SDK is registered
450
               with \c devices.exe, Qt Creator will detect the Qt version
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
451 452 453 454 455
               automatically. These are shown in the \bold{Auto-detected}
               section in the options dialog.
               You can also manually add Qt for Symbian versions. In this case
               you need to tell Qt Creator the path to the S60 SDK
               it is supposed to use with these Qt installations.
456
               Add the path to your Carbide C++ install, version 2.0
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
457 458 459 460 461 462 463
               or later, if you want to build for the emulator
               (\c WINSCW tool chain).
               If you want to use \c GCCE to build for your device,
               you might need to add the path to the
               \c{CSL Arm Toolchain} directory (\gui{CSL/GCCE Directory}),
               if the compiler is not found in the \c PATH environment
               variable.
464
        \endtable
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
465

con's avatar
con committed
466 467 468 469 470
    \note By default projects are compiled with the
    \l{glossary-default-qt}{default Qt version}. You can override this in the
    \gui{Build Configuration}.
*/

471

con's avatar
con committed
472 473
/*!
    \contentspage index.html
474
    \previouspage creator-version-management.html
con's avatar
con committed
475 476 477 478 479 480 481
    \page creator-creating-project.html
    \nextpage creator-writing-program.html

    \title Creating a Project in Qt Creator

    \table
        \row
482
            \i \inlineimage qtcreator-new-project.png
con's avatar
con committed
483 484
            \i \bold{Creating a New Project}

485 486
        To create a new project, select \gui{New Project} from the \gui{File} menu.
        You can create one of the following three projects:
487

488 489 490 491 492
        \list
            \o Qt4 Console Application
            \o Qt4 Gui Application
            \o C++ Library
        \endlist
con's avatar
con committed
493

494
        In this example, we select a \e{Qt4 Gui Application} and click \gui{OK}.
con's avatar
con committed
495 496

        \row
497
            \i \inlineimage qtcreator-intro-and-location.png
498
            \i \bold{Setting the Project name and location}
con's avatar
con committed
499 500 501 502 503 504 505

        Next, we set the project's name and its path. Click on the \gui{...}
        button to browse and select your path.

        Ideally, the path should not contain spaces or special characters.

        \row
506
            \i \inlineimage qtcreator-select-modules.png
con's avatar
con committed
507 508 509 510 511 512 513 514 515
            \i \bold{Selecting The Necessary Qt Modules}

        Click on the check boxes of each Qt Module you would like to include in
        your project.

        Since we started a Qt4 Gui Application, the Core and Gui modules are
        set, but you are free to add more.

        \row
516
            \i \inlineimage qtcreator-class-info.png
con's avatar
con committed
517 518
            \i \bold{Specifying Class Information}

519
        Specify the name of the class you would like to create. The
con's avatar
con committed
520
        \e{Header file}, \e{Source file} and \e{Form file} fields will update
521
        automatically according to your choice of class name.
con's avatar
con committed
522 523

        You also have to select the base class for your class, either a
524 525 526
        QWidget, QDialog or QMainWindow,  from the drop down box.

        \row
527
            \i \inlineimage qtcreator-new-project-summary.png
528 529 530
            \i \bold{Creating the Project}

        Finally, review the files that will be created for you. Click
con's avatar
con committed
531
        \gui{Done} and your project will be generated.
532

con's avatar
con committed
533
    \endtable
534

con's avatar
con committed
535 536
*/

537

con's avatar
con committed
538 539 540 541
/*!
    \contentspage index.html
    \previouspage creator-creating-project.html
    \page creator-writing-program.html
542
    \nextpage creator-version-control.html
con's avatar
con committed
543 544 545 546 547 548 549

    \title Writing a Simple Program with Qt Creator

    \table
        \row
        \o \note This tutorial assumes that the user has experience writing
           basic Qt applications, designing user interfaces with Qt Designer
Kavindra Devi Palaraja's avatar
Kavindra Devi Palaraja committed
550
           and using the Qt Resource System.
con's avatar
con committed
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
    \endtable


    In this example, we will describe the steps involve in using Qt Creator
    to create a small Qt program, Text Finder. Inspired by the QtUiTools'
    \l{http://doc.trolltech.com/uitools-textfinder.html}{Text Finder}
    example, we will write a similar but simplified version of it, as shown
    below.

    \image qtcreator-textfinder-screenshot.png

    \section1 Setting Up Your Environment

    Once you have installed Qt Creator, it will automatically detect if Qt's
    location is in your \c PATH variable. If Qt's location is not in your
    \c PATH, you can set it in one of the following ways, depending on your
    platform:

    \list
         \o On Windows and Linux: in the \gui{Tools} menu, under \gui{Options}.
         \o On Mac OS X: in \gui{Preferences}, under \gui{Qt4}.
    \endlist

574 575
    \note If you use Visual Studio to compile Qt, all environment variables set
    in Visual Studio will be set for Qt Creator as well.
con's avatar
con committed
576 577 578 579 580

    \section1 Setting Up The Project

    We begin with a Qt4 Gui Application project generated by Qt Creator. The
    \l{Creating a Project in Qt Creator} document describes this process in
581 582 583
    detail. Remember to select QWidget as the Text Finder's base class. If
    your project is not yet loaded, you can load it by selecting \gui{Open}
    from the \gui{File} menu.
con's avatar
con committed
584

585
    In your project you will have the following files:
con's avatar
con committed
586 587 588 589 590 591 592 593

    \list
        \o \c{textfinder.h}
        \o \c{textfinder.cpp}
        \o \c{main.cpp}
        \o \c{textfinder.ui}
        \o \c{textfinder.pro}
    \endlist
594

con's avatar
con committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
    The \c{.h} and \c{.cpp} files come with the necessary boiler plate code;
    the \c{.pro} file is also complete.

    \section1 Filling In The Missing Pieces

    We will begin by designing the user interface and then move on to filling
    in the missing code. Finally, we will add the find functionality.

    \section2 Designing the User Interface

    To begin designing the user interface, double-click on the
    \c{textfinder.ui} file in your \gui{Project Explorer}. This will launch the
    integrated Qt Designer.

    \image qtcreator-textfinder-ui.png

611
    Design the form above using a \l{http://doc.trolltech.com/qlabel.html}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
612
    {QLabel}, \l{http://doc.trolltech.com/qlinedit.html}{QLineEdit}
hjk's avatar
hjk committed
613 614 615 616
    (named lineEdit), \l{http://doc.trolltech.com/qpushbutton.html}{QPushButton}
    (named findButton), and a
    \l{http://doc.trolltech.com/qtextedit.html}{QTextEdit} (named textEdit).
    We recommend that
617 618 619 620 621 622 623
    you use a QGridLayout to lay out the
    \l{http://doc.trolltech.com/qlabel.html}{QLabel},
    \l{http://doc.trolltech.com/qlinedit.html}{QLineEdit} and
    \l{http://doc.trolltech.com/qpushbutton.html}{QPushButton}. The
    \l{http://doc.trolltech.com/qtextedit.html}{QTextEdit} can then be added to
    a \l{http://doc.trolltech.com/qvboxlayout.html}{QVBoxLayout}, along with
    the \l{http://doc.trolltech.com/qgridlayout.html}{QGridLayout}. If you are
624
    new to designing forms with \QD, you can take a look at the
con's avatar
con committed
625 626 627 628 629 630 631 632
    \l{http://doc.trolltech.com/designer-manual.html}{Designer Manual}.

    \section2 The Header File

    The \c{textfinder.h} file already has the necessary includes, a
    constructor, a destructor, and the \c{Ui} object. We need to add a private
    slot, \c{on_findButton_clicked()}, to carry out our find operation. We
    also need a private function, \c{loadTextFile()}, to read and display the
633 634 635
    contents of our input text file in the
    \l{http://doc.trolltech.com/qtextedit.html}{QTextEdit}. This is done with
    the following code:
con's avatar
con committed
636

637
    \snippet examples/textfinder/textfinder.h 0
638

639
    \note The \c{Ui::TextFinder} object is already provided.
con's avatar
con committed
640 641 642 643 644 645 646

    \section2 The Source File

    Now that our header file is complete we move on to our source file,
    \c{textfinder.cpp}.  We begin by filling in the functionality to load a
    text file. The code snippet below describes this:

647
    \snippet examples/textfinder/textfinder.cpp 0
con's avatar
con committed
648

649 650 651 652
    Basically, we load a text file using
    \l{http://doc.trolltech.com/qfile.html}{QFile}, read it with
    \l{http://doc.trolltech.com/qtextstream.html}{QTextStream}, and
    then display it on \c{textEdit} with
hjk's avatar
hjk committed
653 654
    \l{http://doc.trolltech.com/qtextedit.html#plainText-prop}{setPlainText()}
    which requires adding the following additional #includes to textfinder.cpp:
655 656

    \snippet examples/textfinder/textfinder.cpp 1
con's avatar
con committed
657 658

    For the \c{on_findButton_clicked()} slot, we extract the search string and
659 660 661
    use the \l{http://doc.trolltech.com/qtextedit.html#find}{find()} function
    to look for the search string within the text file. The code snippet below
    further describes it:
con's avatar
con committed
662

663
    \snippet examples/textfinder/textfinder.cpp 2
con's avatar
con committed
664 665 666 667

    Once we have both these functions complete, we call \c{loadTextFile()} in
    our constructor.

668
    \snippet examples/textfinder/textfinder.cpp 3
con's avatar
con committed
669 670 671 672 673

    The \c{on_findButton_clicked()} slot will be called automatically due to
    this line of code:

    \code
674
    QMetaObject::connectSlotsByName(TextFinder);
con's avatar
con committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689
    \endcode

    in the uic generated \c{ui_textfinder.h} file.

    \section2 The Resource File

    We require a resource file (\c{.qrc}) within which we will embed the input
    text file. This can be any \c{.txt} file with a paragraph of text. To add
    a resource file, right click on \gui{Resource Files} in the
    \gui{Project Explorer} and select \gui{Add New File...}. You will see the
    wizard dialog displayed below.

    \image qtcreator-add-resource-wizard.png

    Enter "textfinder" in the \gui{Name} field and use the given \gui{Path}.
690 691 692 693 694 695 696 697
    Then, click \gui{Continue}.

    \image qtcreator-add-resource-wizard2.png

    On this page you can choose to which project you want to add the new file.
    Make sure that \gui{Add to Project} is checked and
    "TextFinder" is selected as the \gui{Project}, and click
    \gui{Done}.
con's avatar
con committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712

    Your resource file will now be displayed with the Resource Editor. Click
    on the \gui{Add} drop down box and select \gui{Add Prefix}. The prefix we
    require is just a slash (\c{/}). Click \gui{Add} again but this time,
    select \gui{Add File}. Locate the text file you are going to use, we use
    \c{input.txt}.

    \image qtcreator-add-resource.png

    The screenshot above shows what you can expect to see once you have added
    the resource file successfully.

    \section1 Compiling and Running Your Program

    Now that you have all the necessary files, you can compile your program by
713
    clicking on the
con's avatar
con committed
714 715
    \inlineimage qtcreator-run.png
    button.
716

con's avatar
con committed
717 718 719 720 721
*/

/*!
    \contentspage index.html
    \previouspage creator-writing-program.html
722
    \page creator-version-control.html
723
    \nextpage creator-navigation.html
724 725 726 727 728 729 730 731

    \title Qt Creator and Version Control Systems

    \table
        \caption    Version control systems supported by Qt Creator
        \row
            \i  \bold{git}
            \i  \l{http://git-scm.com/}
732
            \i
733 734 735
        \row
            \i  \bold{Subversion}
            \i  \l{http://subversion.tigris.org/}
736
            \i
737 738 739
        \row
            \i  \bold{Perforce}
            \i  \l{http://www.perforce.com}
740
            \i  Server version 2006.1 and later
741 742 743 744
        \row
            \i  \bold{CVS}
            \i  \l{http://www.cvshome.org}
            \i
745 746 747 748 749 750 751 752
    \endtable


    \section1 Setup

    Qt Creator uses the version control system's command line clients to
    access your repositories. To set it up, you must ensure that these command
    line clients can be located via the \c{PATH} environment variable. You can
753
    specify the path to the command line client's executable in the settings
754 755 756
    pages that can be found under \gui{Options...} in the \gui{Tools} menu.


757 758
    \section1 Usage

Dean Dettman's avatar
Dean Dettman committed
759
    You can find the version control menu entries in a sub-menu of the
760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
    \gui{Tools} menu. The version control system displayed here is the system
    that manages the current project.

    Each version control system adds a pane to the \gui{Application Output}
    panes within which it will log the commands it executes, prepended by a
    timestamp and the relevant output.

    \image qtcreator-vcs-pane.png


    \section2 Addings Files

    When you create a new file or a new project, the wizards will display page
    requesting whether the files should be added to a version control system.
    This depends on whether the parent directory or the project is already
    under version control and the system supports the concept of adding files,
    e.g., \bold{Perforce} and \bold{Subversion}. Alternatively, you can also
    add files later on using the version control tool menus.

    With \bold{git}, there is no concept of adding files. Instead, all modified
    files must be \e{staged} for a commit.


    \section2 Viewing Diff Output

    All version control systems provide menu options to \e{diff} the current
    file or project - comparing with the latest version stored in the
    repository and displaying the differences. In Qt Creator, a diff is
    displayed in a read-only editor. If the file is accessible, you can double
    -click on a selected diff chunk and Qt Creator will open an editor
    displaying the file, scrolled to the line in question.

    \image qtcreator-vcs-diff.png


    \section2 Viewing Versioning History and Change Details

    The versioning history of a file can be displayed by selecting the
798 799
    \gui{Log} (for \bold{git}) or \gui{Filelog} (for \bold{Perforce} and
    \bold{Subversion}) option. Typically, the log output will contain the
800 801 802 803 804
    date, the commit message, and a change or revision identifier. If you
    click on the identifier, a description of the change including the diff
    will be displayed.

    \image qtcreator-vcs-log.png
Friedemann Kleint's avatar
Friedemann Kleint committed
805
    \image qtcreator-vcs-describe.png
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839


    \section2 Annotating Files

    Annotation views are obtained by selecting \gui{Annotate} or \gui{Blame}.
    This will display the lines of the file prepended by the change identifier
    they originate from. Clicking on the change identifier shows a detailed
    description of the file.


    \section2 Committing Changes

    Once you have finished making changes, you can submit them to the version
    control system by choosing \gui{Commit} or \gui{Submit}. Qt Creator will
    display a commit page containing a text editor, where you can enter your
    commit message, and a checkable list of modified files to be included.
    When you are done, click \gui{Commit} to start committing. In addition,
    there is a \gui{Diff selected} button that brings up a diff view of the
    files selected in the file list. Since the commit page is just another
    editor, you can go back to it by closing the diff view. Alternatively, you
    can view it from the editor combo box showing the \gui{Opened files}.

    \image qtcreator-vcs-commit.png


    \section2 Menu Entries Specific to git

    The git sub-menu contains additional entries:

    \table
        \row
            \i  \gui{Stash}
            \i  Stash local changes prior to executing a \bold{pull}.
        \row
840 841 842 843 844 845 846 847 848 849 850 851
            \i  \gui{Pull}
            \i  Pull changes from the remote repository. If there are locally
                modified files, you will be prompted to stash those changes.
        \row
            \i  \gui{Branches...}
            \i  Displays the branch dialog showing the local branches at the
                top and remote branches at the bottom. To switch to the local
                branch, simply double-click on it. Double-clicking on a remote
                branch will first create a local branch with the same name that
                tracks the remote branch, and then switch to it.

                \image qtcreator-vcs-gitbranch.png
852
    \endtable
853

854 855
    \section2 Common options

856 857 858
    The \gui{Version Control/Common} settings page features common settings for
    version control systems, such as commit message line wrapping and checking
    options.
859

860 861 862 863 864 865 866 867
    \gui{Submit message checking script} is a script or program that can be
    used to perform checks on the submit message before submitting. The submit
    message is passed in as the script's first parameter. If there is an error,
    the script should output a message on standard error and return a non-zero
    exit code.

    \gui{User/alias configuration file} takes a file in mailmap format that
    lists user names and aliases. For example:
868 869 870 871 872 873

    \code
    Jon Doe <Jon.Doe@company.com>
    Hans Mustermann <Hans.Mustermann@company.com> hm <info@company.com>
    \endcode

874 875 876 877 878
    Notice that the second line specifies the alias \e{hm} and the
    corresponding email address for \e{Hans Mustermann}. If the user/alias
    configuration file is present, the submit editor will display a context
    menu with \gui{Insert name...} that will pop up a dialog letting the user
    select a name.
879

880 881
    \gui{User field configuration file} is a simple text file consisting of
    lines specifying submit message fields that take user names, for example:
882 883 884 885 886 887

    \code
    Reviewed-by:
    Signed-off-by:
    \endcode

888 889 890 891
    These fields will appear below the submit message. They provide completion
    for the aliases/public user names specified in the
    \e{User/alias configuration file} as well as a button that opens the
    aforementioned user name dialog.
892

con's avatar
con committed
893 894 895
*/


896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
/*!
    \contentspage index.html
    \previouspage creator-version-control.html
    \page creator-navigation.html
    \nextpage creator-debugging.html

    \title Navigating Quickly Around Your Code with Locator

    With Qt Creator, navigating to different locations in your project or on
    your disk, e.g., files, classes, methods, etc., is trivial using
    \gui Locator -- a smart line edit at the bottom left of Qt Creator's
    window.

    \image qtcreator-locator.png

    Suppose you would like to open your project's \c{main.cpp} file, click on
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
912
    \gui Locator or use \key{Ctrl+K} (Mac OS X: \key{Cmd+K}), type in the file
913 914
    name and then press \key Return. The file will be opened in the editor.
    You can also type part of a file name and use the wildcard characters
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
915
    \c{*} and \c{?} to match \e{any} number of \e{any} characters. A list
916
    of all files matching  your criteria will be displayed.
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938

    \gui Locator not only allows you to navigate files on disk but also other
    "locations", which are organized with \bold{Filters}. Currently there are
    filters for:

    \list
        \o  files anywhere on your hard disk (browsing through the file system),
        \o  files from a subdirectory structure defined by you,
        \o  files mentioned in your \c{.pro} files, such as source, header,
            resource, and \c{.ui} files,
        \o  any open document,
        \o  class and method definitions in your project or anywhere referenced
            from your project,
        \o  help topics, including Qt's documentation, and,
        \o  a specific line in the document displayed on your editor,
    \endlist


    Some of these filters require you to activate them by typing an assigned
    \e prefix. This prefix is usually a single character followed by
    \key{Space}. For example, to jump to the definition of the class
    \l{http://doc.trolltech.com/qdatastream.html}{QDataStream}, type:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
939
    \key{Ctrl+K} (Mac OS X: \key{Cmd+K}) to activate \gui Locator.
940
    Then type colon (\key{:}) followed by \key{Space} and the class name.
941 942 943 944 945 946 947 948 949 950


    Below is a full list of \l{http://doc.trolltech.com/qdatastream.html}
    {QDataStream} related output:

    \image qtcreator-navigate-popup.png


    Filters can be added to provide quick navigation around files in a
    subdirectory structure defined by you. This way, you can acccess files you
951
    need, that are not directly mentioned in your project. Click on
952 953 954 955 956
    \image qtcreator-locator-magnify.png
     and choose \gui{Configure...} from the menu displayed.

    \image qtcreator-locator-customize.png

957 958
    This displays the \gui Preferences dialog (\gui Options on Mac Os X) for
    navigation filters. Click \gui Add to create a new filter. In the
959 960 961 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 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
    \gui{Filter Configuration} dialog below, give your filter a name, select
    your preferred directories, set file patterns with a comma separated list,
    and specify a prefix string.

    \image qtcreator-navigate-customfilter.png

    After closing this dialog, \gui Locator will search the directories you
    selected for files matching your file patterns, and the information will be
    cached. Click \gui Refresh from the menu above to update the cached
    information.

    The following table lists the filters currently available:

    \table
        \header
            \o  Function
            \o  Key Combination
            \o  Screenshot
        \row
            \o  Go to a line in the current document
            \o  Ctrl+K, l, Space, and the line number
            \o  \image qtcreator-locator-line.png
        \row
            \o  Go to a symbol definition
            \o  Ctrl+K, :, Space, and the function name
            \o  \image qtcreator-locator-symbols.png
        \row
            \o  Go to a help topic
            \o  Ctrl+K, ?, Space, and the topic
            \o  \image qtcreator-locator-help.png
        \row
            \o  Go to an opened document
            \o  Ctrl+K, o, Space, and the document name.
            \o  \image qtcreator-locator-opendocs.png
        \row
            \o  Go to a file in the file system (browse the file system)
            \o  Ctrl+K, f, Space, and the file name.
            \o  \image qtcreator-locator-filesystem.png
        \row
            \o  Go to a file in any project currently loaded
            \o  Ctrl+K, a, Space, and the function name.
            \o  \image qtcreator-locator-files.png
        \row
            \o  Go to a file in the current project
            \o  Ctrl+K, p, Space, and the function name.
            \o  \image qtcreator-locator-current-project.png
        \row
            \o  Go to a class definition
            \o  Ctrl+K, c, Space, and the class name.
            \o  \image qtcreator-locator-classes.png
        \row
            \o  Go to a method definition
            \o  Ctrl+K, m, Space, and the class name.
            \o  \image qtcreator-locator-methods.png
    \endtable

    \note By default, if you press \key{Ctrl+K} and do not use a prefix to
    specify a filter, three filters will be enabled: \c{o}, \c{l}, and \c{a}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1017

1018
    \note On Mac OS X, use \key{Cmd+K} instead of \key{Ctrl+K}.
1019 1020 1021 1022

*/


1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
/*!
    \contentspage index.html
    \previouspage creator-navigation.html
    \page creator-session.html
    \nextpage creator-debugging.html

    \title Session Management in Qt Creator

    In Qt Creator, a session is a collection of:

    \list
        \o open projects together with their dependencies,
        \o open editors,
        \o breakpoints and watches, as well as
        \o bookmarks
    \endlist

    When you run Qt Creator, you have a default session. You can create a new
    session using the \gui{Session Manager...} option, available in the
    \gui{File -> Session} menu.


    \image qtcreator-session-manager.png


    To switch between sessions, select \gui{File -> Session}. If you do not
    create and select any session, Qt Creator will always use the default
    session.

    \image qtcreator-session-menu.png
1053 1054 1055 1056 1057 1058

    When you launch Qt Creator, a list of your recent sessions will be
    displayed on the \gui{Welcome Screen}.

    \image qtcreator-welcome-session.png

1059 1060 1061
*/


con's avatar
con committed
1062 1063 1064 1065
/*!
    \contentspage index.html
    \previouspage creator-navigation.html
    \page creator-debugging.html
1066
    \nextpage creator-cmake-support.html
con's avatar
con committed
1067

Kavindra Palaraja's avatar
Kavindra Palaraja committed
1068
    \title Debugging with Qt Creator
1069 1070


Friedemann Kleint's avatar
Friedemann Kleint committed
1071 1072 1073 1074
    \section1 Introduction

    Qt Creator does not have its own debugger. Instead, it provides a graphical
    frontend to various debugger engines:
con's avatar
con committed
1075 1076

    \table
Friedemann Kleint's avatar
Friedemann Kleint committed
1077 1078 1079 1080
        \header
            \o Platform
            \o Compiler
            \o Debugger Engine
1081
        \row
1082 1083 1084
            \o Linux, Unixes, Mac OS
            \o gcc
            \o GNU Symbolic Debugger (gdb)
Friedemann Kleint's avatar
Friedemann Kleint committed
1085
        \row
1086 1087 1088
            \o Windows/MinGW
            \o gcc
            \o GNU Symbolic Debugger (gdb)
Friedemann Kleint's avatar
Friedemann Kleint committed
1089
        \row
1090 1091 1092
            \o Windows
            \o Microsoft Visual C++ Compiler
            \o Debugging Tools for Windows/Microsoft Console Debugger (CDB)
con's avatar
con committed
1093 1094
    \endtable

Friedemann Kleint's avatar
Friedemann Kleint committed
1095
    The frontend allows you to
con's avatar
con committed
1096 1097 1098 1099
    step through a program line-by-line or instruction-by-instruction,
    interrupt running programs, set breakpoints, examine the contents of the
    call stack, local and global variables, etc.

Friedemann Kleint's avatar
Friedemann Kleint committed
1100 1101
    Within Qt Creator, the raw information provided by the engine is displayed
    in a clear and concise manner, simplifying the process of debugging.
con's avatar
con committed
1102 1103 1104 1105 1106

    In addition to generic IDE functionality: stack view, views for locals and
    watchers, registers, etc, Qt Creator comes with additional features to make
    debugging Qt-based applications easy. The debugger frontend knows about the
    internal layout of several Qt classes such as QString, the QTL containers,
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
1107
    and most importantly QObject (and classes derived from it), as well as
hjk's avatar
hjk committed
1108 1109
    most containers of the C++ Standard Library, and is therefore able to
    present their contents in a useful way.
con's avatar
con committed
1110 1111


1112 1113 1114 1115 1116 1117
    \section1 Debugger Engine Installation Notes

    \table
        \header
            \o Debugger Engine
            \o Notes
1118 1119 1120
        \row
            \o Gdb
            \o Requires gdb version 6.8.
1121 1122 1123
        \row
            \o Debugging Tools for Windows
            \o Using this engine requires you to install the
1124 1125 1126 1127
               \e{Debugging Tools for Windows}
               \l{http://www.microsoft.com/whdc/devtools/debugging/installx86.Mspx}{32-bit}
               or
               \l{http://www.microsoft.com/whdc/devtools/debugging/install64bit.Mspx}{64-bit}
1128
               package (Version 6.11.1.404 for the 32-bit or the 64-bit version of Qt Creator, respectively),
1129 1130
               which is freely available for download from the
               \l{http://msdn.microsoft.com/en-us/default.aspx}
1131 1132 1133
               {Microsoft Developer Network}.

               The pre-built \e{Qt SDK for Windows} will make use
1134 1135 1136 1137 1138 1139 1140
               of the library if it is present on the system. When building Qt
               Creator using the Microsoft Visual C++ Compiler, the
               \c{"%ProgramFiles%\Debugging Tools for Windows"} path will be
               checked to ensure that all required header files are there.
    \endtable


con's avatar
con committed
1141 1142 1143 1144 1145 1146 1147
    \section1 Interacting with the Debugger

    In \gui Debug mode, several dock widgets are used to interact with the
    program you are debugging. The frequently used dock widgets are visible by
    default; the rarely used ones are hidden. To change the default settings,
    select \gui Debug and then select \gui View.

1148
    \image qtcreator-debug-view.png
con's avatar
con committed
1149 1150 1151

    Here, you can lock or unlock the location of your views as well as display
    or hide them. Among the views you can display are \gui Breakpoints,
1152
    \gui Disassembler, \gui Modules, \gui Registers, \gui Debugger, \gui Stack, and
con's avatar
con committed
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
    \gui Thread. The position of your dock widgets will be saved for future
    sessions.


    \section2 Breakpoints

    Breakpoints are shown in the \gui{Breakpoints} view which is enabled by
    by default. This view is also accessible when the debugger and the program
    being debugged is not running.

    A breakpoint represents a position or sets of positions in the code that,
1164 1165 1166
    when executed, interrupts the program being debugged and passing the
    control to the user. The user is then free to examine the state of the
    interrupted program, or continue execution line-by-line or continuously.
con's avatar
con committed
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177

    Typically, breakpoints are associated with a source code file and line, or
    the start of a function -- both allowed in Qt Creator.

    Also, the interruption of a program by a breakpoint can be restricted with
    certain conditions.

    You can set a breakpoint: