qtcreator.qdoc 68.9 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.2.80
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 Qt task tracker at
hjk's avatar
hjk committed
15
    http://qt.nokia.com/developer/task-tracker. You can also join the
16 17 18
    qt-creator@trolltech.com mailing list. To subscribe, send a message with
    the word \e subscribe to qt-creator-request@trolltech.com. For more
    information on Qt mailing lists, visit http://lists.trolltech.com
con's avatar
con committed
19

20 21
    \image qtcreator-screenshots.png

con's avatar
con committed
22
    \table
23
    \row
24
        \o Qt Creator includes a wide range of useful features. Among them are:
con's avatar
con committed
25
    \list 1
26 27
        \o \bold{Smart Code Editor}: The code editor provides syntax
            highlighting as well as code completion.
con's avatar
con committed
28 29 30 31 32 33 34 35
        \o \bold{Qt4 Project Generating Wizard}: This wizard allows the user
           to generate a project for a console application, a GUI application,
           or a C++ library.
        \o \bold{Qt Help Integration}: Qt's entire documentation can be
           accessed easily by clicking on the \gui{Help} button.
        \o \bold{Qt Designer Integration}: User interface forms can be designed
           within Qt Creator. Simply double-click on a \c{.ui} file within the
           \gui{Project Explorer} to launch the integration.
36 37
        \o \bold{Locator}: A powerful navigation tool that lets the user locate
           files and classes using minimal keystrokes.
con's avatar
con committed
38 39
        \o \bold{Support for qmake's .pro file format}: The project's \c{.pro}
           file is used as a project description file.
40
        \o \bold{Debugging Interface}: Applications can be debugged
con's avatar
con committed
41
           within Qt Creator using a graphical frontend to the GNU symbolic
42
           debugger (GDB) and the Microsoft Console Debugger (CDB).
con's avatar
con committed
43 44 45 46 47 48
    \endlist
    \endtable

    To learn more about the Qt Creator, click on one of the links below:

    \list
49 50 51 52 53 54 55 56
       \o   \l{A Quick Tour of Qt Creator}
       \o   \l{Creating a Project in Qt Creator}
       \o   \l{The Code Editor}
       \o   \l{Build Settings}
       \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}
57
       \o   \l{Session Management in Qt Creator}
58
       \o   \l{Debugging with Qt Creator}
59 60
       \o   \l{CMake Support in Qt Creator}
       \o   \l{Support for Generic Projects in Qt Creator}
61
       \o   \l{Handling External Libraries}
62 63 64 65
       \o   \l{Tips and Tricks}
       \o   \l{Keyboard Shortcuts}
       \o   \l{Glossary}
       \o   \l{Supported Platforms}
66
       \o   \l{Known Issues}
67
       \o   \l{Acknowledgements}
con's avatar
con committed
68 69 70 71
    \endlist

*/

72

con's avatar
con committed
73 74 75
/*!
    \contentspage index.html
    \page creator-quick-tour.html
76
    \nextpage creator-code-editor.html
con's avatar
con committed
77

78
    \title A Quick Tour of Qt Creator
con's avatar
con committed
79

80 81
    The labeled screenshot below shows some of the components of Qt Creator, in
    \gui Edit mode.
con's avatar
con committed
82 83 84

    \image qtcreator-breakdown.png

Kavindra Palaraja's avatar
Kavindra Palaraja committed
85
    \section1 The Mode Selectors
con's avatar
con committed
86

87 88
    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
89

90 91
    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
92 93 94 95 96 97 98 99
    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
100 101
    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
102

103 104
    \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
105 106

    \o \gui{Debug Mode} - Provides various ways to inspect the state of the
107 108
    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
109

110
    \o \gui{Projects Mode} - Lets you configure how projects can be built and
111
    executed. Under the list of projects, there are tabs to configure the
112
    build, run, and editor settings.
con's avatar
con committed
113 114 115 116

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

117 118 119
    \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
120 121 122 123 124 125

    \endlist


    \section1 The Output Panes

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

130

131
    \section2 Build Issues
con's avatar
con committed
132

133 134 135
    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
136

137
    \image qtcreator-build-issues.png
con's avatar
con committed
138

139

con's avatar
con committed
140 141
    \section2 Search Results

142 143 144 145
    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
146 147 148

    \image qtcreator-search-pane.png

149

con's avatar
con committed
150 151
    \section2 Application Output

152 153
    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
154 155 156

    \image qtcreator-application-output.png

157

158
    \section2 Compile
con's avatar
con committed
159

160 161
    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
162
    \gui{Build Issues}
con's avatar
con committed
163 164 165

    \image qtcreator-compile-pane.png

166

con's avatar
con committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
    \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
    below.

    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.
187
    For more information on Qt Designer, you can refer to
188
    \l{http://doc.trolltech.com/designer-manual.html}{The Designer Manual}.
con's avatar
con committed
189 190 191 192 193

    \image qtcreator-formedit.png


    \section1 Keyboard Navigation
194

195 196 197 198 199
    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
200 201
*/

202 203 204 205 206 207 208
/*! \contentspage index.html
    \previouspage creator-quick-tour.html
    \page creator-code-editor.html
    \nextpage creator-build-settings.html

    \title The Code Editor

209 210 211 212 213
    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.
214

215 216 217
    \table
        \row
            \i  \inlineimage qtcreator-texteditor-fonts.png
218 219 220
            \i  \inlineimage qtcreator-texteditor-behavior.png
        \row
            \i  \inlineimage qtcreator-texteditor-display.png
221 222 223 224
            \i  \inlineimage qtcreator-texteditor-completion.png
    \endtable

    The table below lists keyboard shortcuts supported by the code editor.
225 226 227 228

    \table
        \row
            \i  Block navigation
dt's avatar
dt committed
229 230
            \i  To navigate between blocks, e.g., from one \bold{\{} to another
                \bold{\}} , use \key{Ctrl+[} and \key{Ctrl+]}.
231 232 233 234
        \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.
235
                To deselect, use \key{Ctrl+Shift+U}.
236 237
        \row
            \i  Moving lines up and down
238
            \i  Use \key{Ctrl+Shift+Up} and \key{Ctrl+Shift+Down}
239 240 241

        \row
            \i  Completion
242
            \i  Use \key{Ctrl+Space}
243 244

        \row
245
            \i  Indenting Blocks
246
            \i  Use \key{Ctrl+I}
247 248 249 250 251

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

252
        \row
253 254
            \i  Commenting or uncommenting blocks
            \i  Use \key{Ctrl+\/}
255

256 257 258 259
        \row
            \i  Delete a line
            \i  Use \key{Shift+Del}

260
        \row
261
            \i  Switch between header file and source file
262 263 264
            \i  Use \key{F4}.

        \row
265
            \i  Increasing and decreasing font size
266 267 268
            \i  Use \key{Ctrl+Scroll Wheel}

        \row
269
            \i  Follow symbols under the cursor
270 271 272
            \i  Use \key{F2} and \key{Shift+F2}. This feature works with
                namespaces, classes, methods, variables, include statements,
                and macros.
273

274 275 276 277 278
        \row
            \i  Switch to an external editor
            \i  Select \gui{Open in external editor} from the
                \gui{Edit -> Advanced} menu.
    \endtable
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 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    \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
337 338 339
*/


con's avatar
con committed
340 341
/*!
    \contentspage index.html
342
    \previouspage creator-code-editor.html
con's avatar
con committed
343
    \page creator-build-settings.html
344
    \nextpage creator-version-management.html
con's avatar
con committed
345 346 347 348 349

    \title Build Settings

    \table
        \row
350 351 352
            \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
353 354
    \endtable

355 356
    To modify the build settings of your project, switch to the \gui{Projects}
    mode using the mouse or with \key{Ctrl+4}.
con's avatar
con committed
357

con's avatar
con committed
358
    \image qtcreator-buildsettingstab.png
con's avatar
con committed
359 360

    Action items to create, clone, or delete build configurations can be found
con's avatar
con committed
361
    at the bottom of the dialog. You can have as many build configurations as
362 363
    needed. By default Qt Creator creates a \bold{debug} and \bold{release}
    build configuration. Both these configurations use the
con's avatar
con committed
364 365 366
    \l{glossary-default-qt}{Default Qt Version}.

    In the tree on the left, a list of build configurations and their settings
con's avatar
con committed
367
    are displayed. The screenshot above shows the \bold{debug} and
con's avatar
con committed
368 369 370 371 372 373
    \bold{release} configurations and their corresponding settings:
    \bold{Build Environment} and \bold{Build Steps}.

    When you select a build configuration in the tree, a configuration page for
    general build settings will be displayed. Here you can specify which
    \l{glossary-project-qt}{Qt version} to use to build your project, whether
374
    to \l{glossary-shadow-build}{shadow build} the project, for instance.
con's avatar
con committed
375 376 377 378 379 380

    \image qtcreator-buildenvironment.png

    In the \bold{Build Environment} page you can specify the environment used
    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
381
    Qt version, Qt Creator will automatically set the necessary environment
con's avatar
con committed
382 383 384 385 386 387 388 389 390
    variables.

    \image qtcreator-buildsteps.png

    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 in the
    \bold{Build Settings} page. Qt Creator will run the make command using the
    correct Qt version.

391 392 393 394 395 396 397 398
    \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
    projects. To do this, go the the \bold{Dependencies} tab after selecting
    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.

399 400
*/

401

402 403 404 405 406
/*!
    \contentspage index.html
    \previouspage creator-build-settings.html
    \page creator-version-management.html
    \nextpage creator-creating-project.html
con's avatar
con committed
407

408
    \title Qt Version Management
con's avatar
con committed
409 410 411 412 413 414

    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
415
    \bold{Auto-detected Qt}. If you intend to use only one version of Qt - it is
con's avatar
con committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
    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
    \gui{Tools -> Options... -> Qt Versions}. If you are on the Windows
    platform and use MinGW to compile Qt, you need to tell Qt Creator where
    MinGW is installed. This is done by setting the \gui{MinGW Directory}
    under \gui{Tools -> Options... -> Qt4 -> Qt Versions -> MinGw Directory}.
    If your Qt version is compiled with Microsoft Visual C++'s compiler, Qt
    Creator will automatically set the correct environment variables for
    compilation.

    \note By default projects are compiled with the
    \l{glossary-default-qt}{default Qt version}. You can override this in the
    \gui{Build Configuration}.
*/

433

con's avatar
con committed
434 435
/*!
    \contentspage index.html
436
    \previouspage creator-version-management.html
con's avatar
con committed
437 438 439 440 441 442 443
    \page creator-creating-project.html
    \nextpage creator-writing-program.html

    \title Creating a Project in Qt Creator

    \table
        \row
444
            \i \inlineimage qtcreator-new-project.png
con's avatar
con committed
445 446
            \i \bold{Creating a New Project}

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

450 451 452 453 454
        \list
            \o Qt4 Console Application
            \o Qt4 Gui Application
            \o C++ Library
        \endlist
con's avatar
con committed
455

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

        \row
459
            \i \inlineimage qtcreator-intro-and-location.png
460
            \i \bold{Setting the Project name and location}
con's avatar
con committed
461 462 463 464 465 466 467

        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
468
            \i \inlineimage qtcreator-select-modules.png
con's avatar
con committed
469 470 471 472 473 474 475 476 477
            \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
478
            \i \inlineimage qtcreator-class-info.png
con's avatar
con committed
479 480
            \i \bold{Specifying Class Information}

481
        Specify the name of the class you would like to create. The
con's avatar
con committed
482
        \e{Header file}, \e{Source file} and \e{Form file} fields will update
483
        automatically according to your choice of class name.
con's avatar
con committed
484 485

        You also have to select the base class for your class, either a
486 487 488
        QWidget, QDialog or QMainWindow,  from the drop down box.

        \row
489
            \i \inlineimage qtcreator-new-project-summary.png
490 491 492
            \i \bold{Creating the Project}

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

con's avatar
con committed
495
    \endtable
496

con's avatar
con committed
497 498
*/

499

con's avatar
con committed
500 501 502 503
/*!
    \contentspage index.html
    \previouspage creator-creating-project.html
    \page creator-writing-program.html
504
    \nextpage creator-version-control.html
con's avatar
con committed
505 506 507 508 509 510 511

    \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
512
           and using the Qt Resource System.
con's avatar
con committed
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
    \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

536 537
    \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
538 539 540 541 542

    \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
543 544 545
    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
546

547
    In your project you will have the following files:
con's avatar
con committed
548 549 550 551 552 553 554 555

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

con's avatar
con committed
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
    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

573
    Design the form above using a \l{http://doc.trolltech.com/qlabel.html}
hjk's avatar
hjk committed
574 575 576 577 578
    {QLabel}, \l{http://doc.trolltech.com/qlinedit.html}{QLineEdit} 
    (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
579 580 581 582 583 584 585
    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
586
    new to designing forms with \QD, you can take a look at the
con's avatar
con committed
587 588 589 590 591 592 593 594
    \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
595 596 597
    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
598

599
    \snippet examples/textfinder/textfinder.h 0
600

601
    \note The \c{Ui::TextFinder} object is already provided.
con's avatar
con committed
602 603 604 605 606 607 608

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

609
    \snippet examples/textfinder/textfinder.cpp 0
con's avatar
con committed
610

611 612 613 614
    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
615 616
    \l{http://doc.trolltech.com/qtextedit.html#plainText-prop}{setPlainText()}
    which requires adding the following additional #includes to textfinder.cpp:
617 618

    \snippet examples/textfinder/textfinder.cpp 1
con's avatar
con committed
619 620

    For the \c{on_findButton_clicked()} slot, we extract the search string and
621 622 623
    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
624

625
    \snippet examples/textfinder/textfinder.cpp 2
con's avatar
con committed
626 627 628 629

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

630
    \snippet examples/textfinder/textfinder.cpp 3
con's avatar
con committed
631 632 633 634 635

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

    \code
636
    QMetaObject::connectSlotsByName(TextFinder);
con's avatar
con committed
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
    \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}.
652 653 654 655 656 657 658 659
    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
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674

    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
675
    clicking on the
con's avatar
con committed
676 677
    \inlineimage qtcreator-run.png
    button.
678

con's avatar
con committed
679 680 681 682 683
*/

/*!
    \contentspage index.html
    \previouspage creator-writing-program.html
684
    \page creator-version-control.html
685
    \nextpage creator-navigation.html
686 687 688 689 690 691 692 693

    \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/}
694
            \i
695 696 697
        \row
            \i  \bold{Subversion}
            \i  \l{http://subversion.tigris.org/}
698
            \i
699 700 701
        \row
            \i  \bold{Perforce}
            \i  \l{http://www.perforce.com}
702
            \i  Server version 2006.1 and later
703 704 705 706 707 708 709 710
    \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
711
    specify the path to the command line client's executable in the settings
712 713 714
    pages that can be found under \gui{Options...} in the \gui{Tools} menu.


715 716
    \section1 Usage

Dean Dettman's avatar
Dean Dettman committed
717
    You can find the version control menu entries in a sub-menu of the
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
    \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
756 757
    \gui{Log} (for \bold{git}) or \gui{Filelog} (for \bold{Perforce} and
    \bold{Subversion}) option. Typically, the log output will contain the
758 759 760 761 762
    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
763
    \image qtcreator-vcs-describe.png
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


    \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
798 799 800 801 802 803 804 805 806 807 808 809
            \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
810
    \endtable
811

812 813
    \section2 Common options

814 815 816
    The \gui{Version Control/Common} settings page features common settings for
    version control systems, such as commit message line wrapping and checking
    options.
817

818 819 820 821 822 823 824 825
    \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:
826 827 828 829 830 831

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

832 833 834 835 836
    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.
837

838 839
    \gui{User field configuration file} is a simple text file consisting of
    lines specifying submit message fields that take user names, for example:
840 841 842 843 844 845

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

846 847 848 849
    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.
850

con's avatar
con committed
851 852 853
*/


854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
/*!
    \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
    \gui Locator or use \key{Ctrl+K}, type in the file name and then press
    \key Return. The file will be opened in the editor. You can also type
872 873 874
    part of a file name and use the wildcard characters \c{*} and \c{?} to
    match \e{any} number of \e{any} characters. A list of all files matching
    your criteria will be displayed.
875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908

    \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:
    \key{Ctrl+K} to activate \gui Locator. Then type colon (\key{:}) followed
    by \key{Space} and the class name.


    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
909
    need, that are not directly mentioned in your project. Click on
910 911 912 913 914
    \image qtcreator-locator-magnify.png
     and choose \gui{Configure...} from the menu displayed.

    \image qtcreator-locator-customize.png

915 916
    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
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
    \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}.

*/


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
/*!
    \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
1009 1010 1011 1012 1013 1014

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

    \image qtcreator-welcome-session.png

1015 1016 1017
*/


con's avatar
con committed
1018 1019 1020 1021
/*!
    \contentspage index.html
    \previouspage creator-navigation.html
    \page creator-debugging.html
1022
    \nextpage creator-cmake-support.html
con's avatar
con committed
1023

Kavindra Palaraja's avatar
Kavindra Palaraja committed
1024
    \title Debugging with Qt Creator
1025 1026


Friedemann Kleint's avatar
Friedemann Kleint committed
1027 1028 1029 1030
    \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
1031 1032

    \table
Friedemann Kleint's avatar
Friedemann Kleint committed
1033 1034 1035 1036
        \header
            \o Platform
            \o Compiler
            \o Debugger Engine
1037
        \row
1038 1039 1040
            \o Linux, Unixes, Mac OS
            \o gcc
            \o GNU Symbolic Debugger (gdb)
Friedemann Kleint's avatar
Friedemann Kleint committed
1041
        \row
1042 1043 1044
            \o Windows/MinGW
            \o gcc
            \o GNU Symbolic Debugger (gdb)
Friedemann Kleint's avatar
Friedemann Kleint committed
1045
        \row
1046 1047 1048
            \o Windows
            \o Microsoft Visual C++ Compiler
            \o Debugging Tools for Windows/Microsoft Console Debugger (CDB)
con's avatar
con committed
1049 1050
    \endtable

Friedemann Kleint's avatar
Friedemann Kleint committed
1051
    The frontend allows you to
con's avatar
con committed
1052 1053 1054 1055
    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
1056 1057
    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
1058 1059 1060 1061 1062 1063 1064 1065 1066

    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,
    and most importantly QObject (and classes derived from it). Therefore, it
    is able to present Qt's data clearly.


1067 1068 1069 1070 1071 1072
    \section1 Debugger Engine Installation Notes

    \table
        \header
            \o Debugger Engine
            \o Notes
1073 1074 1075
        \row
            \o Gdb
            \o Requires gdb version 6.8.
1076 1077 1078
        \row
            \o Debugging Tools for Windows
            \o Using this engine requires you to install the
1079 1080 1081 1082 1083
               \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}
               package (Version 6.10 for the 32-bit or the 64-bit version of Qt Creator, respectively),
1084 1085
               which is freely available for download from the
               \l{http://msdn.microsoft.com/en-us/default.aspx}
1086 1087 1088
               {Microsoft Developer Network}.

               The pre-built \e{Qt SDK for Windows} will make use
1089 1090 1091 1092 1093 1094 1095
               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
1096 1097 1098 1099 1100 1101 1102
    \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.

1103
    \image qtcreator-debug-view.png
con's avatar
con committed
1104 1105 1106

    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,
1107
    \gui Disassembler, \gui Modules, \gui Registers, \gui Debugger, \gui Stack, and
con's avatar
con committed
1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
    \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,
1119 1120 1121
    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
1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132

    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:

    \list
       \o At a particular line you want the program to stop -- click on the
Kavindra Palaraja's avatar
Kavindra Palaraja committed
1133
          left margin or press \key F9 (\key F8 for Mac OS X).
1134
       \o At a function that you want the program to interrupt -- enter the
Kavindra Palaraja's avatar
Kavindra Palaraja committed
1135
          function's name in \gui{Set Breakpoint at Function...} under the
con's avatar
con committed
1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
          \gui Debug menu.
    \endlist

    You can remove a breakpoint:

    \list
        \o By clicking on the breakpoint marker in the text editor.
        \o By selecting the breakpoint in the breakpoint view and pressing
           \key{Delete}.
        \o By selecting \gui{Delete Breakpoint} from the breakpoint's context
           menu in the \gui Breakpoints view.
    \endlist

    Breakpoints can be set and deleted before the program has actually started
    running or while it is running under the debugger's control. Also,
    breakpoints are saved together with a session.


    \section2 Running

    To start a program under the debugger's control, select the \gui{Debug}
    menu and \gui{Start Debugging}, or simply press \key{F5}. Qt Creator then
    checks whether the compiled program is up-to-date, rebuilding it if
    necessary. The debugger then takes over and starts the program.

1161
    \note Starting a program in the debugger can take considerable amount of
con's avatar
con committed
1162
    time, typically in the range of several seconds to minutes if complex
1163
    features (like QtWebKit) are used.
con's avatar
con committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

    Once the program starts running, it behaves as usual; performance-wise as
    well. The user can interrupt a running program by selecting
    \gui {Interrupt} from the \gui{Debug} menu. The program is automatically
    interrupted as soon as a breakpoint is hit.

    Once the program stops, Qt Creator:

    \list
        \o Retrieves data representing the call stack at the program's current
           position.
        \o Retrieves the contents of local variables.
        \o Examines \gui Watchers.
        \o Updates the \gui Registers, \gui Modules, and \gui Disassembler
           views.
    \endlist


    You can use the debugger views to examine the data in more detail.

    To finish debugging, Press \key{Shift+F5}. A line of code can be executed
    as a whole with \key F10; to execute a function or a sub-function, use
    \key F11. Alternatively, you can continue running the program with \key F5.
1187 1188 1189
    It is possible to continue executing your program until the current
    function completes or jump to an arbitrary position in the current
    function.
con's avatar
con committed
1190 1191 1192 1193


    \section2 Stack

1194 1195 1196 1197 1198 1199
    When the program being debugged is interrupted, Qt Creator displays the
    nested function calls leading to the current position as a \e call stack
    trace. This stack trace is built up from \e{call stack frames}, each
    representing a particular function. For each function, Qt Creator will try
    to retrieve the file name and line number of the corresponding source
    files. This data is shown in the \gui Stack view.
con's avatar
con committed
1200

1201 1202
    \image qtcreator-debug-stack.png

con's avatar
con committed
1203 1204 1205
    Since the call stack leading to the current position may originate or go
    through code for which no debug information is available, not all stack
    frames will have corresponding source locations. These frames will be
1206
    grayed out in the \gui Stack view.
con's avatar
con committed
1207 1208 1209

    If you click on a frame with a known source location, the text editor will
    jump to the corresponding location and update the \gui{Locals and Watchers}
1210 1211
    view, making it seem like the program was interrupted before entering the
    function.
con's avatar
con committed
1212 1213 1214 1215


    \section2 Threads

Kavindra Devi Palaraja's avatar