diff options
Diffstat (limited to 'doc')
33 files changed, 259 insertions, 80 deletions
diff --git a/doc/images/icons/download-icon.png b/doc/images/icons/download-icon.png Binary files differnew file mode 100644 index 0000000000..59de1e81e9 --- /dev/null +++ b/doc/images/icons/download-icon.png diff --git a/doc/images/qtcreator-android-build-steps.png b/doc/images/qtcreator-android-build-steps.png Binary files differnew file mode 100644 index 0000000000..dda97e83cc --- /dev/null +++ b/doc/images/qtcreator-android-build-steps.png diff --git a/doc/images/qtcreator-android-certificate.png b/doc/images/qtcreator-android-certificate.png Binary files differindex 2b4d235549..1798a91eb7 100644 --- a/doc/images/qtcreator-android-certificate.png +++ b/doc/images/qtcreator-android-certificate.png diff --git a/doc/images/qtcreator-android-cmake-settings.png b/doc/images/qtcreator-android-cmake-settings.png Binary files differnew file mode 100644 index 0000000000..6776e4fcba --- /dev/null +++ b/doc/images/qtcreator-android-cmake-settings.png diff --git a/doc/images/qtcreator-android-deploy-configurations.png b/doc/images/qtcreator-android-deploy-configurations.png Binary files differindex b09cbce6de..c4602a8538 100644 --- a/doc/images/qtcreator-android-deploy-configurations.png +++ b/doc/images/qtcreator-android-deploy-configurations.png diff --git a/doc/images/qtcreator-android-manifest-editor.png b/doc/images/qtcreator-android-manifest-editor.png Binary files differindex 90fdb6a42b..67424baae3 100644 --- a/doc/images/qtcreator-android-manifest-editor.png +++ b/doc/images/qtcreator-android-manifest-editor.png diff --git a/doc/images/qtcreator-git-commit-actions.png b/doc/images/qtcreator-git-commit-actions.png Binary files differnew file mode 100644 index 0000000000..37295e48fc --- /dev/null +++ b/doc/images/qtcreator-git-commit-actions.png diff --git a/doc/images/qtcreator-options-android1.png b/doc/images/qtcreator-options-android1.png Binary files differindex b3806a361d..81a94cb5e4 100644 --- a/doc/images/qtcreator-options-android1.png +++ b/doc/images/qtcreator-options-android1.png diff --git a/doc/images/qtcreator-options-android2.png b/doc/images/qtcreator-options-android2.png Binary files differindex 176b2cd3a1..5289c4b1b0 100644 --- a/doc/images/qtcreator-options-android2.png +++ b/doc/images/qtcreator-options-android2.png diff --git a/doc/images/qtcreator-vcs-gitbranch.png b/doc/images/qtcreator-vcs-gitbranch.png Binary files differindex aae80201bc..f6a5586eac 100644 --- a/doc/images/qtcreator-vcs-gitbranch.png +++ b/doc/images/qtcreator-vcs-gitbranch.png diff --git a/doc/images/studio-curve-editor.png b/doc/images/studio-curve-editor.png Binary files differindex f1f82e0abe..cdb675c881 100644 --- a/doc/images/studio-curve-editor.png +++ b/doc/images/studio-curve-editor.png diff --git a/doc/images/studio-curve-picker.png b/doc/images/studio-curve-picker.png Binary files differdeleted file mode 100644 index 37f1af0a39..0000000000 --- a/doc/images/studio-curve-picker.png +++ /dev/null diff --git a/doc/images/studio-easing-curve-editor.png b/doc/images/studio-easing-curve-editor.png Binary files differnew file mode 100644 index 0000000000..57d70f86cd --- /dev/null +++ b/doc/images/studio-easing-curve-editor.png diff --git a/doc/images/studio-edit-keyframe.png b/doc/images/studio-edit-keyframe.png Binary files differnew file mode 100644 index 0000000000..446187d141 --- /dev/null +++ b/doc/images/studio-edit-keyframe.png diff --git a/doc/src/android/androiddev.qdoc b/doc/src/android/androiddev.qdoc index ac2a77a3fe..00737d5ef2 100644 --- a/doc/src/android/androiddev.qdoc +++ b/doc/src/android/androiddev.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. @@ -66,10 +66,10 @@ \note Android SDK Tools have issues with JDK versions later than 8. \li \l{http://www.gradle.org}{Gradle} for building application packages - for Android devices (APK). Gradle is delivered with Qt 5.9, and - later. Because Gradle scripts are not delivered with Android SDK - Tools since version 26.0.0, they are delivered with Qt 5.9 and - 5.6.3. + (APK) and app bundles (AAB) for Android devices. Gradle is delivered + with Qt 5.9, and later. Because Gradle scripts are not delivered + with Android SDK tools since version 26.0.0, they are delivered + with Qt 5.9 and 5.6.3. \note Using Ant to build APKs is no longer supported. @@ -77,6 +77,9 @@ by the \l{http://developer.android.com/tools/sdk/ndk/index.html} {Android NDK} from Google. + \note To develop with Qt 5.14.0 or later, you need Android NDK r20 + or later. + \li \l{http://developer.android.com/sdk/index.html}{Android SDK Tools} The following Android SDK packages and tools are required for @@ -167,7 +170,7 @@ \li In the \uicontrol {JDK location} field, add the path to the JDK. - You can use the \inlineimage download.png + Select the \inlineimage icons/download-icon.png (\uicontrol Download) button to go to the site where you can download the JDK. \QC checks the JDK installation and reports errors. @@ -175,9 +178,8 @@ \li In the \uicontrol {Android Settings} group, add paths to the Android NDK and SDK. - You can use the \inlineimage download.png - (\uicontrol Download) buttons to go to the sites where you can download - the Android NDK and SDK. + Select \inlineimage icons/download-icon.png + to go to the sites where you can download the Android NDK and SDK. The SDK Manager checks the Android NDK and SDK installations, reports errors, and offers to install the necessary packages. @@ -192,7 +194,8 @@ \li Select \uicontrol File > \uicontrol {New File or Project} > \uicontrol Application > \uicontrol {Qt Quick Application} > \uicontrol Choose, and - follow the instructions of the wizard. For more information, see + follow the instructions of the wizard to create a project. For more + information, see \if defined(qtcreator) \l{Creating Qt Quick Projects}. \else diff --git a/doc/src/android/deploying-android.qdoc b/doc/src/android/deploying-android.qdoc index 998cc7f210..7690b435a6 100644 --- a/doc/src/android/deploying-android.qdoc +++ b/doc/src/android/deploying-android.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. @@ -32,9 +32,19 @@ \title Deploying Applications to Android Devices - On Android, applications are distributed in a specially structured type of - ZIP package called an APK. \QC supports the following methods of deployment - for Android applications: + On Android, applications are distributed in specially structured types of + ZIP packages called Application Packages (APK) or Android App Bundles (AAB). + APK files can be downloaded to and executed on a device, whereas AAB is + intended to be interpreted by the Google Play store and is used to generate + APK files. + + \l{Qt for Android} has binaries for armv7a, arm64-v8a, x86, and x86-64. + To support several different ABIs in your application, build an AAB that + contains binaries for each of the ABIs. The Google Play store uses the + AAB to generate optimized APK packages for the devices issuing the download + request and automatically signs them with your publisher key. + + \QC supports the following methods of deployment for Android applications: \list @@ -44,6 +54,9 @@ The Ministro tool downloads the necessary Qt libraries from a repository of your choice. + \li Since Qt 5.14.0, as an app bundle (AAB), intended for distribution + in the Google Play store. + \endlist To specify settings for application packages, select \uicontrol Projects > @@ -137,6 +150,23 @@ the \uicontrol {Compile Output} pane. To view additional information, select the \uicontrol {Verbose output} check box. + \section3 Building AABs + + For testing the application locally, use the APK format, because + the package can be uploaded directly to the device and run. For + distribution to the Google Play store, create an AAB by selecting + the \uicontrol {Build .aab (Android App Bundle)} check box. + + When building with CMake, you can select the ABIs to build the application + for in the \uicontrol CMake settings: + + \image qtcreator-android-cmake-settings.png "CMake settings for building AABs" + + When building with qmake, you can select the ABIs in the \uicontrol ABIs + field in the \uicontrol {Build Steps}: + + \image qtcreator-android-build-steps.png "Android Build Steps" + \section3 Selecting API Level In the \uicontrol {Android build SDK} field, you can select the API level to use diff --git a/doc/src/debugger/creator-debugger-common.qdocinc b/doc/src/debugger/creator-debugger-common.qdocinc index 5437b0d2a5..e5366aa968 100644 --- a/doc/src/debugger/creator-debugger-common.qdocinc +++ b/doc/src/debugger/creator-debugger-common.qdocinc @@ -398,7 +398,7 @@ entry. You can enable tooltips in the main editor displaying this information. - For more information, see \l{Showing Tooltips in Debug Mode}. + For more information, see \l{See the value of variables in tooltips while debugging}. //! [debugger-qt-basic-objects] */ diff --git a/doc/src/howto/creator-only/creator-tips.qdoc b/doc/src/howto/creator-only/creator-how-tos.qdoc index 5e481b42f2..d210b00618 100644 --- a/doc/src/howto/creator-only/creator-tips.qdoc +++ b/doc/src/howto/creator-only/creator-how-tos.qdoc @@ -32,12 +32,41 @@ /*! \contentspage index.html \previouspage creator-faq.html - \page creator-tips.html + \page creator-how-tos.html \nextpage creator-known-issues.html - \title Tips and Tricks + \title How-tos - \section1 Switching Between Modes + How do I: + + \list + \li \l {Switch between modes} + \li \l {Move between open files} + \li \l {Switch to Edit mode} + \li \l {Find a specific setting} + \li \l {Open output panes} + \li \l {Find keyboard shortcuts} + \li \l {Run \QC from the command line} + \li \l {Show and hide sidebars} + \li \l {Move to symbols} + \li \l {Inspect signal-slot connections while debugging} + \li \l {Display low-level data in the debugger} + \li \l {See the value of variables in tooltips while debugging} + \li \l {Quickly locate files using the keyboard} + \li \l {Perform calculations} + \li \l {Jump to a function in QML code} + \li \l {Add a license header template for C++ code} + \li \l {Paste text from my clipboard history} + \li \l {Sort lines alphabetically} + \li \l {Enclose selected code in curly braces, parentheses, or double quotes} + \li \l {Select the enclosing block in C++} + \li \l {Add my own code snippets to the auto-complete menu} + \li \l {Quickly write down notes somewhere} + \li \l {Configure the amount of recent files shown} + \li \l {Search and replace across files using a regular expression} + \endlist + + \section1 Switch between modes \QC uses different modes for different purposes. You can quickly switch between these modes with the following keyboard shortcuts: @@ -55,7 +84,7 @@ For more information about \QC modes, see \l {Selecting Modes}. - \section1 Moving Between Open Files + \section1 Move between open files To quickly move between currently open files, press \key Ctrl+Tab. @@ -66,7 +95,7 @@ to jump to a symbol in the same file, you can jump back to your original location in that file by pressing \key {Alt+Left}. - \section1 Moving To the Edit Mode + \section1 Switch to Edit mode To move to the \uicontrol Edit mode and currently active file, press \key Esc. @@ -81,12 +110,12 @@ \endlist - \section1 Using the Filter in Options Dialog + \section1 Find a specific setting To find specific settings you require in \uicontrol{Tools} > \uicontrol{Options} use the filter located at the top left of the \uicontrol Options dialog box. - \section1 Opening Output Panes + \section1 Open output panes The output panes provide a list of errors and warnings encountered during a build, detailed output from the compiler, status of a program when it is @@ -112,7 +141,7 @@ For more information about output panes, see \l{Viewing Output}. - \section1 Using Keyboard Shortcuts + \section1 Find keyboard shortcuts \QC provides \l{Keyboard Shortcuts}{many useful keyboard shortcuts}. You can see the keyboard shortcut for a menu command in the menu @@ -121,7 +150,7 @@ To customize, import or export keyboard shortcuts, select \uicontrol Tools > \uicontrol Options > \uicontrol Environment > \uicontrol Keyboard. - \section1 Running \QC From Command Line + \section1 Run \QC from the command line You can launch \QC from command line using the name of an existing session or \c .pro file by giving the name as the command @@ -132,7 +161,7 @@ For more information, see \l{Using Command Line Options}. - \section1 Showing and Hiding Sidebars + \section1 Show and hide sidebars You can toggle the left and right sidebar in some \QC modes. @@ -147,7 +176,7 @@ For more information on using the sidebars, see \l {Browsing Project Contents}. - \section1 Moving To Symbols + \section1 Move to symbols To move straight to a symbol used in a project, select the symbol in the \uicontrol Editor toolbar drop-down menu. For more information on the editor @@ -163,7 +192,7 @@ cursor on the symbol and press \key {F2}. For more information, see \l{Moving to Symbol Definition or Declaration}. - \section1 Displaying Signals and Slots + \section1 Inspect signal-slot connections while debugging If an instance of a class is derived from QObject, and you would like to find all other objects connected to one of your object's slots using @@ -177,7 +206,7 @@ For more information about the \uicontrol{Locals} view, see \l{Local Variables and Function Parameters}. - \section1 Displaying Low Level Data + \section1 Display low-level data in the debugger If special debugging of Qt objects fails due to data corruption within the debugged objects, you can switch off the debugging helpers. When debugging @@ -193,7 +222,7 @@ \endlist - \section1 Showing Tooltips in Debug Mode + \section1 See the value of variables in tooltips while debugging To inspect the value of variables from the editor, you can turn on tooltips. Tooltips are hidden by default for performance reasons. @@ -218,7 +247,7 @@ select \uicontrol {Close Editor Tooltips} in the context menu in the \uicontrol {Locals} view. - \section1 Locating Files + \section1 Quickly locate files using the keyboard The \uicontrol Locator provides one of the easiest ways in \QC to browse through projects, files, classes, functions, documentation and file systems. @@ -230,7 +259,20 @@ For more information, see \l{Creating Locator Filters}. - \section1 Adding a License Header Template for C++ Code + \section1 Perform calculations + + Open the \uicontrol Locator with \key {Ctrl+K} and type =, followed by a space. + You can now do basic calculations, with options to copy the results to the clipboard + by navigating through the entries and pressing \key {Enter}. + + For more information, see \l{Executing JavaScript}. + + \section1 Jump to a function in QML code + + Open the \uicontrol Locator with \key {Ctrl+K} and type m, followed by a space. + You can now go directly to any QML method in the file. + + \section1 Add a license header template for C++ code A file containing a license header for C++ can be specified under \uicontrol{Tools > Options > C++ > License Template}. It may contain special @@ -250,16 +292,85 @@ \endlist - \section1 Pasting from Clipboard History + \section1 Paste text from my clipboard history \QC stores copied text in clipboard history. To retrieve clips from the history, press \key {Ctrl+Shift+V} until the clip appears. The number of clips in the history is fixed to 10. - \section1 Sorting Lines Alphabetically + \section1 Sort lines alphabetically To sort selected lines alphabetically, select \uicontrol Edit > \uicontrol Advanced > \uicontrol {Sort Selected Lines} or press \key {Alt+Shift+S} (or \key Ctrl+Shift+S on \macos). + \section1 Enclose selected code in curly braces, parentheses, or double quotes + + Press \key {Shift} and then the opening character. + + \list + \li Curly braces: \key {Shift+\{} + \li Parentheses: \key {Shift+(} + \li Double quotes: \key {Shift+"} + \endlist + + \section1 Select the enclosing block in C++ + + Press \key {Ctrl+U}. + + \section1 Add my own code snippets to the auto-complete menu + + You can add, modify, and remove snippets in the snippet editor. + To open the editor, select \uicontrol Tools > \uicontrol Options + > \uicontrol {Text Editor} > \uicontrol Snippets. + + For more information, see \l {Adding and Editing Snippets}. + + \section1 Quickly write down notes somewhere + + Select \uicontrol File > \uicontrol {New File or Project} > + \uicontrol {Files and Classes} > \uicontrol General > \uicontrol {Scratch Buffer}. + Alternatively, \key {Ctrl+N} can be used to open this dialog, which is + fully navigable via keyboard by using the up and down arrow keys and the + tab key. + + This creates a new empty text file and saves it to the temporary directory + on your machine. You can use it to write down notes without having to worry + about deleting the file afterwards. The operating system will eventually + remove the file automatically. If you want to keep the file, you can easily + save it as a new file somewhere else. If you accidentally close the file, + you can find it in the \uicontrol File > \uicontrol {Recent Files} menu. + + \section1 Configure the amount of recent files shown + + Select \uicontrol Tools > \uicontrol Options, and change the value of the + list under \uicontrol Environment > \uicontrol System + > \uicontrol {Maximum number of entries in "Recent Files"}. + + \section1 Search and replace across files using a regular expression + + As an example, say you want to replace equality checks (\c {foo == bar}) + with a function (\c {foo.equals(bar)}): + + \list 1 + \li Ensure that any work you have done is committed to version control, + as the changes cannot be undone. + \li Press \key {Ctrl+Shift+F} to bring up the \uicontrol {Advanced Find} + form. + \li Change the scope to whatever is appropriate for your search. + \li Under the \uicontrol {Search for} text field, select + the \uicontrol {Use regular expressions} check box. + \li Enter the following text in the \uicontrol {Search for} text field: + \badcode + if \((.*) == (.*)\) + \endcode + \li Press \uicontrol {Search & Replace} to see a list of search results. + \li In the \uicontrol {Replace with} text field, enter the following text: + \badcode + if (\1.strictlyEquals(\2)) + \endcode + \li Press \uicontrol Replace to replace all instances of the text. + \endlist + + For more information, see \l {Advanced Search}. */ diff --git a/doc/src/howto/creator-only/qtcreator-faq.qdoc b/doc/src/howto/creator-only/qtcreator-faq.qdoc index 712d81aeda..87bd22d00d 100644 --- a/doc/src/howto/creator-only/qtcreator-faq.qdoc +++ b/doc/src/howto/creator-only/qtcreator-faq.qdoc @@ -27,13 +27,13 @@ \contentspage index.html \previouspage creator-help.html \page creator-faq.html - \nextpage creator-tips.html + \nextpage creator-how-tos.html \title FAQ This section contains answers to some frequently asked questions about \QC. You might also find answers to your questions in the - \l{Known Issues} and \l{Tips and Tricks} sections, or the Troubleshooting + \l{Known Issues} and \l{How-tos} sections, or the Troubleshooting sections for a special area, such as \l{Troubleshooting Debugger}{debugging}. diff --git a/doc/src/howto/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index adc38a0cf3..8e6a23b317 100644 --- a/doc/src/howto/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -107,7 +107,7 @@ \section1 Useful Features For a list of useful \QC features described in other parts of the - documentation, see \l{Tips and Tricks}. + documentation, see \l{How-tos}. \endif \section1 Changing Languages @@ -404,6 +404,9 @@ \if defined(qtdesignstudio) \li \uicontrol {Asset Importer Error} - Errors and warnings encountered while importing assets from a design tool. + \else + \li \uicontrol Autotests - Errors and warnings encountered while running + tests. \endif \li \uicontrol {Build System} - Errors and warnings encountered during a diff --git a/doc/src/overview/creator-only/creator-help-overview.qdoc b/doc/src/overview/creator-only/creator-help-overview.qdoc index dd8c47dc25..fd16ed3e9f 100644 --- a/doc/src/overview/creator-only/creator-help-overview.qdoc +++ b/doc/src/overview/creator-only/creator-help-overview.qdoc @@ -53,7 +53,7 @@ Contains answers to some frequently asked questions about \QC. - \li \l{Tips and Tricks} + \li \l{How-tos} Lists useful \QC features. diff --git a/doc/src/overview/creator-only/creator-issues.qdoc b/doc/src/overview/creator-only/creator-issues.qdoc index 16c5263aee..bbbd71002f 100644 --- a/doc/src/overview/creator-only/creator-issues.qdoc +++ b/doc/src/overview/creator-only/creator-issues.qdoc @@ -31,7 +31,7 @@ /*! \contentspage index.html - \previouspage creator-tips.html + \previouspage creator-how-tos.html \page creator-known-issues.html \nextpage creator-glossary.html diff --git a/doc/src/projects/creator-only/creator-projects-build-systems.qdocinc b/doc/src/projects/creator-only/creator-projects-build-systems.qdocinc index e11cf0c340..b383c94e99 100644 --- a/doc/src/projects/creator-only/creator-projects-build-systems.qdocinc +++ b/doc/src/projects/creator-only/creator-projects-build-systems.qdocinc @@ -45,7 +45,7 @@ configuration. qmake is installed and configured when you install Qt. To use one of the other supported build systems, you need to set it up. - \l {CMake Manual}{CMake} is an alternative to qmake for automating the + \l {Build with CMake}{CMake} is an alternative to qmake for automating the generation of build configurations. For more information, see \l {Setting Up CMake}. diff --git a/doc/src/projects/creator-only/creator-projects-compilers.qdoc b/doc/src/projects/creator-only/creator-projects-compilers.qdoc index b91d5b7d9e..30d39dbffa 100644 --- a/doc/src/projects/creator-only/creator-projects-compilers.qdoc +++ b/doc/src/projects/creator-only/creator-projects-compilers.qdoc @@ -63,8 +63,9 @@ Windows applications on Windows. MinGW is distributed together with \QC and Qt installers for Windows. - \li Linux ICC (Intel C++ Compiler) is a group of C and C++ compilers - for Linux. + \li ICC (Intel C++ Compiler) is a group of C and C++ compilers. + Only the GCC-compatible variant, available for Linux and \macos, + is currently supported by \QC. \li Clang is a C, C++, Objective C, and Objective C++ front-end for the LLVM compiler for Windows, Linux, and \macos. @@ -87,7 +88,8 @@ \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. + \note Currently supported architectures are \c 8051, \c AVR, \c ARM, + \c STM8, and \c MSP430. \li \l{https://www.keil.com}{KEIL} is a group of C and C++ bare-metal compilers from the various KEIL development environments. @@ -95,7 +97,7 @@ \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. + \note Currently supported architectures are \c 8051 and \c STM8. \endlist diff --git a/doc/src/qtcreator-toc.qdoc b/doc/src/qtcreator-toc.qdoc index f0bd3f9e02..fb796ae8bf 100644 --- a/doc/src/qtcreator-toc.qdoc +++ b/doc/src/qtcreator-toc.qdoc @@ -231,7 +231,7 @@ \list \li \l{Using the Help Mode} \li \l{FAQ} - \li \l{Tips and Tricks} + \li \l{How-tos} \li \l{Known Issues} \li \l{Glossary} \li \l{Technical Support} diff --git a/doc/src/qtcreator.qdoc b/doc/src/qtcreator.qdoc index 5401ecc442..58db763d76 100644 --- a/doc/src/qtcreator.qdoc +++ b/doc/src/qtcreator.qdoc @@ -123,7 +123,7 @@ \list \li \l{Using the Help Mode} \li \l{FAQ} - \li \l{Tips and Tricks} + \li \l{How-tos} \li \l{Known Issues} \li \l{Glossary} \endlist diff --git a/doc/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc b/doc/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc index 6f8b571bf8..6b09066b87 100644 --- a/doc/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc +++ b/doc/src/qtquick/creator-only/creator-mobile-app-tutorial.qdoc @@ -73,7 +73,7 @@ The main view of the application displays an SVG bubble image that moves around the screen when you tilt the device. - To use \l{accelbubble/Bluebubble.svg}{Bluebubble.svg} in your project, + To use \e {Bluebubble.svg} in your project, copy it to the project directory (same subdirectory as the QML file). The image appears in \uicontrol Resources. You can also use any other image or a QML type, instead. @@ -140,9 +140,8 @@ \QC creates a reference to the Bubble type in \e Page1Form.ui.qml. - To check your code, you can compare \e Page1Form.ui.qml with the - \l{accelbubble/Page1Form.ui.qml}{Page1Form.ui.qml} example file and - \e Bubble.qml with the \l{accelbubble/Bubble.qml}{Bubble.qml} example file. + To check your code, you can compare your \e Page1Form.ui.qml and + \e {Bubble.qml} with the corresponding example files. The UI is now ready and you can switch to editing the \e Bubble.qml and \e main.qml files in the \uicontrol {Text Editor}, as described in the diff --git a/doc/src/qtquick/creator-only/creator-tutorial-create-qq-project.qdocinc b/doc/src/qtquick/creator-only/creator-tutorial-create-qq-project.qdocinc index b3f2bc67a1..04826f69fa 100644 --- a/doc/src/qtquick/creator-only/creator-tutorial-create-qq-project.qdocinc +++ b/doc/src/qtquick/creator-only/creator-tutorial-create-qq-project.qdocinc @@ -45,7 +45,7 @@ \l {Setting Up CMake}{CMake}, or \l {Setting Up Qbs}{Qbs}. \li In the \uicontrol {Qt Quick Controls Style} field, select one of - the predefined \l{Styling Qt Quick Controls 2}{UI styles} to use, + the predefined \l{Styling Qt Quick Controls}{UI styles} to use, and then select \uicontrol Next. \li Select \l{glossary-buildandrun-kit}{kits} for the platforms that diff --git a/doc/src/qtquick/creator-only/qtquick-app-tutorial.qdoc b/doc/src/qtquick/creator-only/qtquick-app-tutorial.qdoc index 55fe9f421c..0d93f62c9f 100644 --- a/doc/src/qtquick/creator-only/qtquick-app-tutorial.qdoc +++ b/doc/src/qtquick/creator-only/qtquick-app-tutorial.qdoc @@ -188,9 +188,9 @@ \endlist - To check your code, you can view \e Page1Form.ui.qml in the - \uicontrol {Text Editor} and compare it with the \l{transitions/Page1Form.ui.qml} - {Page1Form.ui.qml} example file. + To check your code, you can view your \e {Page1Form.ui.qml} file in the + \uicontrol {Text Editor} and compare it with the \e {Page1Form.ui.qml} + example file. The new project wizard adds boilerplate code to the \e Page1.qml file to create menu items and push buttons. Modify the boilerplate code by removing diff --git a/doc/src/qtquick/creator-only/qtquick-creating.qdoc b/doc/src/qtquick/creator-only/qtquick-creating.qdoc index d37992ed2e..1e633f803c 100644 --- a/doc/src/qtquick/creator-only/qtquick-creating.qdoc +++ b/doc/src/qtquick/creator-only/qtquick-creating.qdoc @@ -172,7 +172,7 @@ \l {Setting Up CMake}{CMake}, or \l {Setting Up Qbs}{Qbs}. \li In the \uicontrol {Qt Quick Controls Style} field, select one of - the predefined \l{Styling Qt Quick Controls 2}{UI styles} to use, + the predefined \l{Styling Qt Quick Controls}{UI styles} to use, and then select \uicontrol Next. \li Select the \uicontrol {Use Qt Virtual Keyboard} check box to add diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc index d8327fd2f8..e7908915ff 100644 --- a/doc/src/qtquick/qtquick-components.qdoc +++ b/doc/src/qtquick/qtquick-components.qdoc @@ -458,7 +458,7 @@ user interfaces for \l{glossary-device}{devices}. Qt Quick Controls 2 achieve improved efficiency by employing a simplified - \l {Styling Qt Quick Controls 2}{styling architecture} when compared to + \l {Styling Qt Quick Controls}{styling architecture} when compared to Qt Quick Controls, on which the module is based. The visual editor reads the \c qtquickcontrols2.conf file that specifies the preferred style and some style-specific arguments. To change the style, select another style from diff --git a/doc/src/qtquick/qtquick-timeline.qdoc b/doc/src/qtquick/qtquick-timeline.qdoc index b3b40a8167..59eda721c0 100644 --- a/doc/src/qtquick/qtquick-timeline.qdoc +++ b/doc/src/qtquick/qtquick-timeline.qdoc @@ -199,12 +199,15 @@ To remove all the changes you recorded for a property, right-click the property name on the timeline and select \uicontrol {Remove Property}. - Keyframes a marked on the timeline by using markers of different colors and + Keyframes are marked on the timeline by using markers of different colors and shapes, depending on whether they are active or inactive or whether you have applied easing curves to them, for example. - To edit the value of the selected keyframe, select - \uicontrol {Edit Value for Keyframe} in the context menu. + To edit the value of a keyframe, double-click a keyframe marker or select + \uicontrol {Edit Keyframe} in the context menu. In the \uicontrol Frame + field, you can set the frame and the value: + + \image studio-edit-keyframe.png "Edit Keyframe dialog" You can copy the keyframes from the keyframe track for an item and paste them to the keyframe track of another item. To copy all @@ -241,13 +244,14 @@ components can appear to pick up speed, slow down, or bounce back at the end of the animation. By default, the animations you specify on the timeline are \e linear, which means that they move from the beginning to - the end at a constant speed. You can use the \e {curve picker} to edit the - easing curve between two keyframes. You can also use the more advanced - \e {curve editor} to edit the curves for the whole animation. + the end at a constant speed. You can use the \uicontrol {Easing Curve Editor} + to edit the easing curve between two keyframes. You can also use the more + advanced \uicontrol {Curve Editor (C)} to edit the curves for the whole + animation. \section2 Attaching Easing Curves to Keyframes - \image studio-curve-picker.png + \image studio-easing-curve-editor.png "Easing Curve Editor" You can use the preset curves or modify them by dragging the curve handlers around. You can add points to the curve and drag them and the point handlers @@ -255,22 +259,21 @@ custom curve. For more information about easing curve types, see the documentation for \l [QML] {PropertyAnimation}{easing curves}. - To zoom into and out of the easing curve picker, use the mouse roller. To + To zoom into and out of the easing curve editor, use the mouse roller. To reset the zoom factor, right-click in the picker and select \uicontrol {Reset Zoom}. To attach easing curves to keyframes: \list 1 - \li Select a keyframe on the timeline. - \li Select \uicontrol {Curve Picker (C)} on the toolbar, or press - \key C to open the curve picker. + \li Right-click a keyframe on the timeline and select + \uicontrol {Easing Curve Editor} in the context menu. \li Select an easing curve in the \uicontrol Presets tab. \li In the \uicontrol {Duration (ms)} field, select the duration of the easing function in milliseconds. \li Select \uicontrol Preview to preview the curve. \li Select \uicontrol OK to attach the easing curve to the keyframe - and to close the curve picker. + and to close the easing curve editor. \endlist When you attach easing curves to keyframes, the shape of the keyframe @@ -283,8 +286,8 @@ To customize easing curves: \list 1 - \li In the curve picker, select an easing curve in the - \uicontrol Presets tab. + \li In the \uicontrol {Easing Curve Editor}, select an easing curve in + the \uicontrol Presets tab. \li Drag the curve handlers to modify the curve. \li Right-click in the editor, and select \uicontrol {Add Point} to add points to the curve. @@ -297,7 +300,7 @@ \uicontrol Custom tab. \endlist - To paste easing curve definitions to the curve picker as text, select + To paste easing curve definitions to the easing curve editor as text, select the \uicontrol Text tab. \section1 Editing Animation Curves @@ -307,9 +310,9 @@ modify the curve. You can modify the appearance of the curve in the style editor. - You can also edit easing curves that you added with the curve picker. + You can also edit easing curves that you added with the easing curve editor. - \image studio-curve-editor.png + \image studio-curve-editor.png "Curve Editor" To edit animation curves: diff --git a/doc/src/vcs/creator-vcs-git.qdoc b/doc/src/vcs/creator-vcs-git.qdoc index 8705df4939..ec6b1a2ebe 100644 --- a/doc/src/vcs/creator-vcs-git.qdoc +++ b/doc/src/vcs/creator-vcs-git.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. @@ -224,6 +224,13 @@ branch is shown in bold and underlined in the list of branches in the \uicontrol {Git Branches} sidebar view. + \image qtcreator-vcs-gitbranch.png "Git Branches sidebar view" + + Old entries and tags are filtered out of the list of branches + by default. To include them, select \inlineimage filtericon.png + (\uicontrol {Filter Tree}), and then select + \uicontrol {Include Old Entries} and \uicontrol {Include Tags}. + If you checked out a specific commit, the list of branches displays a \e {Detached HEAD} entry. @@ -233,8 +240,6 @@ To refresh the list of branches, click \inlineimage reload_gray.png (\uicontrol Refresh). - \image qtcreator-vcs-gitbranch.png "Git Branches sidebar view" - The following operations are supported in the context-menu for a branch: \table @@ -249,7 +254,8 @@ \li Remove a local branch. You cannot delete remote branches. \row \li \uicontrol Rename - \li Rename a local branch. You cannot rename remote branches. + \li Rename a local branch or a tag. You cannot rename remote + branches. \row \li \uicontrol{Checkout} \li Check out the selected branch and make it current. You can stash @@ -302,12 +308,12 @@ \li Description \row \li \uicontrol{Fetch} - \li Fetches all the branches and changes information from a + \li Fetch all the branches and changes information from a specific remote repository, or from all remotes if applied to \uicontrol {Remote Branches}. \row \li \uicontrol{Manage Remotes} - \li Opens the \uicontrol Remotes dialog. + \li Open the \uicontrol Remotes dialog. \endtable \section3 Configuring Merge Tools @@ -357,11 +363,33 @@ To browse a directory or the commit history and to apply actions on the commits, select \uicontrol Tools > \uicontrol Git > - \uicontrol {Actions on Commits}. You can checkout, revert, or cherry-pick - commits or view them in the diff editor. + \uicontrol {Actions on Commits}. \image creator-git-commit-actions.png "Select a Git Commit dialog" + You can apply the following actions on commits: + + \table + \header + \li Menu Item + \li Description + \row + \li \uicontrol Archive + \li Package the commit as a ZIP or tarball. + \row + \li \uicontrol Checkout + \li Check out the change in a headless state. + \row + \li \uicontrol {Cherry Pick} + \li Cherry-pick the selected change to the local repository. + \row + \li \uicontrol Revert + \li Revert back to the state of the last commit. + \row + \li \uicontrol Show + \li Show the commit in the diff editor. + \endtable + \section1 Initializing Git Repositories To start controlling a project directory that is currently not under |
