diff --git a/doc/images/qtcreator-application-output.png b/doc/images/qtcreator-application-output.png index 1064dd3a6d9..05f76b380d3 100644 Binary files a/doc/images/qtcreator-application-output.png and b/doc/images/qtcreator-application-output.png differ diff --git a/doc/images/qtcreator-build-issues.png b/doc/images/qtcreator-build-issues.png index 230572237e9..85c42782b3b 100644 Binary files a/doc/images/qtcreator-build-issues.png and b/doc/images/qtcreator-build-issues.png differ diff --git a/doc/images/qtcreator-compile-pane.png b/doc/images/qtcreator-compile-pane.png index 5c9b7647333..e7af4fe5e80 100644 Binary files a/doc/images/qtcreator-compile-pane.png and b/doc/images/qtcreator-compile-pane.png differ diff --git a/doc/images/qtcreator-filesystem-view.png b/doc/images/qtcreator-filesystem-view.png index 407f39a2b24..c94cf6020ee 100644 Binary files a/doc/images/qtcreator-filesystem-view.png and b/doc/images/qtcreator-filesystem-view.png differ diff --git a/doc/images/qtcreator-image-viewer.png b/doc/images/qtcreator-image-viewer.png index c1160c8a4f6..ea3ee88a83a 100644 Binary files a/doc/images/qtcreator-image-viewer.png and b/doc/images/qtcreator-image-viewer.png differ diff --git a/doc/images/qtcreator-mode-selector.png b/doc/images/qtcreator-mode-selector.png index ab52f1094a0..e82047cf859 100644 Binary files a/doc/images/qtcreator-mode-selector.png and b/doc/images/qtcreator-mode-selector.png differ diff --git a/doc/images/qtcreator-search-results.png b/doc/images/qtcreator-search-results.png index bf64f6e3a90..363207038a7 100644 Binary files a/doc/images/qtcreator-search-results.png and b/doc/images/qtcreator-search-results.png differ diff --git a/doc/images/qtcreator-searchresults.png b/doc/images/qtcreator-searchresults.png index 3bdf3fc1531..8c0a0b0ebb9 100644 Binary files a/doc/images/qtcreator-searchresults.png and b/doc/images/qtcreator-searchresults.png differ diff --git a/doc/images/qtcreator-sidebar.png b/doc/images/qtcreator-sidebar.png index e0c0da3c29f..d7f6dea0f86 100644 Binary files a/doc/images/qtcreator-sidebar.png and b/doc/images/qtcreator-sidebar.png differ diff --git a/doc/images/qtcreator-task-pane.png b/doc/images/qtcreator-task-pane.png new file mode 100644 index 00000000000..b2207514005 Binary files /dev/null and b/doc/images/qtcreator-task-pane.png differ diff --git a/doc/images/qtcreator-todo-options.png b/doc/images/qtcreator-todo-options.png index acf1a1ee906..9de23156214 100644 Binary files a/doc/images/qtcreator-todo-options.png and b/doc/images/qtcreator-todo-options.png differ diff --git a/doc/images/qtcreator-todo-pane.png b/doc/images/qtcreator-todo-pane.png index eed8e3deba4..21122b96a22 100644 Binary files a/doc/images/qtcreator-todo-pane.png and b/doc/images/qtcreator-todo-pane.png differ diff --git a/doc/src/howto/creator-only/creator-tips.qdoc b/doc/src/howto/creator-only/creator-tips.qdoc index 80334544978..5e481b42f27 100644 --- a/doc/src/howto/creator-only/creator-tips.qdoc +++ b/doc/src/howto/creator-only/creator-tips.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2018 The Qt Company Ltd. +** Copyright (C) 2019 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Creator documentation. @@ -53,7 +53,7 @@ \endlist - For more information about \QC modes, see \l {Modes}. + For more information about \QC modes, see \l {Selecting Modes}. \section1 Moving Between Open Files diff --git a/doc/src/howto/creator-sidebar-views.qdocinc b/doc/src/howto/creator-sidebar-views.qdoc similarity index 93% rename from doc/src/howto/creator-sidebar-views.qdocinc rename to doc/src/howto/creator-sidebar-views.qdoc index 036d7c45b46..bda32acb6ae 100644 --- a/doc/src/howto/creator-sidebar-views.qdocinc +++ b/doc/src/howto/creator-sidebar-views.qdoc @@ -24,15 +24,19 @@ ****************************************************************************/ /*! -//! [using sidebar views] + \contentspage index.html + \page creator-sidebar-views.html + \previouspage creator-modes.html + \nextpage creator-output-panes.html - \section1 Browsing Project Contents + \title Browsing Project Contents - A left and right sidebar are available in most \QC modes. The availability - of the sidebars and their contents depend on the mode. + A left and right sidebar are available in most \QC \l{Selecting Modes} + {modes}. The availability of the sidebars and their contents depend on + the mode. - In the \uicontrol Edit mode, you can use the sidebars to browse the project - contents. + In the \uicontrol Edit and \uicontrol Design mode, you can use the sidebars + to browse the project contents. \image qtcreator-sidebar.png @@ -97,11 +101,7 @@ In some views, right-clicking opens a context menu that contains functions for managing the objects listed in the view. -//! [using sidebar views] - -//! [projects view] - - \section2 Viewing Project Files + \section1 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. For each project, the @@ -196,11 +196,7 @@ files, as well as compare the selected file with the currently open file in the diff editor. For more information, see \l{Comparing Files}. -//! [projects view] - -//! [file system view] - - \section2 Viewing the File System + \section1 Viewing the File System If you cannot see a file in the \uicontrol Projects view, switch to the \uicontrol {File System} view, which shows all the files in the file system. @@ -268,11 +264,7 @@ \endlist -//! [file system view] - -//! [outline view] - - \section2 Viewing Defined Types and Symbols + \section1 Viewing Defined Types and Symbols The \uicontrol Outline view shows an overview of defined types and other symbols, as well as their properties and hierarchy in a source file. @@ -284,12 +276,7 @@ editor, deselect \uicontrol {Synchronize with Editor}. \endlist -//! [outline view] - - -//! [class view] - - \section2 Viewing the Class Hierarchy + \section1 Viewing the Class Hierarchy The \uicontrol {Class View} shows the class hierarchy of the currently open projects. To organize the view by subprojects, click @@ -299,22 +286,12 @@ To visit all parts of a namespace, double-click on the namespace item multiple times. -//! [class view] - - -//! [type hierarchy view] - - \section2 Viewing Type Hierarchy + \section1 Viewing Type Hierarchy To view the base classes of a class, right-click the class and select \uicontrol {Open Type Hierarchy} or press \key {Ctrl+Shift+T}. -//! [type hierarchy view] - - -//! [include hierarchy view] - - \section2 Viewing Include Hierarchy + \section1 Viewing Include Hierarchy To view which files are included in the current file and which files include the current file, right-click in the editor and select @@ -322,6 +299,4 @@ To keep the view synchronized with the file currently opened in the editor, select \uicontrol {Synchronize with Editor}. - -//! [include hierarchy view] */ diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index bad8eacedea..f91302ad0c7 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -34,11 +34,10 @@ \page creator-quick-tour.html \if defined(qtdesignstudio) \previouspage qtbridge-ps-using.html - \nextpage creator-using-qt-quick-designer.html \else \previouspage creator-overview.html - \nextpage creator-configuring.html \endif + \nextpage creator-modes.html \title User Interface @@ -64,7 +63,8 @@ \image studio-welcome-mode.png \endif - You can use the mode selector (1) to change to another \QC mode. + You can use the \l{Selecting Modes}{mode selector} (1) to change to another + \QC mode. \if defined(qtcreator) You can use the kit selector (2) to select the @@ -74,359 +74,27 @@ \else You can use the kit selector (2) to select the \l{glossary-buildandrun-kit} {kit} for running (3) or debugging (4) the application. Output from these - actions is displayed in the output panes (5). + actions is displayed in the \l{Viewing Output}{output panes} (5). \endif - You can use the locator (6) to browse through projects, files, classes, - functions, documentation, and file systems. + You can use the \l{Searching with the Locator}{locator} (6) to browse + through projects, files, classes, functions, documentation, and file + systems. \if defined(qtcreator) For a quick tour of the user interface that takes you to the locations of these controls, select \uicontrol Help > \uicontrol {UI Tour}. \endif - \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}. - - To hide the mode selector and to save space on the display, select - \uicontrol Window > \uicontrol {Mode Selector Style} > \uicontrol Hidden. - To only show icons on the mode selector, select the \uicontrol {Icons Only} - style. - - The following image displays an example application in \uicontrol Edit mode (1) - and \uicontrol Design mode (2). - - \if defined(qtcreator) - \image qtcreator-qt-quick-editors.png "Edit mode and Design mode" - \else - \image studio-editors.png "Edit mode and Design mode" - \endif - - You can use \QC in the following modes: + The following sections describe some of these controls in more detail: \list - - \li \uicontrol Welcome mode for opening projects. - - \li \uicontrol{\l{Coding}{Edit}} mode for editing project and source - files. - - \if defined(qtcreator) - \li \uicontrol{\l{Designing User Interfaces}{Design}} - \else - \li \uicontrol{\l{Editing QML Files in Design Mode}{Design}} - \endif - mode for designing and developing application user interfaces. - This mode is available for UI files. - - \li \uicontrol{\l{Debugging}{Debug}} mode for inspecting the state of your - application while debugging and for using code analysis tools - to detect memory leaks and profile C++ or QML code. - - \if defined(qtcreator) - \li \uicontrol{\l{Specifying Build Settings}{Projects}} mode - for configuring project building and execution. - \else - \li \uicontrol{\l{Selecting the Preview Tool}{Projects}} mode - for selecting the tool to use for live preview. - \endif - This mode is available when a project is open. - - \li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing Qt - documentation. - + \li \l{Selecting Modes}{Mode selector} + \li \l{Browsing Project Contents}{Sidebars} + \li \l{Viewing Output}{Output panes} \endlist - Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} > - \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to - \uicontrol {Debug} mode. - - \include creator-sidebar-views.qdocinc using sidebar views - \include creator-sidebar-views.qdocinc projects view - \include creator-sidebar-views.qdocinc file system view - \include creator-sidebar-views.qdocinc outline view - \if defined(qtcreator) - \include creator-sidebar-views.qdocinc class view - \include creator-sidebar-views.qdocinc type hierarchy view - \include creator-sidebar-views.qdocinc include hierarchy view - \endif - - \section1 Viewing Output - - The task pane in \QC can display one of the following panes: - - \list - - \li \uicontrol{Issues} - - \li \uicontrol{Search Results} - - \li \uicontrol{Application Output} - - \li \uicontrol{Compile Output} - - \li \uicontrol {QML Debugger Console} - - \li \uicontrol{General Messages} - - \li \uicontrol{Version Control} - - \if defined(qtcreator) - \li \uicontrol{Test Results} - - \li \uicontrol {To-Do Entries} - \endif - - \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 - \uicontrol {Maximize Output Pane} button or press \key {Alt+9}. - - To search within the \uicontrol{Application Output} and \uicontrol{Compile Output} - panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in - the \uicontrol Find field and click the left and right arrows to search down and - up in the pane. In these panes, you can also use the zoom buttons to increase and - decrease the text size of the output. - - To open the \uicontrol{General Messages} and - \if defined(qtcreator) - \l{Using Version Control Systems}{Version Control} - \else - \l{Using Git}{Version Control} - \endif - panes, select \uicontrol {Window > Output Panes}. - \if defined(qtcreator) - To display the \uicontrol {To-Do Entries} pane, enable the Todo plugin. - \endif - - For more information about the \uicontrol {QML Debugger Console} view, see - \l{Executing JavaScript Expressions}. - - \section2 Issues - - The \uicontrol{Issues} pane provides lists of following types of issues: - - \list - - \if defined(qtdesignstudio) - \li \uicontrol {Asset Importer Error} - Errors and warnings encountered - while importing assets from a design tool. - \endif - - \li \uicontrol {Build System} - Errors and warnings encountered during a - build. - - \if defined(qtcreator) - \li \uicontrol {Clang Code Model} - - \l {Parsing C++ Files with the Clang Code Model} - {Errors and warnings from the current editor}. - \endif - - \li \uicontrol Compile - Selected output from the compiler. Open the - \uicontrol {Compile Output} pane for more detailed information. - - \li \uicontrol{Debug Information} - Lists debug information packages that might - be missing. - - \if defined(qtcreator) - \li \uicontrol Debugger - Errors encountered while running the - \l{Analyzing Code}{Valgrind code analysis tools}. - \endif - - \li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For - example, information about missing DLLs. - - \li \uicontrol Deployment - Errors encountered between building an application - successfully and starting it on a \l{glossary-device}{device}. - - \if defined(qtcreator) - \li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated - by \l{Showing Task List Files in Issues Pane} - {code scanning and analysis tools}. - - \li \uicontrol Python - Runtime errors and exceptions of Python scripts. - \endif - - \li \uicontrol QML and \uicontrol {QML Analysis} - - \l{JavaScript and QML Error Codes} - {QML and JavaScript syntax errors}. - - \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 - \uicontrol {Filter Tree} - and then select a filter. - - \image qtcreator-build-issues.png - - Right-clicking on a line brings up a context menu with actions that you can - apply to the contents of the line. You can remove a line, copy its contents - to the clipboard, or search the Internet for a solution using the contents - of the line as search criteria. In addition, you can show a version control - annotation view of the line that causes the error message. - - To navigate to the corresponding source code, click an issue or - select \uicontrol {Show in Editor} in the context menu. The entry must contain the - name of the file where the issue was found. - - To view more information about an issue in the \uicontrol {Compile Output} pane, - select \uicontrol {Show Output} in the context menu. - - To jump from one issue to the next or previous one, press \key F6 and - \key Shift+F6. - - \section2 Search Results - - In the \uicontrol{Search Results} pane, you can search through projects, files on - a file system or the currently open files: - - \image qtcreator-search-results.png "Search Results output pane" - - The search results are stored in the search history (1) from which you can - select earlier searches. - - The figure below shows an example search result for all - occurrences of the search string in the specified directory. - - \image qtcreator-searchresults.png - - For more information about the different search options, see - \l {Finding and Replacing}. - - \section2 Application Output - - The \uicontrol{Application Output} pane displays the status of a program when - it is executed, and the debug output. - - \image qtcreator-application-output.png - - \if defined(qtcreator) - If you specify command line arguments in the run settings that are passed - to the application when running it, they are displayed as a part of the - application output. For more information, see - \l{Specifying Run Settings for Desktop Device Types}. - \endif - - Select toolbar buttons to run applications, to attach the debugger to the - running application, and to stop running or debugging. - - To specify settings for displaying application output, select - \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > - \uicontrol General. You can select whether to open the - \uicontrol{Application Output} pane on output when running or debugging - applications, to clear old output on a new run, to word-wrap output, and to - limit output to the specified number of lines. - - \section2 Compile Output - - The \uicontrol{Compile Output} pane provides all output from the compiler. - The \uicontrol{Compile Output} is a more detailed version of information - displayed in the \uicontrol{Issues} pane. - - \image qtcreator-compile-pane.png - - Double-click on a file name in an error message to open the file in the - code editor. - - Select the \uicontrol {Cancel Build} button to cancel the build. - - To specify whether to open the \uicontrol {Compile Output} pane on output - when building applications, select \uicontrol Tools > \uicontrol Options > - \uicontrol {Build & Run} > \uicontrol General, and then select the - \uicontrol {Open Compile Output pane when building} check box. - In the \uicontrol {Limit build output to} field, you can specify the maximum - amount of build output lines to display in the pane. - - \if defined(qtcreator) - \section2 To-Do Entries - - The \uicontrol {To-Do Entries} pane lists the BUG, FIXME, NOTE, TODO, and - WARNING keywords from the current file, from all project files, or from a - subproject. Click the icons on the toolbar to show only the selected - keywords. - - \image qtcreator-todo-pane.png - - To add keywords, select \uicontrol Tools > \uicontrol Options > - \uicontrol {To-Do} > \uicontrol Add. Set an icon and a line background color - for the keyword. - - \image qtcreator-todo-options.png - - To change the icon and line background color of the selected keyword, select - \uicontrol Edit. - - To remove the selected keyword, select \uicontrol Remove. - - To reset the list to predefined keywords, select \uicontrol Reset. All your - changes will be permanently lost. - - To determine whether the keywords in the whole project, in the current file, - or in a subproject are displayed by default, select the appropriate option - in the \uicontrol {Scanning scope} group. - - To exclude files from scanning, select \uicontrol {Project Settings} > - \uicontrol {To-Do} in the - \uicontrol Projects mode. Select \uicontrol Add and enter a regular - expression that matches the path to files to exclude. Use a forward slash - (/) as a separator in the path also on Windows. - - The Todo plugin is disabled by default. To enable the plugin, select - \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities > - \uicontrol Todo and restart - \QC. - - In addition, you can open task list files generated by code scanning and - analysis tools in the \uicontrol Issues pane. For more information, see - \l{Showing Task List Files in Issues Pane}. - \endif - - \section1 Changing Languages - - \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 \uicontrol {Tools > Options > Environment} and select a language - in the \uicontrol Language field. The change takes effect after you restart \QC. - - \section1 Viewing Images - - \QC opens image files in the image viewer. - - \image qtcreator-image-viewer.png "Image viewer" - - Use the toolbar buttons (1) or \l{Keyboard Shortcuts}{keyboard shortcuts} - to: - - \list - - \li Export SVG images to pixmaps - - \li Switch between background and outline modes - - \li Zoom in and out - - \li Fit images to screen - - \li Return to original size - - \li Play and pause animated GIF and MNG images - - \endlist - - \section2 Exporting SVG Images - - If you receive a freely scalable icon in the SVG format from an UI designer, - you can export it to several images of different sizes to create a set of - pixmaps. You can then use QIcon::addPixmap() to add the pixmaps to icons in - different modes and states. - \section1 Navigating with Keyboard \QC caters not only to developers who are used to using the mouse, @@ -540,3 +208,362 @@ \uicontrol {Enable high DPI scaling}. The changes will take effect after you restart \QC. */ + +/*! + \contentspage index.html + \page creator-modes.html + \previouspage creator-quick-tour.html + \nextpage creator-sidebar-views.html + + \title Selecting Modes + + \image qtcreator-mode-selector.png + + 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}. + + To hide the mode selector and to save space on the display, select + \uicontrol Window > \uicontrol {Mode Selector Style} > \uicontrol Hidden. + To only show icons on the mode selector, select the \uicontrol {Icons Only} + style. + + The following image displays an example application in \uicontrol Edit mode (1) + and \uicontrol Design mode (2). + + \if defined(qtcreator) + \image qtcreator-qt-quick-editors.png "Edit mode and Design mode" + \else + \image studio-editors.png "Edit mode and Design mode" + \endif + + You can use \QC in the following modes: + + \list + + \li \uicontrol {\l{User Interface}{Welcome}} mode for opening projects. + + \li \uicontrol{\l{Coding}{Edit}} mode for editing project and source + files. + + \if defined(qtcreator) + \li \uicontrol{\l{Designing User Interfaces}{Design}} + \else + \li \uicontrol{\l{Editing QML Files in Design Mode}{Design}} + \endif + mode for designing and developing application user interfaces. + This mode is available for UI files. + + \if defined(qtcreator) + \li \uicontrol{\l{Debugging}{Debug}} + \else + \li \uicontrol {\l{Debugging and Profiling}{Debug}} + \endif + mode for inspecting the state of your + application while debugging and for using code analysis tools + to detect memory leaks and profile C++ or QML code. + + \if defined(qtcreator) + \li \uicontrol{\l{Specifying Build Settings}{Projects}} mode + for configuring project building and execution. + \else + \li \uicontrol{\l{Selecting the Preview Tool}{Projects}} mode + for selecting the tool to use for live preview. + \endif + This mode is available when a project is open. + + \li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing Qt + documentation. + + \endlist + + Certain actions in \QC trigger a mode change. Clicking on \uicontrol {Debug} > + \uicontrol {Start Debugging} > \uicontrol {Start Debugging} automatically switches to + \uicontrol {Debug} mode. +*/ + +/*! + \contentspage index.html + \page creator-output-panes.html + \previouspage creator-sidebar-views.html + \if defined(qtdesignstudio) + \nextpage creator-using-qt-quick-designer.html + \else + \nextpage creator-configuring.html + \endif + + \title Viewing Output + + \image qtcreator-task-pane.png + + The task pane in \QC can display one of the following panes: + + \list + + \li \uicontrol{Issues} + + \li \uicontrol{Search Results} + + \li \uicontrol{Application Output} + + \li \uicontrol{Compile Output} + + \li \uicontrol {QML Debugger Console} + + \li \uicontrol{General Messages} + + \li \uicontrol{Version Control} + + \if defined(qtcreator) + \li \uicontrol{Test Results} + + \li \uicontrol {To-Do Entries} + \endif + + \endlist + + Output panes are available in all \l{Selecting Modes}{modes}. Click the name + of an output pane to open the pane. To maximize an open output pane, click + the \uicontrol {Maximize Output Pane} button or press \key {Alt+9}. + + To search within the \uicontrol{Application Output} and \uicontrol{Compile Output} + panes, press \key {Ctrl+F} when the pane is active. Enter search criteria in + the \uicontrol Find field and click the left and right arrows to search down and + up in the pane. In these panes, you can also use the zoom buttons to increase and + decrease the text size of the output. + + To open the \uicontrol{General Messages} and + \if defined(qtcreator) + \l{Using Version Control Systems}{Version Control} + \else + \l{Using Git}{Version Control} + \endif + panes, select \uicontrol {Window > Output Panes}. + \if defined(qtcreator) + To display the \uicontrol {To-Do Entries} pane, enable the Todo plugin. + \endif + + For more information about the \uicontrol {QML Debugger Console} view, see + \l{Executing JavaScript Expressions}. + + \section1 Issues + + The \uicontrol{Issues} pane provides lists of following types of issues: + + \list + + \if defined(qtdesignstudio) + \li \uicontrol {Asset Importer Error} - Errors and warnings encountered + while importing assets from a design tool. + \endif + + \li \uicontrol {Build System} - Errors and warnings encountered during a + build. + + \if defined(qtcreator) + \li \uicontrol {Clang Code Model} - + \l {Parsing C++ Files with the Clang Code Model} + {Errors and warnings from the current editor}. + \endif + + \li \uicontrol Compile - Selected output from the compiler. Open the + \uicontrol {Compile Output} pane for more detailed information. + + \li \uicontrol{Debug Information} - Lists debug information packages that might + be missing. + + \if defined(qtcreator) + \li \uicontrol Debugger - Errors encountered while running the + \l{Analyzing Code}{Valgrind code analysis tools}. + \endif + + \li \uicontrol{Debugger Runtime} - Errors encountered when starting \QC. For + example, information about missing DLLs. + + \li \uicontrol Deployment - Errors encountered between building an application + successfully and starting it on a \l{glossary-device}{device}. + + \if defined(qtcreator) + \li \uicontrol {My Tasks} - Entries from a task list file (.tasks) generated + by \l{Showing Task List Files in Issues Pane} + {code scanning and analysis tools}. + + \li \uicontrol Python - Runtime errors and exceptions of Python scripts. + \endif + + \li \uicontrol QML and \uicontrol {QML Analysis} - + \l{JavaScript and QML Error Codes} + {QML and JavaScript syntax errors}. + + \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 + \uicontrol {Filter Tree} + and then select a filter. + + \image qtcreator-build-issues.png + + Right-clicking on a line brings up a context menu with actions that you can + apply to the contents of the line. You can remove a line, copy its contents + to the clipboard, or search the Internet for a solution using the contents + of the line as search criteria. In addition, you can show a version control + annotation view of the line that causes the error message. + + To navigate to the corresponding source code, click an issue or + select \uicontrol {Show in Editor} in the context menu. The entry must contain the + name of the file where the issue was found. + + To view more information about an issue in the \uicontrol {Compile Output} pane, + select \uicontrol {Show Output} in the context menu. + + To jump from one issue to the next or previous one, press \key F6 and + \key Shift+F6. + + \section1 Search Results + + In the \uicontrol{Search Results} pane, you can search through projects, files on + a file system or the currently open files: + + \image qtcreator-search-results.png "Search Results output pane" + + The search results are stored in the search history (1) from which you can + select earlier searches. + + The figure below shows an example search result for all + occurrences of the search string in the specified directory. + + \image qtcreator-searchresults.png + + For more information about the different search options, see + \l {Finding and Replacing}. + + \section1 Application Output + + The \uicontrol{Application Output} pane displays the status of a program when + it is executed, and the debug output. + + \image qtcreator-application-output.png + + \if defined(qtcreator) + If you specify command line arguments in the run settings that are passed + to the application when running it, they are displayed as a part of the + application output. For more information, see + \l{Specifying Run Settings for Desktop Device Types}. + \endif + + Select toolbar buttons to run applications, to attach the debugger to the + running application, and to stop running or debugging. + + To specify settings for displaying application output, select + \uicontrol Tools > \uicontrol Options > \uicontrol {Build & Run} > + \uicontrol General. You can select whether to open the + \uicontrol{Application Output} pane on output when running or debugging + applications, to clear old output on a new run, to word-wrap output, and to + limit output to the specified number of lines. + + \section1 Compile Output + + The \uicontrol{Compile Output} pane provides all output from the compiler. + The \uicontrol{Compile Output} is a more detailed version of information + displayed in the \uicontrol{Issues} pane. + + \image qtcreator-compile-pane.png + + Double-click on a file name in an error message to open the file in the + code editor. + + Select the \uicontrol {Cancel Build} button to cancel the build. + + To specify whether to open the \uicontrol {Compile Output} pane on output + when building applications, select \uicontrol Tools > \uicontrol Options > + \uicontrol {Build & Run} > \uicontrol General, and then select the + \uicontrol {Open Compile Output pane when building} check box. + In the \uicontrol {Limit build output to} field, you can specify the maximum + amount of build output lines to display in the pane. + + \if defined(qtcreator) + \section1 To-Do Entries + + The \uicontrol {To-Do Entries} pane lists the BUG, FIXME, NOTE, TODO, and + WARNING keywords from the current file, from all project files, or from a + subproject. Click the icons on the toolbar to show only the selected + keywords. + + \image qtcreator-todo-pane.png + + To add keywords, select \uicontrol Tools > \uicontrol Options > + \uicontrol {To-Do} > \uicontrol Add. Set an icon and a line background color + for the keyword. + + \image qtcreator-todo-options.png + + To change the icon and line background color of the selected keyword, select + \uicontrol Edit. + + To remove the selected keyword, select \uicontrol Remove. + + To reset the list to predefined keywords, select \uicontrol Reset. All your + changes will be permanently lost. + + To determine whether the keywords in the whole project, in the current file, + or in a subproject are displayed by default, select the appropriate option + in the \uicontrol {Scanning scope} group. + + To exclude files from scanning, select \uicontrol {Project Settings} > + \uicontrol {To-Do} in the + \uicontrol Projects mode. Select \uicontrol Add and enter a regular + expression that matches the path to files to exclude. Use a forward slash + (/) as a separator in the path also on Windows. + + The Todo plugin is disabled by default. To enable the plugin, select + \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities > + \uicontrol Todo and restart + \QC. + + In addition, you can open task list files generated by code scanning and + analysis tools in the \uicontrol Issues pane. For more information, see + \l{Showing Task List Files in Issues Pane}. + \endif + + \section1 Changing Languages + + \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 \uicontrol {Tools > Options > Environment} and select a language + in the \uicontrol Language field. The change takes effect after you restart \QC. + + \section1 Viewing Images + + \QC opens image files in the image viewer. + + \image qtcreator-image-viewer.png "Image viewer" + + Use the toolbar buttons (1) or \l{Keyboard Shortcuts}{keyboard shortcuts} + to: + + \list + + \li Export SVG images to pixmaps + + \li Switch between background and outline modes + + \li Zoom in and out + + \li Fit images to screen + + \li Return to original size + + \li Play and pause animated GIF and MNG images + + \endlist + + \section1 Exporting SVG Images + + If you receive a freely scalable icon in the SVG format from an UI designer, + you can export it to several images of different sizes to create a set of + pixmaps. You can then use QIcon::addPixmap() to add the pixmaps to icons in + different modes and states. +*/ diff --git a/doc/src/qtcreator-toc.qdoc b/doc/src/qtcreator-toc.qdoc index 3f9c7a7df5e..e81215bfb06 100644 --- a/doc/src/qtcreator-toc.qdoc +++ b/doc/src/qtcreator-toc.qdoc @@ -35,6 +35,11 @@ \list \li \l{IDE Overview} \li \l{User Interface} + \list + \li \l{Selecting Modes} + \li \l{Browsing Project Contents} + \li \l{Viewing Output} + \endlist \li \l{Configuring Qt Creator} \li \l{Building and Running an Example} \li \l{Tutorials} diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc index ab3102d3dd7..de5ac269e5b 100644 --- a/doc/src/qtquick/qtquick-designer.qdoc +++ b/doc/src/qtquick/qtquick-designer.qdoc @@ -33,7 +33,7 @@ \contentspage index.html \page creator-using-qt-quick-designer.html \if defined(qtdesignstudio) - \previouspage creator-quick-tour.html + \previouspage creator-modes.html \nextpage {Tutorials} \else \previouspage creator-quick-ui-forms.html