qtcreator.qdoc 60.2 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.0.90
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 15 16 17 18
    \note Please report bugs and suggestions to the Qt Software task tracker at
    http://www.qtsoftware.com/developer/task-tracker. You can also join the
    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 40 41 42 43 44 45 46 47 48
        \o \bold{Support for qmake's .pro file format}: The project's \c{.pro}
           file is used as a project description file.
        \o \bold{Debugging Interface to GDB}: Applications can be debugged
           within Qt Creator using a graphical frontend to the GNU symbolic
           debugger.
    \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 57
       \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}
       \o   \l{Debugging with Qt Creator}
58 59
       \o   \l{CMake Support in Qt Creator}
       \o   \l{Support for Generic Projects in Qt Creator}
60 61 62 63
       \o   \l{Tips and Tricks}
       \o   \l{Keyboard Shortcuts}
       \o   \l{Glossary}
       \o   \l{Supported Platforms}
con's avatar
con committed
64
       \o   \l{Known Issues of Version 1.0.90}
65
       \o   \l{Acknowledgements}
con's avatar
con committed
66 67 68 69
    \endlist

*/

70

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

76
    \title A Quick Tour of Qt Creator
con's avatar
con committed
77

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

    \image qtcreator-breakdown.png

Kavindra Palaraja's avatar
Kavindra Palaraja committed
83
    \section1 The Mode Selectors
con's avatar
con committed
84

85 86
    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
87

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

101 102
    \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
103 104

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

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

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

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

    \endlist


    \section1 The Output Panes

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

128

129
    \section2 Build Issues
con's avatar
con committed
130

131 132 133
    The {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
134

135
    \image qtcreator-build-issues.png
con's avatar
con committed
136

137

con's avatar
con committed
138 139
    \section2 Search Results

140 141 142 143
    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
144 145 146

    \image qtcreator-search-pane.png

147

con's avatar
con committed
148 149
    \section2 Application Output

150 151
    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
152 153 154

    \image qtcreator-application-output.png

155

156
    \section2 Compile
con's avatar
con committed
157

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

    \image qtcreator-compile-pane.png

164 165 166 167 168

    \section1 Session Management in Qt Creator

    In Qt Creator, a session is a collection of loaded projects, opened files,
    editor settings, and so on. When you run Qt Creator, you have a default
169 170
    session. You can create a new session using the \gui{Session Manager...}
    option, available in the \gui{File -> Session} menu.
171

172 173

    \image qtcreator-session-manager.png
174 175


176 177 178 179
    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.

180
    \image qtcreator-session-menu.png
181 182


con's avatar
con committed
183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    \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.
203
    For more information on Qt Designer, you can refer to
204
    \l{http://doc.trolltech.com/designer-manual.html}{The Designer Manual}.
con's avatar
con committed
205 206 207 208 209

    \image qtcreator-formedit.png


    \section1 Keyboard Navigation
210

211 212 213 214 215
    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
216 217
*/

218 219 220 221 222 223 224
/*! \contentspage index.html
    \previouspage creator-quick-tour.html
    \page creator-code-editor.html
    \nextpage creator-build-settings.html

    \title The Code Editor

225 226 227 228 229
    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.
230

231 232 233
    \table
        \row
            \i  \inlineimage qtcreator-texteditor-fonts.png
234 235 236
            \i  \inlineimage qtcreator-texteditor-behavior.png
        \row
            \i  \inlineimage qtcreator-texteditor-display.png
237 238 239 240
            \i  \inlineimage qtcreator-texteditor-completion.png
    \endtable

    The table below lists keyboard shortcuts supported by the code editor.
241 242 243 244

    \table
        \row
            \i  Block navigation
dt's avatar
dt committed
245 246
            \i  To navigate between blocks, e.g., from one \bold{\{} to another
                \bold{\}} , use \key{Ctrl+[} and \key{Ctrl+]}.
247 248 249 250
        \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.
251
                To deselect, use \key{Ctrl+Shift+U}.
252 253
        \row
            \i  Moving lines up and down
254
            \i  Use \key{Ctrl+Shift+Up} and \key{Ctrl+Shift+Down}
255 256 257

        \row
            \i  Completion
258
            \i  Use \key{Ctrl+Space}
259 260

        \row
261
            \i  Indenting Blocks
262
            \i  Use \key{Ctrl+I}
263 264 265 266 267

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

268
        \row
269 270
            \i  Commenting or uncommenting blocks
            \i  Use \key{Ctrl+\/}
271

272 273 274 275
        \row
            \i  Delete a line
            \i  Use \key{Shift+Del}

276
        \row
277
            \i  Switch between header file and source file
278 279 280
            \i  Use \key{F4}.

        \row
281
            \i  Increasing and decreasing font size
282 283 284
            \i  Use \key{Ctrl+Scroll Wheel}

        \row
285
            \i  Follow symbols under the cursor
286 287 288
            \i  Use \key{F2} and \key{Shift+F2}. This feature works with
                namespaces, classes, methods, variables, include statements,
                and macros.
289

290 291 292 293 294
        \row
            \i  Switch to an external editor
            \i  Select \gui{Open in external editor} from the
                \gui{Edit -> Advanced} menu.
    \endtable
295 296 297 298

*/


con's avatar
con committed
299 300
/*!
    \contentspage index.html
301
    \previouspage creator-code-editor.html
con's avatar
con committed
302
    \page creator-build-settings.html
303
    \nextpage creator-version-management.html
con's avatar
con committed
304 305 306 307 308

    \title Build Settings

    \table
        \row
309 310 311
            \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
312 313
    \endtable

314 315
    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
316

con's avatar
con committed
317
    \image qtcreator-buildsettingstab.png
con's avatar
con committed
318 319

    Action items to create, clone, or delete build configurations can be found
con's avatar
con committed
320
    at the bottom of the dialog. You can have as many build configurations as
321 322
    needed. By default Qt Creator creates a \bold{debug} and \bold{release}
    build configuration. Both these configurations use the
con's avatar
con committed
323 324 325
    \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
326
    are displayed. The screenshot above shows the \bold{debug} and
con's avatar
con committed
327 328 329 330 331 332
    \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
333
    to \l{glossary-shadow-build}{shadow build} the project, for instance.
con's avatar
con committed
334 335 336 337 338 339

    \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
340
    Qt version, Qt Creator will automatically set the necessary environment
con's avatar
con committed
341 342 343 344 345 346 347 348 349
    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.

350 351 352 353 354 355 356 357
    \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.

358 359
*/

360

361 362 363 364 365
/*!
    \contentspage index.html
    \previouspage creator-build-settings.html
    \page creator-version-management.html
    \nextpage creator-creating-project.html
con's avatar
con committed
366

367
    \title Qt Version Management
con's avatar
con committed
368 369 370 371 372 373

    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
374
    \bold{Auto-detected Qt}. If you intend to use only one version of Qt - it is
con's avatar
con committed
375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
    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}.
*/

392

con's avatar
con committed
393 394
/*!
    \contentspage index.html
395
    \previouspage creator-version-management.html
con's avatar
con committed
396 397 398 399 400 401 402
    \page creator-creating-project.html
    \nextpage creator-writing-program.html

    \title Creating a Project in Qt Creator

    \table
        \row
403
            \i \inlineimage qtcreator-new-project.png
con's avatar
con committed
404 405
            \i \bold{Creating a New Project}

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

409 410 411 412 413
        \list
            \o Qt4 Console Application
            \o Qt4 Gui Application
            \o C++ Library
        \endlist
con's avatar
con committed
414

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

        \row
418
            \i \inlineimage qtcreator-intro-and-location.png
419
            \i \bold{Setting the Project name and location}
con's avatar
con committed
420 421 422 423 424 425 426

        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
427
            \i \inlineimage qtcreator-select-modules.png
con's avatar
con committed
428 429 430 431 432 433 434 435 436
            \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
437
            \i \inlineimage qtcreator-class-info.png
con's avatar
con committed
438 439
            \i \bold{Specifying Class Information}

440
        Specify the name of the class you would like to create. The
con's avatar
con committed
441
        \e{Header file}, \e{Source file} and \e{Form file} fields will update
442
        automatically according to your choice of class name.
con's avatar
con committed
443 444

        You also have to select the base class for your class, either a
445 446 447
        QWidget, QDialog or QMainWindow,  from the drop down box.

        \row
448
            \i \inlineimage qtcreator-new-project-summary.png
449 450 451
            \i \bold{Creating the Project}

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

con's avatar
con committed
454
    \endtable
455

con's avatar
con committed
456 457
*/

458

con's avatar
con committed
459 460 461 462
/*!
    \contentspage index.html
    \previouspage creator-creating-project.html
    \page creator-writing-program.html
463
    \nextpage creator-version-control.html
con's avatar
con committed
464 465 466 467 468 469 470

    \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
471
           and using the Qt Resource System.
con's avatar
con committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
    \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

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

    \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
502 503 504
    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
505

506
    In your project you will have the following files:
con's avatar
con committed
507 508 509 510 511 512 513 514

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

con's avatar
con committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
    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

532
    Design the form above using a \l{http://doc.trolltech.com/qlabel.html}
hjk's avatar
hjk committed
533 534 535 536 537
    {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
538 539 540 541 542 543 544
    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
545
    new to designing forms with \QD, you can take a look at the
con's avatar
con committed
546 547 548 549 550 551 552 553
    \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
554 555 556
    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
557

558
    \snippet examples/textfinder/textfinder.h 0
559

560
    \note The \c{Ui::TextFinder} object is already provided.
con's avatar
con committed
561 562 563 564 565 566 567

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

568
    \snippet examples/textfinder/textfinder.cpp 0
con's avatar
con committed
569

570 571 572 573
    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
574 575
    \l{http://doc.trolltech.com/qtextedit.html#plainText-prop}{setPlainText()}
    which requires adding the following additional #includes to textfinder.cpp:
576 577

    \snippet examples/textfinder/textfinder.cpp 1
con's avatar
con committed
578 579

    For the \c{on_findButton_clicked()} slot, we extract the search string and
580 581 582
    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
583

584
    \snippet examples/textfinder/textfinder.cpp 2
con's avatar
con committed
585 586 587 588

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

589
    \snippet examples/textfinder/textfinder.cpp 3
con's avatar
con committed
590 591 592 593 594

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

    \code
595
    QMetaObject::connectSlotsByName(TextFinder);
con's avatar
con committed
596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
    \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}.
611 612 613 614 615 616 617 618
    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
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633

    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
634
    clicking on the
con's avatar
con committed
635 636
    \inlineimage qtcreator-run.png
    button.
637

con's avatar
con committed
638 639
*/

640

con's avatar
con committed
641 642 643
/*!
    \contentspage index.html
    \previouspage creator-writing-program.html
644
    \page creator-version-control.html
645
    \nextpage creator-navigation.html
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667

    \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/}
        \row
            \i  \bold{Subversion}
            \i  \l{http://subversion.tigris.org/}
        \row
            \i  \bold{Perforce}
            \i  \l{http://www.perforce.com}
    \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
668
    specify the path to the command line client's executable in the settings
669 670 671
    pages that can be found under \gui{Options...} in the \gui{Tools} menu.


672 673
    \section1 Usage

Dean Dettman's avatar
Dean Dettman committed
674
    You can find the version control menu entries in a sub-menu of the
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712
    \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
713 714
    \gui{Log} (for \bold{git}) or \gui{Filelog} (for \bold{Perforce} and
    \bold{Subversion}) option. Typically, the log output will contain the
715 716 717 718 719
    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
720
    \image qtcreator-vcs-describe.png
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


    \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
755 756 757 758 759 760 761 762 763 764 765 766
            \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
767
    \endtable
768

769 770
    \section2 Common options

771 772 773
    The \gui{Version Control/Common} settings page features common settings for
    version control systems, such as commit message line wrapping and checking
    options.
774

775 776 777 778 779 780 781 782
    \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:
783 784 785 786 787 788

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

789 790 791 792 793
    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.
794

795 796
    \gui{User field configuration file} is a simple text file consisting of
    lines specifying submit message fields that take user names, for example:
797 798 799 800 801 802

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

803 804 805 806
    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.
807

con's avatar
con committed
808 809 810
*/


811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828
/*!
    \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
829 830 831
    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.
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

    \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
866
    need, that are not directly mentioned in your project. Click on
867 868 869 870 871
    \image qtcreator-locator-magnify.png
     and choose \gui{Configure...} from the menu displayed.

    \image qtcreator-locator-customize.png

872 873
    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
874 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 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935
    \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}.

*/


con's avatar
con committed
936 937 938 939
/*!
    \contentspage index.html
    \previouspage creator-navigation.html
    \page creator-debugging.html
940
    \nextpage creator-cmake-support.html
con's avatar
con committed
941

Kavindra Palaraja's avatar
Kavindra Palaraja committed
942
    \title Debugging with Qt Creator
con's avatar
con committed
943 944

    \table
945
        \row
con's avatar
con committed
946 947
            \i \note Qt Creator's debugger integration currently does not
               support debugging applications created with the Microsoft Visual
948
               C++ Compiler.
con's avatar
con committed
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
    \endtable

    Qt Creator does not have its own debugger. Instead, it provides a graphical
    frontend to the GNU Symbolic Debugger (gdb). This frontend allows you to
    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.

    Within Qt Creator, the raw information provided by gdb is displayed in a
    clear and concise manner, simplifying the process of debugging.

    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.


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

975
    \image qtcreator-debug-view.png
con's avatar
con committed
976 977 978 979 980 981 982 983 984 985 986 987 988 989 990

    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,
    \gui Disassembler, \gui Modules, \gui Registers, \gui Gdb, \gui Stack, and
    \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,
991 992 993
    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
994 995 996 997 998 999 1000 1001 1002 1003 1004

    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
1005
          left margin or press \key F9 (\key F8 for Mac OS X).
1006
       \o At a function that you want the program to interrupt -- enter the
Kavindra Palaraja's avatar
Kavindra Palaraja committed
1007
          function's name in \gui{Set Breakpoint at Function...} under the
con's avatar
con committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
          \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.

1033
    \note Starting a program in the debugger can take considerable amount of
con's avatar
con committed
1034
    time, typically in the range of several seconds to minutes if complex
1035
    features (like QtWebKit) are used.
con's avatar
con committed
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058

    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.
1059 1060 1061
    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
1062 1063 1064 1065


    \section2 Stack

1066 1067 1068 1069 1070 1071
    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
1072

1073 1074
    \image qtcreator-debug-stack.png

con's avatar
con committed
1075 1076 1077
    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
1078
    grayed out in the \gui Stack view.
con's avatar
con committed
1079 1080 1081

    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}
1082 1083
    view, making it seem like the program was interrupted before entering the
    function.
con's avatar
con committed
1084 1085 1086 1087


    \section2 Threads

1088
    If a multi-threaded program is interrupted, the \gui Thread view  or the
Kavindra Palaraja's avatar
Kavindra Palaraja committed
1089 1090 1091
    combobox named \gui Thread in the debugger's status bar can be used to
    switch from one thread to another. The \gui Stack view will adjust itself
    accordingly.
con's avatar
con committed
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108


    \section2 Locals and Watchers

    Whenever a program stops under the control of the debugger, it retrieves
    information about the topmost stack frame and displays it in the
    \gui{Locals and Watchers} view. This typically includes information about
    parameters of the function in that frame as well as the local variables.

    Compound variables of struct or class type will be displayed as
    "expandable" in the view. C lick on the "+" to expand the entry and show
    all members. Together with the display of value and type, the user can
    examine and traverse the low-level layout of an object's data.


    \table
        \row
1109
            \i  \bold{Note:}
1110 1111 1112 1113 1114 1115 1116 1117 1118

            \i  Gdb, and therefore Qt Creator's debugger works for optimized
                builds on Linux and Mac OS X. However, optimization may lead
                to re-ordering of instructions or sometimes even complete
                removal of some local variables. In this case, the
                \gui{Locals and Watchers} view may show unexpected data.

            \i  The debug information provided by gcc does not include enough
                information about the time when a variable is initialized.
1119
                Therefore, Qt Creator can not tell whether the contents of a
1120 1121 1122 1123
                local variable contains "real data", or "initial noise". If a
                QObject appears uninitialized, its value will be reported as
                "out of scope". However, not all uninitialized objects can be
                recognized as such.
con's avatar
con committed
1124 1125
    \endtable

1126 1127 1128 1129 1130 1131 1132 1133 1134

    The \gui{Locals and Watchers} view also provides access to the most
    powerful feature of the debugger: comprehensive display of data belonging
    to Qt's basic objects. To enable this feature, select \gui{Use Custom
    Display for Qt Objects} from the \gui Debug menu.The
    \gui{Locals and Watchers} view will be re-organized to provide a high-level
    view of the objects. For example, in case of QObject, instead of displaying
    a pointer to some private data structure, you will see a list of children,
    signals and slots.
con's avatar
con committed
1135

1136 1137 1138 1139 1140 1141 1142
    Similarly, instead of displaying many pointers and integers, Qt Creator's
    debugger will display the contents of a QHash or QMap in an orderly manner.
    Also, the debugger will display access data for QFileInfo and provide
    access to the "real" contents of QVariant.

    The \gui{Locals and Watchers} view can be used to change the contents of
    variables of simple data types such as \c int or \c float when the program
1143
    is interrupted. To do so, click on the \gui Value column, modify the value
1144
    with the inplace editor, and hit \key Enter (or \key Return).
1145

1146 1147
    \note The set of watched items is saved within your session.

con's avatar
con committed
1148 1149 1150

    \section2 Modules

1151
    By default, the \gui Modules view is hidden as it is only useful with the
1152
    experimental delayed loaing of debug information feature. You can turn
1153
    this feature on by selecting \gui{Fast Debugger Start}
1154

1155

1156 1157 1158 1159
    With this feature, debug information from the Qt library itself is not
    loaded when the application starts up, thereby reducing the startup times
    for some applications. You can then use the \gui Modules view to manually
    load this information, if required.
1160

1161 1162
    \note In this scenario, some breakpoints may not be triggered by the
    debugger.
1163

1164

con's avatar
con committed
1165 1166
    \section2 Disassembler View and Registers View

1167 1168 1169 1170 1171
    By default, both the \gui Disassembler and \gui Registers view are hidden.
    The \gui Disassembler view displays disassembled code for the current
    function; the \gui Registers view displays the current state of the CPU's
    registers. Both views are useful for low-level commands such as
    \gui{Step Single Instruction} and \gui{Step Over Single Instruction}.
con's avatar
con committed
1172

1173 1174
    \section1 Debugging Helper Library

1175 1176 1177 1178 1179 1180 1181
    While debugging Qt Creator dynamically loads a helper library into your
    program. This helper library enables Qt Creator to pretty print Qt and STL
    types. The Qt SDK package already contains a prebuilt debugging helper
    library. To create a debugging helper library, select the \gui{Options}
    from the \gui{Tools} menu, and go to the \gui{Qt/Qt Versions} pane. As the
    internal layout of qt can change between versions, the debugging helper
    library is built for each Qt version.
1182 1183


1184
    \section1 A Walkthrough for the Debugger Frontend
con's avatar
con committed
1185

1186 1187 1188 1189 1190
    In our \l{Writing a Simple Program with Qt Creator}{TextFinder} example, we
    read a text file into a QString and then display it with a QTextEdit.
    Suppose, you would like to look at this QString, \c{line}, and see what
    data it actually stores. Follow the steps described below to place a
    breakpoint and view the QString object's data.
con's avatar
con committed
1191 1192 1193

    \table
        \row
1194
            \i \inlineimage qtcreator-setting-breakpoint1.png
con's avatar
con committed
1195 1196 1197
            \i \bold{Setting a Breakpoint}

    First, we set a breakpoint on the line where we invoke
1198 1199 1200
    \l{http://doc.trolltech.com/qtextedit.html#plainText-prop}{setPlainText()}
    by clicking between the line number and the window border. Then, select
    \gui{Start Debugging} from the \gui{Debug} menu or press \key{F5}.
con's avatar
con committed
1201 1202 1203
    \endtable

    Breakpoints are visible in the \gui{Breakpoints} view, shown below, in
1204 1205
    \gui{Debug} mode. If you wish to remove a breakpoint, simply right-click on
    it and select \gui{Delete breakpoint} from the context menu.
con's avatar
con committed
1206 1207 1208 1209 1210 1211 1212 1213

    \image qtcreator-setting-breakpoint2.png

    To view the contents of \c{line}, take a look at the \gui{Locals and
    Watchers} view.

    \image qtcreator-watcher.png

1214 1215 1216 1217
    Suppose we modify our \c{on_findButton_clicked()} function to move back to
    the start of the document and continue searching once the cursor hits the
    end of the document. Adding this functionality can be done with the code
    snippet below:
con's avatar
con committed
1218 1219 1220 1221

    \code
    void TextFinder::on_findButton_clicked()
    {
1222
        QString searchString = ui->lineEdit->text();
con's avatar
con committed
1223

1224 1225
        QTextDocument *document = ui->textEdit->document();
        QTextCursor cursor = ui->textEdit->textCursor();
con's avatar
con committed
1226 1227
        cursor = document->find(searchString, cursor,
            QTextDocument::FindWholeWords);
1228
        ui->textEdit->setTextCursor(cursor);
con's avatar
con committed
1229 1230 1231

        bool found = cursor.isNull();

1232
        if (!found && previouslyFound) {
con's avatar
con committed
1233 1234 1235 1236 1237 1238 1239 1240
            int ret = QMessageBox::question(this, tr("End of Document"),
            tr("I have reached the end of the document. Would you like "
            "me to start searching from the beginning of the document?"),
            QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes);

            if (ret == QMessageBox::Yes) {
                cursor = document->find(searchString,
                    QTextDocument::FindWholeWords);
1241
                ui->textEdit->setTextCursor(cursor);
con's avatar
con committed
1242 1243 1244 1245 1246 1247 1248
            } else
                return;
        }
        previouslyFound = found;
    }
    \endcode

1249 1250 1251
    However, if you compile and run this code, the application will not work
    correctly due to a logic error. To locate this logic error, you can step
    through the code using the following buttons:
con's avatar
con committed
1252 1253 1254 1255 1256

    \image qtcreator-debugging-buttons.png
*/


1257 1258 1259 1260
/*!

    \contentspage index.html
    \previouspage creator-debugging.html
1261
    \page creator-cmake-support.html
1262 1263
    \nextpage creator-tips.html

1264 1265 1266
    \title CMake Support in Qt Creator

    Since Qt Creator 1.1, support for \c CMake project files is available.
1267 1268 1269

    \section1 Opening CMake Projects

1270 1271 1272 1273 1274
    To open a \c CMake project select \gui Open from the \gui File menu and
    select the \c{CMakeLists.txt} file from your \c CMake project. A wizard
    will guide you with the rest of the process. If the \c CMake project does
    not have an in-place build, Qt Creator lets you specify the directory in
    which the project is built (shadow build).
1275

1276 1277
    \image qtcreator-cmake-import-wizard1.png

1278
    The screenshot below shows how you can specify command line arguments to
1279
    \c CMake for your project.
1280

1281
    \image qtcreator-cmake-import-wizard2.png
1282

1283
    Normally, there is no need to pass any command line arguments for projects
1284
    that are already built, as \c CMake caches that information.