diff options
Diffstat (limited to 'doc/src')
21 files changed, 411 insertions, 184 deletions
diff --git a/doc/src/cmake/creator-projects-cmake-deploying.qdocinc b/doc/src/cmake/creator-projects-cmake-deploying.qdocinc index a5adb5e19e..a9c53ea4e2 100644 --- a/doc/src/cmake/creator-projects-cmake-deploying.qdocinc +++ b/doc/src/cmake/creator-projects-cmake-deploying.qdocinc @@ -34,10 +34,13 @@ \section1 Deploying CMake Projects to Embedded Linux Devices - \QC cannot extract files to be installed from a CMake project, and - therefore, only executable targets are automatically added to deployment - files. You must specify all other files in the \c {QtCreatorDeployment.txt} - file that you create and place in either the root directory of the CMake + \QC cannot directly extract files to be installed from a CMake project. + Therefore, a special deploy step is created that installs the project into + a local directory. The files in that directory are then deployed to the + remote device. + Alternatively, you can provide a \c {QtCreatorDeployment.txt} file in which + you must specify all files to be deployed which are not executables or + libraries. You place this file in either the root directory of the CMake project or the build directory of the active build configuration. Currently, \QC first checks the root directory and only if no \c {QtCreatorDeployment.txt} exists it checks the active build directory. diff --git a/doc/src/cmake/creator-projects-cmake.qdoc b/doc/src/cmake/creator-projects-cmake.qdoc index 2a29cac9c1..585031ded7 100644 --- a/doc/src/cmake/creator-projects-cmake.qdoc +++ b/doc/src/cmake/creator-projects-cmake.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. @@ -43,6 +43,9 @@ native build configurations and workspaces that you can use in the compiler environment of your choice. + You can use CMake from \QC to build applications for the desktop and + Android devices. You can also build single files to test your changes. + \QC automatically detects the CMake executable specified in the \c PATH. You can add paths to other CMake executables and use them in different build and run \l{glossary-buildandrun-kit}{kits}. @@ -109,6 +112,8 @@ \li Code completion + \li Path completion + \li Auto-indentation \li Matching parentheses and quotes diff --git a/doc/src/editors/creator-coding.qdoc b/doc/src/editors/creator-coding.qdoc index b897961996..11990f4618 100644 --- a/doc/src/editors/creator-coding.qdoc +++ b/doc/src/editors/creator-coding.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. @@ -93,10 +93,10 @@ \li \l{Using Language Servers} - The experimental language client provides code completion, - highlighting of the symbol under cursor, and jumping to the symbol - definition for other programming languages besides C++. In addition, - it integrates diagnostics from the language server. + The language client provides code completion, highlighting of the + symbol under cursor, and jumping to the symbol definition for other + programming languages besides C++. In addition, it integrates + diagnostics from the language server. \li \l{Editing MIME Types} diff --git a/doc/src/editors/creator-locator.qdoc b/doc/src/editors/creator-locator.qdoc index 7d8f25dd07..e7c048f6d2 100644 --- a/doc/src/editors/creator-locator.qdoc +++ b/doc/src/editors/creator-locator.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. @@ -99,7 +99,7 @@ \section1 Using Locator Filters The locator enables you to browse not only files, but any items defined by - \b{locator filters}. By default, the locator contains filters for: + \b{locator filters}. The filters that are available depend on the file type: \list @@ -114,11 +114,11 @@ \li Locating bookmarks (\c {b}). For more information, see \l{Using Bookmarks}. - \li Locating class (\c {c}), enum, and function (m) definitions in your - project or anywhere referenced from your project (\c {:}) + \li Locating class (\c {c}), enum, and function (\c {m}) definitions in + your project or anywhere referenced from your project (\c {:}) \endif - \li Locating QML methods (m) + \li Locating QML methods (\c {m}) \li Locating symbols in the current document (\c {.}) diff --git a/doc/src/editors/creator-only/creator-code-pasting.qdoc b/doc/src/editors/creator-only/creator-code-pasting.qdoc index 803a15e64a..b518c8ca3f 100644 --- a/doc/src/editors/creator-only/creator-code-pasting.qdoc +++ b/doc/src/editors/creator-only/creator-code-pasting.qdoc @@ -38,7 +38,6 @@ \list \li \uicontrol {Pastebin.Com} \li \uicontrol {Pastecode.Xyz} - \li \uicontrol {Paste.KDE.Org} \li \uicontrol {Shared network drives} \endlist diff --git a/doc/src/editors/creator-only/creator-language-server.qdoc b/doc/src/editors/creator-only/creator-language-server.qdoc index 4b75aae16e..9dc5d1e84f 100644 --- a/doc/src/editors/creator-only/creator-language-server.qdoc +++ b/doc/src/editors/creator-only/creator-language-server.qdoc @@ -39,8 +39,9 @@ \list \li \l{Completing Code}{Code completion} \li Highlighting the symbol under cursor - \li \l{Moving to Symbol Definition or Declaration} - {Moving to the symbol definition} + \li Navigating in the code by using the \l{Searching with the Locator} + {locator} or \l{Moving to Symbol Definition or Declaration} + {moving to the symbol definition} \li Inspecting code by viewing the document \l{Viewing Defined Types and Symbols}{outline} \li \l{Finding Symbols}{Finding references to symbols} @@ -50,8 +51,10 @@ By providing a client for the language server protocol, \QC can support the above features for several other programming languages besides C++. - However, the experimental client does not support language servers that - require special handling. + However, the client does not support language servers that require special + handling. + + \section1 Adding MIME Types for Language Servers \QC uses the \l{https://www.iana.org/assignments/media-types/media-types.xhtml} {MIME type} of the file to determine which language server to request @@ -62,21 +65,11 @@ only sent to the languge server if they are known to be handled by it. For more information about how \QC uses MIME types, see \l {Editing MIME Types}. - The experimental language service client has been mostly tested with Python. - If problems arise when you try some other language, please select - \uicontrol Help > \uicontrol {Report Bug} to report them in the Qt Bug - Tracker. The reports should include \QC console output with the environment - variable \c {QT_LOGGING_RULES=qtc.languageclient.*=true} set. + \section1 Specifying Settings for Language Clients To use a language server: \list 1 - \li Enable the language server client by selecting \uicontrol Help > - \uicontrol {About Plugins} > \uicontrol {Other Languages} > - \uicontrol {Language Client} (or \uicontrol {Qt Creator} > - \uicontrol {About Plugins} > \uicontrol {Other Languages} > - \uicontrol {Language Client} on \macos). - \li Restart \QC to load the language client plugin. \li Select \uicontrol Tools > \uicontrol Options > \uicontrol {Language Client} (or \uicontrol {Qt Creator} > \uicontrol Preferences > \uicontrol {Language Client} > on @@ -86,15 +79,48 @@ language server. \li Select \uicontrol Add to add language servers. \li In the \uicontrol Name field, enter a name for the language server. + Select the \inlineimage replace.png + (\uicontrol {Variables}) button to use a variable for the server + name. For more information, see \l{Using Qt Creator Variables}. \li In the \uicontrol {Language} field, select \uicontrol {Set MIME Types} to select the MIME types of the files to send to the language server. In the field below, you can enter file patterns to extend the MIME types, separated by semicolons. + \li In the \uicontrol {Startup behavior} field, select whether the + language server is started when \QC starts or when a project or file + with a matching MIME type is opened. The + \uicontrol {General Messages} \l{Viewing Output}{output pane} + displays information about the connection to the language server. + \li In the \uicontrol Capabilities field, you can see the features + that are supported by the language server. Only some of them are + implemented by \QC. \li In the \uicontrol Executable field, enter the path to the language server executable. \li In the \uicontrol Arguments field, enter any required command line + arguments. Select \uicontrol Variables to use variables as arguments. \endlist To remove language servers from the list, select \uicontrol Delete. + + \section1 Supported Locator Filters + + The locator enables you to browse not only files, but any items defined by + \e {locator filters}. The language client plugin supports the following + locator filters: + + \list + \li Locating symbols in the current project (\c {:}) + \li Locating symbols in the current document (\c {.}) + \li Locating class (\c {c}), enum, and function (\c {m}) + definitions in your project + \endlist + + \section1 Reporting Issues + + The language service client has been mostly tested with Python. + If problems arise when you try it or some other language, please select + \uicontrol Help > \uicontrol {Report Bug} to report them in the Qt Bug + Tracker. The reports should include \QC console output with the environment + variable \c {QT_LOGGING_RULES=qtc.languageclient.*=true} set. */ diff --git a/doc/src/howto/creator-help.qdoc b/doc/src/howto/creator-help.qdoc index 51bf69b810..7d8e7908bc 100644 --- a/doc/src/howto/creator-help.qdoc +++ b/doc/src/howto/creator-help.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. @@ -23,12 +23,6 @@ ** ****************************************************************************/ -// ********************************************************************** -// 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 \page creator-help.html @@ -62,7 +56,6 @@ \li To select and configure how the documentation is displayed in the \uicontrol Help mode, select \uicontrol Tools > \uicontrol Options > \uicontrol Help. - \endlist The following image displays the context sensitive help in the \uicontrol Edit @@ -70,6 +63,19 @@ \image qtcreator-context-sensitive-help.png + If the help HTML file does not use a style sheet, you can change the font + family, style, and size in \uicontrol Tools > \uicontrol Options > + \uicontrol Help > \uicontrol General. + + \image qtcreator-help-options.png + + By default, you can use the mouse scroll wheel to zoom help pages. To + disable this feature, deselect the \uicontrol {Enable scroll wheel zooming} + check box. + + To switch to the editor context when you close the last help page, select + the \uicontrol {Return to editor on closing the last page} check box. + \section1 Viewing Function Tooltips To hide function tooltips by default, select \uicontrol {Tools > Options > @@ -127,17 +133,19 @@ \endlist - To import and export bookmarks, select \uicontrol {Tools > Options > Help > - General Settings > Import} or \uicontrol Export. + To import and export bookmarks, select \uicontrol Tools > \uicontrol Options + > \uicontrol Help > \uicontrol General > \uicontrol {Import Bookmarks} or + \uicontrol {Export Bookmarks}. \section2 Full-text Search In the \uicontrol Search pane, you can use full-text search for finding a - particular word in all the installed documents. In the \uicontrol {Search for} - field, enter the term you are looking for, and select the \uicontrol Search - button. All documents that contain the specified term are listed. The list - is sorted by the number of search hits that the documents contain. Select a - document in the list to open it. + particular word in all the installed documents. Enter the term you are + looking for, and select the \uicontrol Search button. All documents that + contain the specified term are listed. The list is sorted by document + version (if you have installed several Qt versions, for example) and + the number of search hits that the documents contain. Select a document in + the list to open it. \image qtcreator-help-search.png "Search pane" @@ -159,12 +167,6 @@ \endlist - For more flexibility, use the \uicontrol {Advanced search}. Specify words to - exclude from the search hits, or search for an exact phrase or for similar - words. For example, searching for \c{QStin}, \c{QSting}, or \c{QStrin} lists - all the documents with titles that are similar, such as \c{QString}. - Combine options to improve the search results. - Full-text search is based on indexing all the installed documents the first time when you open the \uicontrol Search pane. If you add or remove documents, \QC recreates the index. diff --git a/doc/src/howto/creator-keyboard-shortcuts.qdoc b/doc/src/howto/creator-keyboard-shortcuts.qdoc index bf47b2dabf..0d2045b7f4 100644 --- a/doc/src/howto/creator-keyboard-shortcuts.qdoc +++ b/doc/src/howto/creator-keyboard-shortcuts.qdoc @@ -33,7 +33,7 @@ \contentspage index.html \page creator-keyboard-shortcuts.html \if defined(qtdesignstudio) - \previouspage studio-advanced.html + \previouspage studio-platforms.html \nextpage creator-coding.html \else \previouspage creator-cli.html diff --git a/doc/src/howto/creator-only/creator-autotest.qdoc b/doc/src/howto/creator-only/creator-autotest.qdoc index 2058581308..05edde5027 100644 --- a/doc/src/howto/creator-only/creator-autotest.qdoc +++ b/doc/src/howto/creator-only/creator-autotest.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. @@ -31,27 +31,28 @@ \title Running Autotests - \QC integrates the \l{Qt Test} framework and - \l{https://github.com/google/googletest}{Google C++ Testing Framework} for - unit testing applications and libraries. You can use \QC to build and run - Qt tests, Qt Quick tests (QML-based Qt tests), and Google tests for your - projects. + \QC integrates the \l{Qt Test} framework, + \l{https://github.com/google/googletest}{Google C++ Testing Framework}, and + \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} + {Boost.Test} for unit testing applications and libraries. You can use \QC to + create, build, and run Qt tests, Qt Quick tests (QML-based Qt tests), Google + tests, and Boost tests for your projects. \image qtcreator-autotests.png \section1 Creating Tests - You can use a wizard to create projects that contain Qt or Google tests. + You can use a wizard to create projects that contain tests. - \section2 Creating Qt Tests + \section2 Creating Qt and Qt Quick Tests - To create a Qt test: + To create a Qt or Qt Quick test: \list 1 \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol {Other Project} > \uicontrol {Auto Test Project} > \uicontrol Choose to create a project with boilerplate code for a - Qt test. + Qt test or a Qt Quick test. \li In the \uicontrol {Project and Test Information} dialog, specify settings for the project and test: @@ -59,17 +60,17 @@ \list 1 \li In the \uicontrol {Test framework} field, select - \uicontrol {Qt Test}. + \uicontrol {Qt Test} or \uicontrol {Qt Quick Test}. - \li Select the \uicontrol {GUI Application} check box to create - a Qt application. + \li For a Qt test, select the \uicontrol {GUI Application} check + box to create a Qt application. \li In the \uicontrol {Test case name} field, enter a name for the test case. - \li Select the \uicontrol {Requires QApplication} check box to - add the include statement for QApplication to the main.cpp - file of the project. + \li For a Qt test, select the \uicontrol {Requires \QApplication} + check box to add the include statement for QApplication to + the main.cpp file of the project. \li Select the \uicontrol {Generate initialization and cleanup code} checkbox to add functions to your test that are @@ -106,12 +107,12 @@ \li In the \uicontrol {Test framework} field, select \uicontrol {Google Test}. + \li In the \uicontrol {Test suite name} field, enter a name for + the test suite. + \li In the \uicontrol {Test case name} field, enter a name for the test case. - \li In the \uicontrol {Test set name} field, enter a name for - the test set. - \li Select the \uicontrol {Enable C++ 11} check box to support C++ 11 features in the test. @@ -135,6 +136,46 @@ \l{https://github.com/google/googletest/blob/master/googletest/docs/primer.md} {Google Test Primer}. + \section2 Creating Boost Tests + + To build and run Boost tests, you must have the Boost.Test installed on the + development host. Typically, it is installed when you install Boost. You can + download Boost from \l{https://www.boost.org/}{Boost.org}. + + If Boost libraries can be found by the used compiler and build system, you + do not need to specify the include directory when creating the test. + + To create a Boost test: + + \list 1 + \li Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol {Other Project} > \uicontrol {Auto Test Project} > + \uicontrol Choose to create a project with boilerplate code for a + Boost test. + \li In the \uicontrol {Project and Test Information} dialog, specify + settings for the project and test: + \list 1 + \li In the \uicontrol {Test framework} field, select + \uicontrol {Boost Test}. + \li In the \uicontrol {Test suite name} field, enter a name for + the test suite. + \li In the \uicontrol {Test case name} field, enter a name for + the test case. + \li In the \uicontrol {Boost include dir (optional)} field, + enter the path to the directory that contains files needed + by Boost.Test, such as \e version.hpp and a subfolder called + \e test that contains the test header files. + \li In the \uicontrol {Build system} field, select the build + system to use for building the project: qmake, CMake, or + Qbs. + \endlist + \endlist + + \QC creates the test in the specified project directory. + For more information about creating Boost tests, see + \l{https://www.boost.org/doc/libs/1_70_0/libs/test/doc/html/index.html} + {Boost.Test}. + \section1 Setting Up the Google C++ Testing Framework To build and run Google tests, you must have the Google C++ Testing @@ -240,11 +281,6 @@ \image qtcreator-autotests-options.png - You can add filters to specify the directories within the current project - to scan for tests. Select the \uicontrol {Global Filters} check box, and - then select \uicontrol Add to specify paths to the directories to scan for - tests. Wildcards are not supported in the filter expressions. - In some special setups, \QC cannot deduce which executable or run configuration it should use. If \QC repeatedly asks you to select the tests to run when trying to execute tests, you can enable it to cache @@ -315,6 +351,30 @@ failures into C++ exceptions, select the \uicontrol {Throw on failure} check box. + \section2 Specifying Settings for Running Boost Tests + + \list 1 + \li To specify settings for running Boost tests, select \uicontrol Tools + > \uicontrol Options > \uicontrol {Testing} > + \uicontrol {Boost Test}. + \image qtcreator-autotests-options-boost.png + \li In the \uicontrol {Log format} field, select the error report + format to specify the type of events you want recorded in the + test report. + \li In the \uicontrol {Report level} field, select the verbosity level + of the test result report. Select \uicontrol No if you do not want + a report. + \li Select the \uicontrol Randomize check box to execute the tests in + a random order, using the seed specified in the \uicontrol Seed + field for initializing the randomizer. + \li Select the \uicontrol {Catch system errors} check box to catch + system errors. + \li Select the \uicontrol {Floating point exceptions} check box to + detect floating point exceptions. + \li Select the \uicontrol {Detect memory leaks} check box to detect + memory leaks. + \endlist + \section1 Viewing Test Output The test results are displayed in the \uicontrol {Test Results} output pane diff --git a/doc/src/howto/creator-sidebar-views.qdoc b/doc/src/howto/creator-sidebar-views.qdoc index bda32acb6a..9140af5f35 100644 --- a/doc/src/howto/creator-sidebar-views.qdoc +++ b/doc/src/howto/creator-sidebar-views.qdoc @@ -159,6 +159,10 @@ \li To see the absolute path of a file, move the mouse pointer over the file name. + \li To move files from one project to another, drag-and-drop them + in the project tree. \QC makes the necessary changes to project + configuration files. + \endlist \if defined(qtcreator) @@ -188,7 +192,10 @@ \li Expand or collapse the tree view to show or hide all files and folders. \li Close all files in a project. - \li Close projects. + \li Close projects. By default, all files in the project are also + closed. To keep them open, deselect the \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol General + > \uicontrol {Close source files along with project} check box. \endlist For managing files and directories, the same functions are available as in @@ -264,6 +271,22 @@ \endlist + \section1 Viewing Open Documents + + To see a list of open documents, switch to the \uicontrol {Open Documents} + view. You can use the context-menu to perform some of the functions also + available in the \uicontrol File menu and in the context menu in the + \uicontrol {File System} view. + + In addition, you can: + + \list + \li Copy the full path of the file or just the filename to the + clipboard. + \li Pin files to ensure they stay at the top of the list and are not + closed when \uicontrol {Close All} is used. + \endlist + \section1 Viewing Defined Types and Symbols The \uicontrol Outline view shows an overview of defined types and other diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index f91302ad0c..314abee874 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -110,6 +110,46 @@ documentation, see \l{Tips and Tricks}. \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 > \uicontrol Options > + \uicontrol 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 Platform Notes This section describes the cases where the behavior of \QC depends on the @@ -296,7 +336,7 @@ \title Viewing Output - \image qtcreator-task-pane.png + \image qtcreator-general-messages.png "General Messages output pane" The task pane in \QC can display one of the following panes: @@ -334,6 +374,9 @@ 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 filter the output, enter a string in the \uicontrol Filter field. + Filtering is not supported in all output panes. + To open the \uicontrol{General Messages} and \if defined(qtcreator) \l{Using Version Control Systems}{Version Control} @@ -404,7 +447,7 @@ \uicontrol {Filter Tree} and then select a filter. - \image qtcreator-build-issues.png + \image qtcreator-issues.png "Issues output pane" 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 @@ -422,6 +465,11 @@ To jump from one issue to the next or previous one, press \key F6 and \key Shift+F6. + By default, the \uicontrol Issues pane is cleared on a new build. To keep + the issues from the previous build rounds, deselect \uicontrol Tools > + \uicontrol Options > \uicontrol {Build & Run} > \uicontrol General > + \uicontrol {Clear issues list on new build}. + \section1 Search Results In the \uicontrol{Search Results} pane, you can search through projects, files on @@ -459,10 +507,10 @@ 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. + \uicontrol Application Output, or click the \uicontrol {Open Settings Page} + button. 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 @@ -470,7 +518,7 @@ The \uicontrol{Compile Output} is a more detailed version of information displayed in the \uicontrol{Issues} pane. - \image qtcreator-compile-pane.png + \image qtcreator-compile-output.png "Compile Output pane" Double-click on a file name in an error message to open the file in the code editor. @@ -479,11 +527,46 @@ 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 + \uicontrol {Build & Run} > \uicontrol Compile Output, and then select the + \uicontrol {Open pane when building} check box. + In the \uicontrol {Limit output to} field, you can specify the maximum amount of build output lines to display in the pane. + You can also reach the options page by clicking the \uicontrol {Open Settings Page} + button. + + To copy the output from the pane to the clipboard, select + \uicontrol {Select All} in the context menu, and then select + \uicontrol Copy. Save the output as a file if you want to + examine it later without having to build the project again. + This is useful for large projects that take a long time to build. + + \section2 Parsing Existing Compile Output + + You can use \QC's output parsers to parse output from builds done outside + of \QC or stored from previous build runs. By default, the parsers from the + kit selected for the active project are used, but you can select another + kit. + + To parse compile output: + + \list 1 + \li Select \uicontrol Tools > \uicontrol {Parse Build Output}. + \image qtcreator-parse-build-output.png + \li Paste the build output in the \uicontrol {Build Output} field, or + select \uicontrol {Load from File} to load it from a file. + \li Deselect the \uicontrol {Output went to stderr} check box if the + parser expects issues on \c stdout. + \li In the \uicontrol {Use parsers from kit} field, select the kit to + use for parsing the output. Select \uicontrol Manage to view + and modify kit settings. + \li The parser displays the parsed output in the \uicontrol Issues + pane. By default, the pane is cleared before adding the new output. + Deselect the \uicontrol {Clear existing tasks} check box to append + the new output to the old output. + \li Select \uicontrol OK to start parsing. + \endlist + \if defined(qtcreator) \section1 To-Do Entries @@ -528,42 +611,4 @@ \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/overview/creator-acknowledgements.qdoc b/doc/src/overview/creator-acknowledgements.qdoc index e7fdc6765e..43bac0ad4c 100644 --- a/doc/src/overview/creator-acknowledgements.qdoc +++ b/doc/src/overview/creator-acknowledgements.qdoc @@ -168,7 +168,7 @@ The source code of ANGLE is part of the Qt libraries. For more information about the licenses used in Qt GUI, see - \l{https://doc.qt.io/qt-5.9/licenses-used-in-qt.html#qt-gui}{Qt GUI}. + \l{https://doc.qt.io/qt-5.11/licenses-used-in-qt.html#qt-gui}{Qt GUI}. \l{https://spdx.org/licenses/BSD-3-Clause.html} {BSD 3-clause "New" or "Revised" License} diff --git a/doc/src/overview/creator-only/creator-overview.qdoc b/doc/src/overview/creator-only/creator-overview.qdoc index 1f6f31936d..09ef2766e4 100644 --- a/doc/src/overview/creator-only/creator-overview.qdoc +++ b/doc/src/overview/creator-only/creator-overview.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. @@ -79,10 +79,9 @@ languages as code, not just as plain text. This enables it to provide you with useful features, such as semantic highlighting, checking code syntax, code completion, and refactoring actions. - In addition, the experimental language server plugin provides - some of these services for other programming languages, such as - Python, for which a \e {language server} is available that - provides information about the code to IDEs. + \QC supports some of these services also for other programming + languages, such as Python, for which a \e {language server} is + available that provides information about the code to IDEs. For more information, see \l{Coding}. \row \li \inlineimage creator_buildingrunning.png @@ -117,9 +116,9 @@ execution. In addition, the QML Profiler enables you to profile Qt Quick applications. - \QC is integrated to the \l{Qt Test} and Google C++ Testing - frameworks for unit testing applications and libraries. You can - use \QC to build and run autotests. + \QC is integrated to the \l{Qt Test}, Google C++ Testing, and + Boost.Test frameworks for unit testing applications and + libraries. You can use \QC to create, build, and run autotests. For more information, see \l{Testing}. \li \b {Publishing} diff --git a/doc/src/overview/creator-only/creator-testing.qdoc b/doc/src/overview/creator-only/creator-testing.qdoc index 39bae4ba17..10df1d7f31 100644 --- a/doc/src/overview/creator-only/creator-testing.qdoc +++ b/doc/src/overview/creator-only/creator-testing.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. @@ -60,9 +60,8 @@ \li \l{Running Autotests} - You can build and run Qt tests, Qt Quick tests, and Google tests - using \QC. In addition, you can use a wizard to create projects that - contain Qt or Google tests. + You can create, build and run Qt tests, Qt Quick tests, Google + tests, and Boost tests using \QC. \endlist diff --git a/doc/src/projects/creator-only/creator-projects-building.qdoc b/doc/src/projects/creator-only/creator-projects-building.qdoc index c5a9ae001e..740096f0cf 100644 --- a/doc/src/projects/creator-only/creator-projects-building.qdoc +++ b/doc/src/projects/creator-only/creator-projects-building.qdoc @@ -79,8 +79,9 @@ subproject. To remove all build artifacts, select \uicontrol Build > \uicontrol {Clean All} or - \uicontrol {Clean Project}. To clean the build directory and then build the - project, select \uicontrol Build > \uicontrol {Rebuild All} or \uicontrol {Rebuild Project}. + \uicontrol {Clean Project}. To clean the build directory, run qmake, and + then build the project, select \uicontrol Build > \uicontrol {Rebuild All} + or \uicontrol {Rebuild Project}. To build and clean projects without dependencies, select the \uicontrol {Build Without Dependencies}, @@ -88,6 +89,10 @@ \uicontrol {Clean Without Dependencies} options in the context menu in the \uicontrol Projects view. - To run qmake to generate new Makefiles, select \uicontrol Build > \uicontrol qmake. - + To run qmake to generate new Makefiles, select \uicontrol Build > + \uicontrol qmake. To prevent failures on incremental builds, it might make + sense to always run qmake before building, even though it means that + building will take more time. To enable this option, select \uicontrol Tools + > \uicontrol Options > \uicontrol {Build & Run} > \uicontrol qmake > + \uicontrol {Run qmake on every build}. */ diff --git a/doc/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/src/projects/creator-only/creator-projects-compilers.qdoc index 5387e4c680..b91d5b7d9e 100644 --- a/doc/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/src/projects/creator-only/creator-projects-compilers.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. @@ -44,7 +44,12 @@ for and running it on a particular platform. \QC automatically detects the compilers that are registered by your system - or by an installer. You can add compilers to build applications by using other + or by an installer and lists them in \uicontrol Tools > \uicontrol Options > + \uicontrol Kits > \uicontrol Compilers: + + \image qtcreator-toolchains.png + + You can add the following compilers to build applications by using other compilers or by using additional versions of the automatically detected compilers: @@ -74,6 +79,40 @@ \endlist + In addition, the \QC Bare Metal Device plugin provides support for the + following compilers: + + \list + + \li \l{https://www.iar.com/iar-embedded-workbench/}{IAREW} is a group of + C and C++ bare-metal compilers from the various IAR Embedded Workbench + development environments. + \note Currently supported architectures are \c 8051, \c AVR, and \c ARM. + + \li \l{https://www.keil.com}{KEIL} is a group of C and C++ bare-metal + compilers from the various KEIL development environments. + \note Currently supported architectures are \c 8051 and \c ARM. + + \li \l{https://sdcc.sourceforge.net}{SDCC} is a retargetable, optimizing + C bare-metal compiler for various architectures. + \note Currently supported architecture is \c 8051. + + \endlist + + \section1 Redetecting Compilers + + When \QC finds an x86_64 GCC compiler, it sets up an instance for the native + x86_64 target. If you plan to create also 32-bit x86 binaries without using + a dedicated cross-compiler, select \uicontrol {Auto-detection Settings} > + \uicontrol {Detect x86_64 GCC compilers as x86_64 and x86}. Then select + \uicontrol Re-detect to refresh the list of automatically detected + compilers. + + To remove manually added compilers, select \uicontrol Remove or + \uicontrol {Remove All}. + + \section1 Specifying Compiler Settings + To build an application using GCC, MinGW, Clang, or QCC, specify the path to the directory where the compiler is located and select the application binary interface (ABI) version from the list of available @@ -98,8 +137,6 @@ then select a compiler in the list, and then select \uicontrol C or \uicontrol C++ to add a C or C++ compiler. - \image qtcreator-toolchains.png - To clone the selected compiler, select \uicontrol Clone. \li In the \uicontrol Name field, enter a name for the compiler to diff --git a/doc/src/projects/creator-only/creator-projects-creating.qdoc b/doc/src/projects/creator-only/creator-projects-creating.qdoc index 43b2e39f70..37b3224cd6 100644 --- a/doc/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/src/projects/creator-only/creator-projects-creating.qdoc @@ -472,8 +472,10 @@ and the subproject that you add as a value of the \l{Variables#subdirs} {SUBDIRS variable}. It also adds all the necessary files for the subproject. - To add more subprojects, right-click the project name in the \uicontrol Projects - pane, and select \uicontrol {New Subproject} in the context menu. + To create more subprojects, right-click the project name in the + \uicontrol Projects pane, and select \uicontrol {New Subproject} in the + context menu. To add an existing project as a subproject, select + \uicontrol {Add Existing Projects}. To remove subprojects, right-click the project name in the \uicontrol Projects pane, and select \uicontrol {Remove Subproject} in the context menu. diff --git a/doc/src/projects/creator-only/creator-projects-custom-wizards-json.qdoc b/doc/src/projects/creator-only/creator-projects-custom-wizards-json.qdoc index c6dc6a24b4..80fcdaa832 100644 --- a/doc/src/projects/creator-only/creator-projects-custom-wizards-json.qdoc +++ b/doc/src/projects/creator-only/creator-projects-custom-wizards-json.qdoc @@ -98,15 +98,22 @@ \section1 Using Variables in Wizards - You can use variables (\c {%\{<variableName>\}}) in the configuration and - template source files. A set of variables is predefined by the wizards and - their pages. You can introduce new variables as shortcuts to be used later. - Define the variable key names and values in the \c options section in the + You can use variables (\c {%\{<variableName>\}}) in strings in the JSON configuration + file and in template source files. + A set of variables is predefined by the wizards and their pages. + You can introduce new variables as shortcuts to be used later by + defining the variable key names and values in the \c options section in the \c {wizard.json} file. - The variables always return strings. In places where a boolean value is - expected and a string is given, an empty string as well as the string - \c {"false"} is treated as \c false and anything else as \c true. + There is a special variable \c {%\{JS:<JavaScript expression>\}} which evaluates the given + JavaScript expression and converts the resulting JavaScript value to a string. + In the JavaScript expression you can refer to variables defined by the wizard with + \c {value('<variableName>')}. The returned JavaScript object has the type that the value + of the variable has, which can be a string, list, dictionary or boolean. + + In places where a boolean value is expected and a string is given, + an empty string as well as the string \c {"false"} is treated as + \c false and anything else as \c true. \section1 Localizing Wizards @@ -221,7 +228,7 @@ "trDisplayName": "C++ Class", "trDisplayCategory": "C++", "icon": "../../global/genericfilewizard.png", - "enabled": "%{JS: [ %{Plugins} ].indexOf('CppEditor') >= 0}", + "enabled": "%{JS: value('Plugins').indexOf('CppEditor') >= 0}", \endcode \list @@ -295,11 +302,11 @@ { "key": "TargetPath", "value": "%{Path}" }, { "key": "HdrPath", "value": "%{Path}/%{HdrFileName}" }, { "key": "SrcPath", "value": "%{Path}/%{SrcFileName}" }, - { "key": "CN", "value": "%{JS: Cpp.className('%{Class}')}" }, - { "key": "Base", "value": "%{JS: ( '%{BaseCB}' === '' ) ? '%{BaseEdit}' : '%{BaseCB}'}" }, - { "key": "isQObject", "value": "%{JS: ('%{Base}' === 'QObject' || '%{Base}' === 'QWidget' || '%{Base}' === 'QMainWindow' || '%{Base}' === 'QDeclarativeItem' || '%{Base}' === 'QQuickItem' ) ? 'yes' : ''}" }, - { "key": "GUARD", "value": "%{JS: Cpp.classToHeaderGuard('%{Class}', '%{JS: Util.preferredSuffix('text/x-c++hdr')}')}" }, - { "key": "SharedDataInit", "value": "%{JS: ('%{IncludeQSharedData}') ? 'data(new %{CN}Data)' : '' }" } + { "key": "CN", "value": "%{JS: Cpp.className(value('Class'))}" }, + { "key": "Base", "value": "%{JS: value('BaseCB') === '' ? value('BaseEdit') : value('BaseCB')}" }, + { "key": "isQObject", "value": "%{JS: (value('Base') === 'QObject' || value('Base') === 'QWidget' || value('Base') === 'QMainWindow' || value('Base') === 'QDeclarativeItem' || value('Base') === 'QQuickItem' ) ? 'true' : 'false'}" }, + { "key": "GUARD", "value": "%{JS: Cpp.classToHeaderGuard(value('Class'), Util.suffix(value('HdrFileName'))}" }, + { "key": "SharedDataInit", "value": "%{JS: value('IncludeQSharedData') ? 'data(new %{CN}Data)' : '' }" } ], \endcode @@ -712,7 +719,7 @@ { "checkedValue": "QObject", "uncheckedValue": "", - "checked": "%{JS: ('%{BaseCB}' === 'QObject' ) ? 'yes' : ''}" + "checked": "%{JS: value('BaseCB') === 'QObject' ? 'true' : 'false'}" } }, \endcode @@ -788,7 +795,7 @@ "name": "LabelQQC_2_0", "type": "Label", "span": true, - "visible": "%{( '%{CS}' === 'QQC_2_0' )}", + "visible": "%{JS: value('CS') === 'QQC_2_0'}", "data": { "wordWrap": true, @@ -819,7 +826,7 @@ { "name": "BaseEdit", "type": "LineEdit", - "enabled": "%{JS: ( '%{BaseCB}' === '' ) ? 'yes' : ''}", + "enabled": "%{JS: value('BaseCB') === '' ? 'true' : 'false'}", "mandatory": false, "data": { @@ -981,9 +988,6 @@ as the top level directory. This setting defaults to an empty list and no subdirectories will be scanned. - \li \c firstProjectOnly is a boolean value, which will determine whether - all project files that were found will be opened as a project or - only the first one. This setting defaults to \c true. \endlist */ diff --git a/doc/src/projects/creator-only/creator-projects-opening.qdoc b/doc/src/projects/creator-only/creator-projects-opening.qdoc index 6298c896b5..3848979150 100644 --- a/doc/src/projects/creator-only/creator-projects-opening.qdoc +++ b/doc/src/projects/creator-only/creator-projects-opening.qdoc @@ -59,8 +59,8 @@ \uicontrol Options > \uicontrol Kits. Qt for Python projects rely on the \l{Using Language Servers} - {experimental language server client} for code completion, - highlighting, and other useful features. + {language server client} for code completion, highlighting, and + other useful features. If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit}, it starts out diff --git a/doc/src/projects/creator-only/creator-projects-targets.qdoc b/doc/src/projects/creator-only/creator-projects-targets.qdoc index 1d6101b02f..6438abc42b 100644 --- a/doc/src/projects/creator-only/creator-projects-targets.qdoc +++ b/doc/src/projects/creator-only/creator-projects-targets.qdoc @@ -73,6 +73,21 @@ \endlist + \section1 Filtering Kit Settings + + Typically, only a subset of the kit settings is relevant for a particular + setup. Therefore, \QC plugins register sets of relevant settings that you + can view and modify in \uicontrol Tools > \uicontrol Options > + \uicontrol Kits >. For example, if you use CMake to build all your projects, + you can hide Qbs and qmake settings by default. + + To hide and show settings in the \uicontrol Kits tab for the + current kit, select \uicontrol {Settings Filter}. To view and + modify the settings displayed when you add a new kit, select + \uicontrol {Default Settings Filter}. + + \section1 Specifying Kit Settings + To add kits: \list 1 @@ -105,13 +120,13 @@ \li In the \uicontrol Device field, select a device. - \li In the \uicontrol {Emulator skin} field, select the skin to use for - the \l {Emulator}{Boot2Qt Emulator Device}. - \li In the \uicontrol Sysroot field, specify the directory where the device image is located. If you are not cross-compiling, leave this field empty. + \li In the \uicontrol {Emulator skin} field, select the skin to use for + the \l {Emulator}{Boot2Qt Emulator Device}. + \li In the \uicontrol {Compiler} field, select the C or C++ compiler that you use to build the project. You can add compilers to the list if they are installed on the development PC, but were not detected @@ -153,6 +168,10 @@ configuration that should be used by qmake. If you leave this field empty, the default mkspec of the selected Qt version is used. + \li In the \uicontrol {Additional Qbs profile settings} field, select + \uicontrol Change to add settings to Qbs build profiles. For more + information, see \l {Editing Qbs Profiles}. + \li In the \uicontrol {CMake Tool} field, select the CMake tool to use for building the project. Select \uicontrol Manage to add installed CMake tools to the list. For more information, see @@ -169,10 +188,6 @@ \uicontrol Change to edit the variables of the CMake configuration for the kit. - \li In the \uicontrol {Additional Qbs profile settings} field, select - \uicontrol Change to add settings to Qbs build profiles. For more - information, see \l {Editing Qbs Profiles}. - \endlist \QC uses the \e {default kit} if it does not have enough information to @@ -194,16 +209,18 @@ \list 1 \li Select \uicontrol Change next to the - \uicontrol {Additional Qbs Profile Settings} field. + \uicontrol {Additional Qbs Profile Settings} field to open the + \uicontrol {Custom Properties} dialog. \image qtcreator-qbs-profile-settings. - \li Select \uicontrol Add. + \li Double-click an empty cell in the \uicontrol Key column to specify + the key to add or modify as: \c <module_name>.<property_name>. - \li In the \uicontrol Key column, spefify the key to add or modify as: - \c <module_name>.<property_name>. + \li Double-click the cell on the same row in the \uicontrol Value column + to specify a value as a JSON literal. - \li In the \uicontrol Value column, specify a value as a JSON literal. + \li Select \uicontrol Add to add the key-value pair. \li Click \uicontrol OK. diff --git a/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc b/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc index 174b6c3c93..9e1fe9919e 100644 --- a/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc +++ b/doc/src/qtquick/qtquick-from-qmlproject-to-pro.qdoc @@ -99,8 +99,9 @@ \quotefromfile progressbar/main.cpp \skipto QQuickView view; \printuntil view.show() - Where \c {qml\main.qml} is the path to and the name of the main QML - file in the Qt Quick UI project. + Where \c {qrc:/qml/imports} is the import path and + \c {qrc:qml/ProgressBar.ui.qml} is the path to and the + name of the main QML file in the Qt Quick UI project. \li Select \uicontrol Build > \uicontrol Run to build and run your project. \endlist |