Skip to content
Snippets Groups Projects
qtcreator.qdoc 138 KiB
Newer Older
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

con's avatar
con committed
/*!
    \contentspage{index.html}{Qt Creator}
    \page index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \nextpage creator-overview.html
con's avatar
con committed

    \title Qt Creator Manual

con's avatar
con committed
    \section1 Version 1.3.82
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    Qt Creator provides a cross-platform, complete integrated development
    environment (IDE) for developing Qt projects. It is available for Linux,
    Mac OS X and Windows operating systems. You can use Qt Creator to develop
    applications for desktop and Symbian platforms. For more information, see
    \l{Operating systems and supported platforms}.
con's avatar
con committed

    \note Please report bugs and suggestions to the
con's avatar
con committed
    \l{http://bugreports.qt.nokia.com}{Qt Bug Tracker}.
    You can also join the Qt Creator mailing list. To subscribe,
    send a message with the word \e subscribe to
    \l{mailto:qt-creator-request@trolltech.com}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    {qt-creator-request@trolltech.com}. For more information about Qt mailing
    lists, visit \l{http://lists.trolltech.com}{http://lists.trolltech.com}.
con's avatar
con committed

    \raw HTML
    <img border="0" style="float:right;" src="images/qtcreator-screenshots.png" />
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \endraw
con's avatar
con committed
    \list
       \o \l{Introducing Qt Creator}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
       \o \l{Operating Systems and Supported Platforms}
       \o \l{Quick Tour}
       \o \l{Writing a Simple Program}
       \o \l{Using the Editor}
            \list
                \o \l{Finding and Replacing}
                \o \l{Refactoring}
                \o \l{Searching With the Locator}
            \endlist
       \o \l{Managing Projects}
            \list
                \o \l{Creating a Project}
                \o \l{Setting Up a qmake Project}
                \o \l{Setting Up a CMake Project}
                \o \l{Setting Up a Generic Project}
                \o \l{Managing Sessions}
            \endlist
       \o \l{Developing Applications}
            \list
                \o \l{Developing Maemo Applications}
                \o \l{Developing Symbian Applications}
            \endlist
       \o \l{Debugging}
       \o \l{Using Version Control Systems}
       \o \l{Tips and Tricks}
       \o \l{Keyboard Shortcuts}
       \o \l{Known Issues}
       \o \l{Glossary}
       \o \l{Acknowledgements}
con's avatar
con committed
    \endlist
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

con's avatar
con committed
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \previouspage index.html
    \page creator-overview.html
    \nextpage creator-os-supported-platforms.html

  \title Introducing Qt Creator

  As an IDE, Qt Creator differs from a text editor in that it knows how to build and run
  applications. It understands the code as code, not just as plain text. This allows
  it to:
  \list
      \o Enable you to write well formatted code.
      \o Anticipate what you are going to write and complete the code.
      \o Display inline error and warning messages.
      \o Enable you to semantically navigate to classes, functions, and symbols.
      \o Provide you with context-sensitive help on classes, functions, and symbols.
      \o Rename symbols in an intelligent way, so that other symbols with the same name
         that belong to other scopes are not renamed.
      \o Show you the locations in code where a function is declared or called.
   \endlist

      \section1 Why Do You Need Projects?

      To be able to build and run applications, Qt Creator needs the same
      information as a compiler would need. This information is specified in the
      project build and run settings.

      Creating a project allows you to:
      \list
      \o Group files together.
      \o Add custom build steps.
      \o Include forms and resource files.
      \o Specify settings for running applications.
      \endlist

      You can either create a project from scratch or import an existing
      project. Qt Creator generates all the necessary files, depending on the type of
      project you create. For example, if you choose to create a graphical user
      interface (GUI) application, Qt Creator generates an empty .ui file for you
      that you can modify with the integrated Qt Designer.
*/

/*!
    \contentspage index.html
    \previouspage creator-overview.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \page creator-os-supported-platforms.html
    \nextpage creator-quick-tour.html

    \title Operating Systems and Supported Platforms

    \section1 Operating Systems

    Qt Creator is available in binary packages for the following operating
    systems:
    \list
        \o Windows XP Service Pack 2
        \o Windows Vista
        \o (K)Ubuntu Linux 7.04 32-bit and 64-bit with the following:
           \list
               \o g++
               \o make
               \o libglib2.0-dev
               \o libSM-dev
               \o libxrender-dev
               \o libfontconfig1-dev
               \o libxext-dev
               \o libfreetype6-dev
               \o libx11-dev
               \o libxcursor-dev
               \o libxfixes-dev
               \o libxft-dev
               \o libxi-dev
               \o libxrandr-dev
               \o If you are using QtOpenGL, libgl-dev and libglu-dev
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           \endlist
        \o Mac OS 10.4 or later with the following:
           \list
               \o Xcode tools for your Mac OS X version available from your Mac
                  OS X installation DVDs or at \l http://developer.apple.com.
           \endlist
    \endlist

    \section1 Building Qt Creator

    To build Qt Creator itself from the source, you need:
    \list
        \o Qt 4.6.0 or later
        \o On Windows, MinGW 4.4 or Microsoft Visual Studio 2008
    \endlist

    \section1 Supported Platforms

    \table
        \header
            \o {1,2} Operating system
            \o {2,1} Platform
        \header
            \o Desktop
            \o Symbian
        \row
            \o Windows
            \o Yes
            \o Yes
        \row
            \o Linux
            \o Yes
            \o No
        \row
            \o Mac OS X
            \o Yes
            \o No
    \endtable
*/


/*!
    \contentspage index.html
    \previouspage creator-os-supported-platforms.html
con's avatar
con committed
    \page creator-quick-tour.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \nextpage creator-writing-program.html
con's avatar
con committed

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

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

    \image qtcreator-breakdown.png

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The mode selector allows you to quickly switch between tasks such as
    editing project and source files, configuring how projects are built and
    executed, and debugging your applications. To change modes, click the
    icons, or use the \l{keyboard-shortcuts}{corresponding keyboard shortcut}.
con's avatar
con committed

    \list
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
        \o Use the \gui Welcome mode to open recent sessions and projects.
        \o Use the \gui Edit mode to edit project and source files.
           \l{The sidebar} in the Edit mode provides different views for
           browsing files.
        \o Use the \gui Debug mode to inspect the state of your program while
           debugging. For more information, see \l Debugging.
        \o Use the \gui Projects mode to configure project builing and
           execution. For more information, see \l{Managing Projects}.
        \o Use the \gui Help mode to view Qt documentation. For more
           information, see \l{Qt Help Integration}.
        \o Use the \gui Output mode to examine, for example, build issues
           and compile and application output. This information is also
           available in \l{The output panes}{the output panes}.
    \endlist

    Certain actions in Qt Creator trigger a mode change. For example,
    \gui Debug > \gui{Start debugging} > \gui{Start debugging}
    automatically switches to \gui Debug mode.


    \section1 The Sidebar
con's avatar
con committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    You can select the content of the sidebar in the sidebar menu:
    \list
        \o \gui Projects shows a list of projects open in the current
           session.
        \o \gui{File System} shows the content of the currently selected
           directory.
        \o \gui Bookmarks shows all bookmarks for the current session.
        \o \gui{Open Documents} shows currently open files.
    \endlist
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    You can change the view of the sidebar in the following ways:
    \list
        \o To toggle the sidebar, click \inlineimage qtcreator-togglebutton.png
           or press \key Alt+0 (\key Cmd+0 on Mac OS X).
        \o To split the sidebar, click \inlineimage qtcreator-splitbar.png
           . When you split the sidebar, the new view shows the same
           contents as the view you are splitting.
        \o To close a sidebar view, click
           \inlineimage qtcreator-closesidebar.png
           .
    \endlist
con's avatar
con committed


Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section2 Project Tree
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    When the sidebar shows projects, they are displayed in a project tree. The
    project tree contains a list of all projects open in the current session.
    The files for each project are grouped according to their file type.
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    You can use the project tree in the following ways:
    \list
        \o Right-clicking an item in the project tree brings up a
           context menu containing the actions most commonly needed.
           For example, through the menu of the project root directory you can,
           among other actions, build, re-build, clean and run the project.
        \o To list all files in a project, click
           \inlineimage qtcreator-filter.png
           and select \gui{Simplify tree}.
        \o During a build, the build system automatically generates source
           files. To hide these files, click \inlineimage qtcreator-filter.png
           and select \gui{Hide generated files}.
        \o To toggle the synchronization of your project tree with the file
           opened in the editor, click
           \inlineimage qtcreator-synchronizefocus.png
           .
        \o To see the absolute path of a file, move the mouse pointer over the
           file name.
con's avatar
con committed
    \endlist


    \section1 The Output Panes

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The task pane in Qt Creator can display one of the following panes:
    \gui{Build Issues}, \gui{Search Results}, \gui{Application Output}, and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \gui{Compile Output}. Output panes are available in all
    \l{Qt Creator modes}{modes}.
con's avatar
con committed

con's avatar
con committed

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

con's avatar
con committed

con's avatar
con committed
    \section2 Search Results

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The \gui{Search Results} pane displays the results for global searches
    such as searching within a current document, files on disk, or all
    projects. The figure below shows an example output of search result for all
    occurrences of \c textfinder within the \c "/TextFinder" directory.
con's avatar
con committed

    \image qtcreator-search-pane.png

con's avatar
con committed
    \section2 Application Output

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The \gui{Application Output} pane displays the status of a program when
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    it is executed, and the debug output. The figure below shows an example
    output from qDebug().
con's avatar
con committed

    \image qtcreator-application-output.png

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The \gui{Compile Output} pane provides all output from the compiler. In
    other words, it is a more detailed version of information displayed in the
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \gui{Build Issues} pane.
con's avatar
con committed

    \image qtcreator-compile-pane.png

con's avatar
con committed
    \section1 Qt Help Integration

    Qt Creator comes fully integrated with all of Qt's documentation and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    examples using the Qt Help plugin.
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To view documentation, switch to \gui Help mode.
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To obtain context sensitive help, move the text cursor to a Qt class or
    function and press \key F1. The documentation is displayed in a pane
    next to the code editor, or, if there is not enough vertical space, in the
    fullscreen \gui Help mode.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To select and configure how the documentation is displayed in the
    \gui Help mode, select \gui Tools > \gui Options... > \gui Help.
con's avatar
con committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    You can display external documentation in Qt Creator's \gui Help mode.
    To augument or replace the documentation that ships with Qt Creator and Qt:
    \list 1
        \o Create a .qch file from your documentation.

           For information on how to prepare your documentation and create a
           .qch file, see
           \l{http://doc.qt.nokia.com/4.6/qthelp-framework.html}
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           {The Qt help framework}.
        \o Add the .qch file to Qt Creator by selecting \gui Tools >
           \gui Options... > \gui Help > \gui Documentation > \gui Add.
    \endlist
con's avatar
con committed


    \section1 Keyboard Navigation
    Qt Creator caters not only to developers who are used to using the mouse,
    but also to developers who are more comfortable with the keyboard. A wide
    range of \l{keyboard-shortcuts}{keyboard} and
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \l{Searching With the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.


    \section1 Qt Designer Integration

    To help you design the user interface of your application, a complete
    version of Qt Designer is integrated right into Qt Creator. Qt Creator
    automatically opens all .ui files in Qt Designer.

    The Qt Designer integration includes project management and code
    completion.

    \image qtcreator-formedit.png

    To change the layout of Qt Designer user interface elements:
    \list 1
        \o Select \gui Tools > \gui{Form editor} > \gui Views >
           \gui Locked.

           When this option is unchecked, you can change the layout.
        \o Click the header of an element and drag the element to a new
           position.
    \endlist

    To change Qt Designer properties, select \gui Tools > \gui Options >
    \gui Designer.
    \list
        \o Set the class properties and code generation preferences in \gui
           {Class Generation}.
        \o Set an additional folder for saving templates in \gui{Template
           Paths}.
        \o Set the grid settings and preview preferences in \gui Forms. To
           preview your form with skins, enable \gui{Print/Preview
           Configuration} and select your skin. Otherwise default preview
           settings are used.

           To preview the settings, select \gui Tools > \gui{Form Editor} >
           \gui Preview, or press \key Ctrl+Alt+R.
        \o To specify embedded device profiles, such as style, font, and screen
           resolution, select \gui{Embedded Design}.
    \endlist

    For more information on Qt Designer, see
    \l{http://doc.trolltech.com/designer-manual.html}{Qt Designer Manual}.
con's avatar
con committed
*/

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \previouspage creator-writing-program.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \page creator-editor-using.html
    \nextpage creator-editor-finding.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \title Using the Editor
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    Qt Creator's code editor is designed to aid you in creating, editing and
    navigating code. It is fully equipped with syntax checking, code
    completion, context sensitive help and in-line error indicators while you
    are typing.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 Configuring the Editor

    Qt Creator allows you to configure the text editor to suit your specific
    needs. To configure the editor, select  \gui Tools > \gui Options >
    \gui{Text Editor}:
    \list
        \o Set the font preferences and apply syntax highlighting in
           \gui{Font & Colors}.
        \o Set tabs, indentation and the handling of whitespace in
           \gui Behavior.
        \o Set various display properties, such as
           \l{Highlighting and folding blocks}{highlighting and folding blocks},
           text wrapping or \l{Moving to symbol definition or declaration}
           {moving to symbol definition or declaration}
           in \gui Display.
        \o Configure \l{Code completion}{code completion} in \gui Completion.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \endlist


    \section1 Using the Editor Toolbar

    The editor toolbar is located at the top of the editor view. It is context
    sensitive and shows items relevant to the file currently open in the
    editor.

    \image qtcreator-editortoolbar-symbols.png

    Use the toolbar to navigate between open files and symbols in use:
    \list
        \o To browse the history of edits for the currently open session, click
           \inlineimage qtcreator-back.png
           and \inlineimage qtcreator-forward.png
           .
        \o To go to any open file, select it from the \gui{Open files}
           drop-down menu.
        \o To jump to any symbol used in the current file, select it from the
           \gui Symbols drop-down menu.
    \endlist

    When you create or edit forms in an .ui file, the toolbar contains
    Qt Designer specific tools.

    If you are using a version control system, the toolbar enables you to
    compare the current file with the version in the repository. For more
    information on using Qt Creator with version control systems, see
    \l{Using version control systems}.


    \section1 Splitting the Editor View

    Split the editor view when you want to work on and view multiple files on
    the same screen.

    \image qtcreator-spliteditorview.png

    You can split the editor view in two ways:
    \list
        \o To split the editor view into a top and bottom view, select
           \gui Window > \gui Split or press \key{Ctrl+E, 2}.

           Split command creates views below the currently active editor view.
        \o To split the editor view into adjacent views, select
           \gui Window > \gui{Split Side by Side} or press
           \key{Ctrl+E, 3}.

           Side by side split command creates views to the right of the
           currently active editor view.
    \endlist

    To move between split views, select \gui Window >
    \gui{Go to Other Split} or press \key{Ctrl+E, 0}.

    To remove a split view, place the cursor within the view you want to
    remove and select \gui Window > \gui{Remove Current Split} or press
    \key{Ctrl+E, 0}. To remove all but the currently selected split view,
    select \gui Window > \gui{Remove All Splits} or press \key{Ctrl+E, 1}.


    \section1 Highlighting and Folding Blocks

    Use block highlighting to visually separate parts of the code that belong
    together. For example, when you place the cursor within the braces,
    the code enclosed in braces is highlighted.

    \image qtcreator-blockhighlighting.png

    To enable block highlighting, select \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Display > \gui{Highlight blocks}.

    Use the folding markers to collapse and expand blocks of code within
    braces. Click the folding marker to collapse or expand a block. In the
    figure above, the folding markers are located between the line number and
    the text pane.

    To show the folding markers, select \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Display > \gui{Display folding markers}.


    \section1 Syntax Checking

    As you write code Qt Creator checks code syntax. When it spots syntax error
    in your code it underlines it and shows error details when you move the
    mouse pointer over the error:
    \list
        \o Syntax errors are underlined in red.

           In the following figure, semicolon is missing at the end of line.

           \image qtcreator-syntaxerror.png
        \o Semantic errors and warnings are underlined in olive.

           In the following figure, the type is unknown.

           \image qtcreator-semanticerror.png
    \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    As you write code Qt Creator provides a list of context-sensitive
    suggestions to the statement where your cursor is.

    \image qtcreator-codecompletion.png

    Set code completion preferences in \gui Tools > \gui Options >
    \gui{Text Editor} > \gui Completion.

    When completion is invoked manually, Qt Creator completes the common prefix
    of the list of suggestions. This is especially useful for classes with
    several similarly named members. To disable this functionality, uncheck
    \gui{Autocomplete common prefix} in the code completion preferences.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

    The following table lists available types for code completion and icon
    used for each.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
        \header
            \o Icon
            \o Description
        \row
            \i  \inlineimage completion/class.png
            \i  A class
        \row
            \i  \inlineimage completion/enum.png
            \i  An enum
        \row
            \i  \inlineimage completion/enumerator.png
            \i  An enumerator (value of an enum)
        \row
            \i  \inlineimage completion/func.png
            \i  A function
        \row
            \i  \inlineimage completion/func_priv.png
            \i  A private function
        \row
            \i  \inlineimage completion/func_prot.png
            \i  A protected function
        \row
            \i  \inlineimage completion/var.png
            \i  A variable
        \row
            \i  \inlineimage completion/var_priv.png
            \i  A private variable
        \row
            \i  \inlineimage completion/var_prot.png
            \i  A protected variable
        \row
            \i  \inlineimage completion/signal.png
            \i  A signal
        \row
            \i  \inlineimage completion/slot.png
            \i  A slot
        \row
            \i  \inlineimage completion/slot_priv.png
            \i  A private slot
        \row
            \i  \inlineimage completion/slot_prot.png
            \i  A protected slot
        \row
            \i  \inlineimage completion/keyword.png
            \i  A keyword
        \row
            \i  \inlineimage completion/macro.png
            \i  A macro
        \row
            \i  \inlineimage completion/namespace.png
            \i  A namespace
    \endtable
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 Moving to Symbol Definition or Declaration

    In Qt Creator you can move directly to the definition or the declaration of
    a symbol by holding the \key Ctrl and clicking the symbol.

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 Using an External Editor

    To open the file you are currently viewing in an external editor, select
    \gui Edit > \gui Advanced > \gui{Open in External Editor}.

    To use the external editor of your choice:
    \list 1
        \o On Windows add the editor path to the \bold Path system variable.
           On Linux and Mac OS X add the editor path to the \bold PATH
           environment variable.
        \o In Qt Creator select \gui Tools > \gui Options... >
           \gui Environment > \gui General.
        \o In \gui{External editor} enter the name of the application followed
           by \key Space and \tt{\bold %f}. For example, to open the file in
           Smultron, enter \tt{\bold{smultron %f}}

           To further define how to open the file in the external editor, you
           can use the following variables separated by space:
           \list
            \o Current line number \tt{\bold %l}
            \o Current column number \tt{\bold %c}
            \o Editor's x position on the screen \tt{\bold %x}
            \o Editor's y position on the screen \tt{\bold %y}
            \o Editor's width in pixels \tt{\bold %w}
            \o Editor's height in pixels \tt{\bold %h}
            \o Editor's width in characters \tt{\bold %W}
            \o Editor's height in characters \tt{\bold %H}
            \o To pass % symbol to the editor \tt{\bold %%}
           \endlist

           \note Not all variables work with all editors.
    \endlist
con's avatar
con committed
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \previouspage creator-editor-using.html
    \page creator-editor-finding.html
    \nextpage creator-editor-refactoring.html
con's avatar
con committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To search through the currently open file:
    \list 1
        \o Press \key Ctrl+F or select \gui Edit > \gui Find/Replace >
           \gui{Current Document}.
        \o Enter the text you are looking for.

           If the text is found, all occurrences are highlighted as you type.
        \o To go to the next occurrence, click \inlineimage qtcreator-next.png
           , or press \key F3. To go to the previous occurrence click
           \inlineimage qtcreator-previous.png
           , or press \key Shift+F3.
    \endlist
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To narrow your search results, click
    \inlineimage qtcreator-locator-magnify.png
    in the \gui Find/Replace pane and select any of the following
    preferences:
    \list
        \o To make your search case sensitive, select
           \inlineimage qtcreator-editor-casesensitive.png
           .
        \o To search only whole words, select
           \inlineimage qtcreator-editor-wholewords.png
           .
        \o To search using regular expressions, select
           \inlineimage qtcreator-editor-regularexpressions.png
           .
           Regular expressions used in Qt Creator are modeled on Perl's regular
           expressions. For more information on using regular expressions, see
           \l http://doc.qt.nokia.com/4.6/qregexp.html#details
           {Detailed description of QRegExp class reference}.
    \endlist
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To replace occurrences of the existing text, enter the new text in the
    \gui{Replace with} text box.
    \list
        \o To replace the selected occurrence and move to the next one,
           click \inlineimage qtcreator-next.png
           or press \key Ctrl+=.
        \o To replace the selected occurrence and move to the previous one,
           click \inlineimage qtcreator-previous.png
           .
        \o To replace all occurrences in the file, click \gui{Replace All}.
    \endlist
con's avatar
con committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To search through projects, files on a file system or the currently open
    file:
    \list 1
        \o Press \key Ctrl+Shift+F or select \gui Edit >
           \gui Find/Replace > \gui Find....
        \o Select the scope of your search:
           \list
            \o \gui{All Projects} searches files matching the defined file
               pattern in all currently open projects.

               For example, to search for \tt previewer only in \tt .cpp
               and \tt .h files, enter in \gui{File pattern}
               \tt *.cpp,*.h.

               \image qtcreator-search-allprojects.png

            \o \gui{Current Project} searches files matching the defined file
               pattern only in the project you are currently editing.
            \o \gui{Files on File System} recursively searches files matching
               the defined file pattern in the selected directory.
            \o \gui{Current File} searches only the current file.
           \endlist
        \o Enter the text you are looking for and click \gui Search.

           \image qtcreator-searchresults.png

           A list of files containing the searched text is displayed in the
           \gui{Search Results} pane.
           \list
            \o To see all occurrences in a file, double-click the file name in
               the list.
            \o To go to an occurrence, double-click it.
           \endlist
    \endlist
*/
con's avatar
con committed


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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \title Refactoring
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    Code refactoring is the process of changing the code without modifying the
    existing functionality of your application. By refactoring your code you
    can:
    \list
        \o Improve internal quality of your application
        \o Improve performance and extensibility
        \o Improve code readability and maintainability
        \o Simplify code structure
    \endlist
con's avatar
con committed

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

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To find the use of a specific symbol in your project:
    \list 1
        \o In the editor place the cursor on the symbol and select \gui Tools
           > \gui C++ > \gui{Rename Symbol under Cursor} or press
           \key Ctrl+Shift+U.

           Qt Creator looks for the symbol in the following locations:
           \list
            \o Files listed as a part of the project
            \o Files directly used by the project files (for example, generated
               files)
            \o Header files of used frameworks and libraries
           \endlist
        \o The \gui{Search Results} pane opens and shows the location and
           number of instances of the symbol in the current project.

           \image qtcreator-refactoring-find.png
    \endlist
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    You can browse the search results in the following ways:
    \list
        \o To go directly to an instance, double-click the instance in the
           \gui{Search Results} pane.
        \o To move between instances, click
           \inlineimage qtcreator-forward.png
           and
           \inlineimage qtcreator-back.png
           in the \gui{Search Results} pane.
        \o To expand and collapse the list of all instances, click
           \inlineimage qtcreator-expand.png
           .
        \o To clear the search results, click \inlineimage qtcreator-clear.png
           .
    \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 Renaming Symbols

    To rename a specific symbol in your project:
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \list 1
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
        \o In the editor, place the cursor on the symbol you would like to
           change and select \gui Tools > \gui C++ >
           \gui{Rename Symbol under Cursor} or press \key Ctrl+Shift+R.

           The \gui{Search Results} pane opens and shows the location and
           number of instances of the symbol in the current project.

           \image qtcreator-refactoring-replace.png
        \o To replace all selected instances, enter the name of the new symbol
           in the \gui{Replace with} text box and click \gui Replace.

           To omit an instance, uncheck the check-box next to the instance.

           \note This action replaces all selected instances of the symbol in
           all files listed in the \gui{Search Results} pane. You cannot
           undo this action.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \endlist
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \previouspage creator-editor-locator.html
    \page creator-project-managing.html
    \nextpage creator-project-creating.html

    \title Managing Projects
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    Qt Creator allows you to deploy various types of projects and provides a
    platform to work on different types of projects:
    \list
       \o To work with \bold{qmake projects}, open a \c .pro file. For more
          information, see \l{Setting Up a qmake Project}.
       \o To work with \bold{CMake projects} you need to have CMake version
          2.8.0 or later installed. For more information, see
          \l{Setting Up a CMake Project}.
       \o Qt Creator supports generic projects. For more information, see
          \l{Setting Up a Generic Project}.
    \endlist
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 External Libraries
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    Through external libraries Qt Creator can support code completion and
    syntax highlighting for external libraries as if they were a part of the
    current project or the Qt library.
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    The procedure of adding a library to a project depends on the type of
    project, which influences the build system used.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \list
       \o For information on adding external libraries to qmake projects, see
          \l{Adding External Libraries to a qmake Project}.
       \o For information on adding external libraries to CMake projects, see
          \l{Adding External Libraries to a CMake Project}.
       \o For information on adding external libraries to generic projects, see
          \l{Adding External Libraries to a Generic Project}.
   \endlist

    \section1 Session Management
    In Qt Creator a session is a collection of bookmarks, breakpoints and
    watchers and can include multiple open projects. To learn about using and
    managing sessions, see \l{Managing Sessions}.
*/
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
/*!
    \contentspage index.html
    \previouspage creator-project-managing.html
    \page creator-project-creating.html
    \nextpage creator-project-qmake.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \title Creating a Project
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    To create a new project:
    \list 1
        \o Select \gui File > \gui{New Project} and select the type of your
           project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           This example uses \bold{Qt4 Gui Application}.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           \image qtcreator-new-project.png
        \o Name the project and set its path. To select the path from a
           directory tree, click \gui Choose....
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           Avoid using spaces and special characters in the project name and
           path.

           \image qtcreator-intro-and-location.png
        \o Select the Qt modules you want to include in your project.
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
           Since this example shows creation of a Qt4 Gui Application project
           type, QtCore and QtGui modules are selected by default. However, you
           can select any other you need.

           \image qtcreator-select-modules.png
        \o Specify the name of the class you want to create and using the
           drop-down menu select its base class type.

           Note that the \gui{Header file}, \gui{Source file} and
           \gui{Form file} fields are automatically updated as you name your
           class.

           \image qtcreator-class-info.png
        \o Review the project settings.

           To create the project, click \gui Done.

           \image qtcreator-new-project-summary.png
    \endlist
con's avatar
con committed
*/

con's avatar
con committed
/*!
    \contentspage index.html
Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \previouspage creator-project-creating.html
    \page creator-project-qmake.html
    \nextpage creator-project-cmake.html
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \title Setting Up a qmake Project
con's avatar
con committed

Oswald Buddenhagen's avatar
Oswald Buddenhagen committed
    \section1 Selecting the Qt Version

    Qt Creator allows you to have multiple versions of Qt installed on
    your computer and use different versions for your projects.

    If Qt Creator finds \bold qmake in the PATH environment variable, it uses
    that version. This \l{glossary-system-qt}{version of Qt} is referred to as
    \bold{Qt in PATH}. If you intend to use only one version of Qt and it is
    already in the PATH and correctly set up for command line use, you do not
    need to manually configure your Qt version.

    \note By default, Qt Creator compiles projects with the
    \l{glossary-default-qt}{default Qt version}. For information on how to
    override this setting, see \l{Build Settings}.

    \section2 Windows

    To add a Qt version for \bold MinGW:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Click \inlineimage qtcreator-windows-add.png
           and enter the name of the version in \gui{Version Name} field.
        \o Enter the qmake binary path in the \gui{qmake Location}.
        \o Enter the MinGW installation path in the \gui{MinGW Directory}.

           \image qtcreator-qt4-qtversions-win-mingw.png
    \endlist

    To add a Qt version for a \bold{Microsoft Visual C++} compiler:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Qt Creator automatically sets the correct environment variables for
           compilation. Select the internal version number of the installed
           Microsoft Visual C++ tool chains using the \gui MSVC drop-down
           box:
           \list
               \o \bold 7.1 for Visual Studio 2003
               \o \bold 8.0 for Visual Studio 2005
               \o \bold 9.0 for Visual Studio 2008
           \endlist

           \note If you are using the
           \bold{Windows SDK for Windows Server 2008}, Qt Creator identifies
           it as version 9.0.

           \image qtcreator-qt4-qtversions-win-msvc.png
    \endlist

    If you are using \bold{Qt for Symbian} and your S60 SDK is registered
    with devices.exe, Qt Creator automatically detects the Qt version. To add a
    Qt for Symbian version:
    \list 1
        \o Select \gui Tools > \gui Options... > \gui Qt4 >
           \gui{Qt Versions}.
        \o Select the \gui{S60 SDK} you want the Qt Creator to use.

           \image qtcreator-qt4-qtversions-win-symbian.png
        \o To build an application for your device using GCCE, enter the path
           to the \bold{CSL ARM Toolchain} directory in
           \gui{CSL\\GCCE Directory}.

           You do not need to specify this path if the compiler is included in
           the PATH environment variable.
        \o To build an application for the emulator (WINSCW toolchain), enter
           the path to your Carbide C++ installation directory in
           \gui{Carbide Directory}.