/****************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
**
** GNU Free Documentation License
**
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of this
** file.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
****************************************************************************/

// **********************************************************************
// 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.
// **********************************************************************

/*!
    \contentspage index.html
    \previouspage creator-overview.html
    \page creator-quick-tour.html
    \nextpage creator-getting-started.html

    \title User Interface

    \image qtcreator-breakdown.png

    When you start \QC, it opens to the \gui Welcome mode, where you can:

    \list

        \o  Read news from the Qt labs

        \o  Open tutorials and example projects

        \o  Create and open projects

        \o  Send feedback to the development team

        \o  Open recent sessions and projects

    \endlist

    You can use the mode selector to change to another \QC mode.
    The following image displays an example application in \gui Edit mode
    and \gui Design mode.

    \image qtcreator-qt-quick-editors.png "Edit mode and Design mode"

    \QC has been localized into several languages. If the system language is one
    of the supported languages, it is automatically selected. To change the
    language, select \gui {Tools > Options > Environment} and select a language
    in the \gui Language field. The change takes effect after you restart \QC.

    \section1 Modes

    The mode selector allows you to quickly switch between tasks such as editing
    project and source files, designing application UIs, 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}.

    You can use \QC in the following modes:

    \list

        \o  \gui Welcome mode for opening projects.

        \o  \gui{\l{Using the Editor}{Edit}} mode for editing project and source
            files.

        \o  \gui{\l{Developing Application UI}{Design}} mode for designing and
            developing application user interfaces. This mode is available for
            UI files.

        \o  \gui{\l{Debugging}{Debug}} mode for inspecting the state of your
            application while debugging.

        \o  \gui{\l{Specifying Build Settings}{Projects}} mode for configuring
            project building and execution. This mode is available when a
            project is open.

        \o  \gui{\l{Analyzing Code}{Analyze}} mode for using code analysis tools
            to detect memory leaks and profile C++ or QML code.

        \o  \gui{\l{Getting Help}{Help}} mode for viewing Qt documentation.

    \endlist

    Certain actions in \QC trigger a mode change. Clicking on \gui {Debug} >
    \gui {Start Debugging} > \gui {Start Debugging} automatically switches to
    \gui {Debug} mode.

    \section1 Browsing Project Contents

    The sidebar is available in the \gui Edit and \gui Debug modes. Use the
    sidebar to browse projects, files, and bookmarks, and to view the class
    hierarchy.

    \image qtcreator-sidebar.png

    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{Open Documents} shows currently open files.

        \o  \gui Bookmarks shows all bookmarks for the current session.

        \o  \gui{File System} shows all files in the currently selected
             directory.

        \o  \gui {Class View} shows the class hierarchy of the currently
            open projects.

        \o  \gui Outline shows the symbol hierachy of a C++ file and the element
            hierarchy of a QML file.

        \o  \gui {Type Hierarchy} shows the base classes of a class.

    \endlist

    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
            . Select new content to view in the split view.

        \o  To close a sidebar view, click
            \inlineimage qtcreator-closesidebar.png
            .

    \endlist

    The additional options in each view are described in the following
    sections.

    \section2 Viewing Project Files

    The sidebar displays projects in a project tree. The project tree contains
    a list of all projects open in the current session. The files for each
    project are grouped according to their file type.

    You can use the project tree in the following ways:

    \list

        \o  To bring up a context menu containing the actions most commonly
            needed right-click an item in the project tree. 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 hide the categories and sort project files alphabetically, click
            \inlineimage qtcreator-filter.png
            and select \gui{Simplify Tree}.

        \o  To hide source files which are automatically generated by the build
            system, during a build, click \inlineimage qtcreator-filter.png
            and select \gui{Hide Generated Files}.

        \o  To keep the position in the project tree synchronized with the file
            currently 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.

    \endlist

    \section2 Viewing the File System

    If you cannot see a file in the \gui Projects view, switch to the
    \gui {File System} view, which shows all the files in the file system.

    To keep the position in the tree synchronized with the file
    opened in the editor, click
    \inlineimage qtcreator-synchronizefocus.png
    .

    \section2 Viewing the Class Hierarchy

    The \gui {Class View} shows the class hierarchy of the currently
    open projects. To organize the view by subprojects, click
    \inlineimage qtcreator-show-subprojects.png
    .

    \section2 Viewing QML Elements

    The \gui Outline view shows the element hierarchy in a QML file.

    \list

        \o  To see a complete list of all bindings, click
            \inlineimage qtcreator-filter.png
            and select \gui{Show All Bindings}.

        \o  To keep the position in the view synchronized with the element
            selected in the editor, click
            \inlineimage qtcreator-synchronizefocus.png
            .

    \endlist

    \section2 Viewing Type Hierarchy

    To view the base classes of a class, right-click the class and select
    \gui {Open Type Hierarchy}  or press \key {Ctrl+Shift+T}.

    \section1 Viewing Output

    The task pane in \QC can display one of the following panes:

    \list

       \o  \gui{Issues}

       \o  \gui{Search Results}

       \o  \gui{Application Output}

       \o  \gui{Compile Output}

       \o  \gui{General Messages}

       \o  \gui{Version Control}

    \endlist

    Output panes are available in all \l{Modes}{modes}. Click the name of an
    output pane to open the pane. To maximize an open output pane, click the
    \gui {Maximize Output Pane} button or press \key {Alt+9}.

    To search within the \gui{Application Output} and \gui{Compile Output}
    panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in
    the \gui Find field and click the left and right arrows to search down and
    up in the pane.

    To open the \gui{General Messages} and \gui{Version Control} panes, select
    \gui {Window > Output Panes}.

    \section2 Issues

    The \gui{Issues} pane provides lists of following types of issues:

    \list

        \o  \gui Analyzer - Errors encountered while running the
            \l{Analyzing Code}{Valgrind code analysis tools}.

        \o  \gui {Build System} - Errors and warnings encountered during a
            build.

        \o  \gui Compile - Selected output from the compiler. Open the
            \gui {Compile Output} pane for more detailed information.

        \o  \gui {My Tasks} - Entries from a task list file (.tasks) generated
            by \l{Showing Task List Files in Issues Pane}
            {code scanning and analysis tools}.

        \o  \gui QML - Errors in QML syntax.

        \o  \gui {QML Analysis} - Results of the JavaScript
            \l{Checking JavaScript Syntax}{code syntax and validation checks}

    \endlist

    The pane filters out irrelevant output from the build tools and presents the
    issues in an organized way. To further filter the output by type, select
    \inlineimage qtcreator-filter.png
    and then select a filter.

    \image qtcreator-build-issues.png

    Right-clicking on a line brings up a context menu with options to copy
    the contents and to show a version control annotation view of the line
    that causes the error message.

    To jump from one issue to the next or previous one, press \key F6 and
    \key Shift+F6.

    \section2 Search Results

    The \gui{Search Results} pane displays the results for global searches,
    for example, searching within a current document, files on disk, or all
    projects.

    The figure below shows an example search result for all
    occurrences of \c textfinder within the \c "/TextFinder" directory.

    \image qtcreator-search-pane.png

    \section2 Application Output

    The \gui{Application Output} pane displays the status of a program when
    it is executed, and the debug output.

    The figure below shows an example output from qDebug().

    \image qtcreator-application-output.png

    \section2 Compile Output

    The \gui{Compile Output} pane provides all output from the compiler.
    The \gui{Compile Output} is a more detailed version of information
    displayed in the \gui{Issues} pane.

    \image qtcreator-compile-pane.png

    \section1 Navigating with Keyboard

    \QC 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{Searching with the Locator}{navigation} shortcuts are available to help
    speed up the process of developing your application.

    \section1 Useful Features

    For a list of useful \QC features described in other parts of the
    documentation, see \l{Tips and Tricks}.

*/
