diff options
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/debugger/creator-only/creator-debugger.qdoc | 24 | ||||
| -rw-r--r-- | doc/src/editors/creator-coding-edit-mode.qdoc | 7 | ||||
| -rw-r--r-- | doc/src/editors/creator-only/creator-fakevim.qdoc | 82 | ||||
| -rw-r--r-- | doc/src/howto/creator-only/creator-autotest.qdoc | 3 | ||||
| -rw-r--r-- | doc/src/howto/creator-ui.qdoc (renamed from doc/src/howto/creator-only/creator-ui.qdoc) | 92 | ||||
| -rw-r--r-- | doc/src/overview/creator-acknowledgements.qdoc | 128 | ||||
| -rw-r--r-- | doc/src/projects/creator-only/creator-projects-creating.qdoc | 11 | ||||
| -rw-r--r-- | doc/src/python/creator-python-project.qdocinc | 97 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-components.qdoc | 9 | ||||
| -rw-r--r-- | doc/src/qtquick/qtquick-designer.qdoc | 18 | ||||
| -rw-r--r-- | doc/src/vcs/creator-only/creator-vcs-perforce.qdoc | 20 | ||||
| -rw-r--r-- | doc/src/vcs/creator-only/creator-vcs-subversion.qdoc | 5 | ||||
| -rw-r--r-- | doc/src/vcs/creator-only/creator-vcs.qdoc | 7 | ||||
| -rw-r--r-- | doc/src/vcs/creator-vcs-git.qdoc | 6 |
14 files changed, 453 insertions, 56 deletions
diff --git a/doc/src/debugger/creator-only/creator-debugger.qdoc b/doc/src/debugger/creator-only/creator-debugger.qdoc index 0d085d7889..57e49a846b 100644 --- a/doc/src/debugger/creator-only/creator-debugger.qdoc +++ b/doc/src/debugger/creator-only/creator-debugger.qdoc @@ -275,8 +275,28 @@ ulimit -c unlimited \endcode - To launch the debugger in the core mode, select \uicontrol Debug > - \uicontrol {Start Debugging} > \uicontrol {Load Core File}. + To launch the debugger in the core mode: + + \list 1 + \li Select \uicontrol Debug > \uicontrol {Start Debugging} > + \uicontrol {Load Core File}. + \image qtcreator-debugger-load-core-file.png + \li In the \uicontrol Kit field, select a build and run kit that was + used for building the binary for which the core file was created. + If the core file stems from a binary not built by \QC or a process + not initiated by \QC, select a kit that matches the setup used as + closely as possible, in respect to the specified device, tool chain, + debugger, and sysroot. + \li In the \uicontrol {Core file} field, specify the core file to + inspect. + \li In the \uicontrol {Executable of symbol file} field, specify + a file that contains debug information corresponding to the + core file. Typically, this is the executable file or a \c {.debug} + file if the debug information is stored separately from the + executable. + \li In the \uicontrol {Override start script} field, specify a + script file to run instead of the default start script. + \endlist Also in this mode, using a properly configured project containing the sources of the crashed program is not strictly necessary, but helpful. diff --git a/doc/src/editors/creator-coding-edit-mode.qdoc b/doc/src/editors/creator-coding-edit-mode.qdoc index 423954328f..eed6cef31f 100644 --- a/doc/src/editors/creator-coding-edit-mode.qdoc +++ b/doc/src/editors/creator-coding-edit-mode.qdoc @@ -261,11 +261,4 @@ correct paths for includes that are not resolved or that are resolved to the wrong file, select \uicontrol {Project Parts} > \uicontrol {Header Paths}. \endif - - \if defined(qtdesignstudio) - \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 - \endif */ diff --git a/doc/src/editors/creator-only/creator-fakevim.qdoc b/doc/src/editors/creator-only/creator-fakevim.qdoc index a35bf4b1e2..09e7323e45 100644 --- a/doc/src/editors/creator-only/creator-fakevim.qdoc +++ b/doc/src/editors/creator-only/creator-fakevim.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. @@ -121,29 +121,99 @@ \section2 Options - Use \c {:set ...} to set the following options: + Use \c {:set ...} to set the options listed in the following table: - \list + \table + \header + \li Long Name + \li Short Name + \li Arguments + \row \li \c autoindent - \li \c clipboard + \li \c ai + \li + \row \li \c backspace + \li \c bs + \li \c indent, \c eol, \c start + \row + \li \c blinkingcursor + \li \c bc + \li + \row + \li \c clipboard + \li \c cb + \li + \row \li \c expandtab + \li \c et + \li + \row \li \c hlsearch + \li \c hls + \li + \row \li \c ignorecase + \li \c ic + \li + \row \li \c incsearch - \li \c indent + \li \c is + \li + \row \li \c iskeyword + \li \c isk + \li A combination of the following characters: \c @, \c 48-57, \c _, + \c 192-255, \c a-z, \c A-Z + \row + \li \c relativenumber + \li \c rnu + \li + \row \li \c scrolloff + \li \c so + \li + \row \li \c shiftwidth + \li \c sw + \li + \row \li \c showcmd + \li \c sc + \li + \row \li \c smartcase + \li \c scs + \li + \row \li \c smartindent + \li \c si + \li + \row \li \c smarttab + \li \c sta + \li + \row \li \c startofline + \li \c sol + \li + \row \li \c tabstop + \li \c ts + \li + \row \li \c tildeop + \li \c top + \li + \row + \li \c usecoresearch + \li \c ucs + \li + \row \li \c wrapscan - \endlist + \li \c ws + \li + \endtable \section2 Vimrc Example diff --git a/doc/src/howto/creator-only/creator-autotest.qdoc b/doc/src/howto/creator-only/creator-autotest.qdoc index 6c05f13f8d..d5ece2aca0 100644 --- a/doc/src/howto/creator-only/creator-autotest.qdoc +++ b/doc/src/howto/creator-only/creator-autotest.qdoc @@ -399,7 +399,8 @@ To view only messages of a particular type, select \inlineimage filtericon.png (\uicontrol {Filter Test Results}), and then select the types of messages to - show. + show. To show all messages, select \uicontrol {Check All Filters}. To + deselect all message types, select \uicontrol {Uncheck All Filters}. By default, test result output is limited to 100,000 characters. The output pane is automatically scrolled down when new results are added. To display diff --git a/doc/src/howto/creator-only/creator-ui.qdoc b/doc/src/howto/creator-ui.qdoc index 4ff1334ce3..be542702da 100644 --- a/doc/src/howto/creator-only/creator-ui.qdoc +++ b/doc/src/howto/creator-ui.qdoc @@ -31,9 +31,14 @@ /*! \contentspage index.html - \previouspage creator-overview.html \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 \title User Interface @@ -53,20 +58,32 @@ \endlist + \if defined(qtcreator) \image qtcreator-breakdown.png + \else + \image studio-welcome-mode.png + \endif You can use the mode selector (1) to change to another \QC mode. + \if defined(qtcreator) You can use the kit selector (2) to select the \l{glossary-buildandrun-kit}{kit} for running (3), debugging (4), or building (5) the application. Output from these actions is displayed in the output panes (7). + \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). + \endif - You can use the locator (6) to to browse through projects, files, classes, + You can use the 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 @@ -84,7 +101,11 @@ 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: @@ -95,19 +116,29 @@ \li \uicontrol{\l{Coding}{Edit}} mode for editing project and source files. - \li \uicontrol{\l{Designing User Interfaces}{Design}} mode for designing and - developing application user interfaces. This mode is available for - UI 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. - \li \uicontrol{\l{Specifying Build Settings}{Projects}} mode for configuring - project building and execution. This mode is available when a - project is open. + \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{Getting Help}{Help}} mode for viewing Qt documentation. + \li \uicontrol{\l{Using the Help Mode}{Help}} mode for viewing Qt + documentation. \endlist @@ -119,9 +150,11 @@ \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 @@ -139,14 +172,16 @@ \li \uicontrol {QML Debugger Console} - \li \uicontrol {To-Do Entries} + \li \uicontrol{General Messages} \li \uicontrol{Version Control} - \li \uicontrol{General Messages} - + \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 @@ -159,10 +194,16 @@ 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 \l{Using Version Control Systems} - {Version Control} panes, select - \uicontrol {Window > Output Panes}. To display the \uicontrol {To-Do Entries} pane, - enable the Todo plugin. + 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}. @@ -173,12 +214,19 @@ \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. @@ -186,8 +234,10 @@ \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. @@ -195,11 +245,13 @@ \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} @@ -255,10 +307,12 @@ \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. @@ -290,6 +344,7 @@ In the \uicontrol {Limit 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 @@ -331,6 +386,7 @@ 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 @@ -379,10 +435,12 @@ \l{Searching with the Locator}{navigation} shortcuts are available to help speed up the process of developing your application. + \if defined(qtcreator) \section1 Useful Features For a list of useful \QC features described in other parts of the documentation, see \l{Tips and Tricks}. + \endif \section1 Platform Notes @@ -413,6 +471,7 @@ \uicontrol Keyboard \endtable + \if defined(qtcreator) \section2 Location of Settings Files \QC creates the following files and directories: @@ -453,6 +512,7 @@ \c {%SystemDrive%\Users\%USERNAME%\AppData\Local\QtProject}. \endlist + \endif \section2 High DPI Scaling diff --git a/doc/src/overview/creator-acknowledgements.qdoc b/doc/src/overview/creator-acknowledgements.qdoc index 5f48dbefbf..43bac0ad4c 100644 --- a/doc/src/overview/creator-acknowledgements.qdoc +++ b/doc/src/overview/creator-acknowledgements.qdoc @@ -208,6 +208,134 @@ POSSIBILITY OF SUCH DAMAGE. \endcode + \li \b{ANGLE Array Bounds Clamper for WebKit (Windows)} + + Implements clamping of array indexing expressions during shader + translation. + + Used on Windows to implement OpenGL ES on top of DirectX. Configure with + \c {-no-opengl}, or \c {-opengl desktop} to exclude. + + The sources can be found in + \c qtbase/src/3rdparty/angle/src/third_party/compiler. + + BSD 2-clause "Simplified" License. + + \code + Copyright (C) 2012 Apple Inc. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY APPLE, INC. ``AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE, INC. OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY + OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + \endcode + + \li \b{ANGLE: Murmurhash (Windows)} + + Used on Windows to implement OpenGL ES on top of DirectX. Configure + with \c {-no-opengl}, or \c {-opengl desktop} to exclude. + + The sources can be found in + \c qtbase/src/3rdparty/angle/src/third_party/murmurhash. + + \code + MurmurHash3 was written by Austin Appleby, and is placed in the public + domain. The author hereby disclaims copyright to this source code. + \endcode + + Public Domain. + + \li \b{ANGLE: Systeminfo (Windows)} + + Used on Windows to implement OpenGL ES on top of DirectX. Configure + with \c {-no-opengl}, or \c {-opengl desktop} to exclude. + + The sources can be found in + \c qtbase/src/3rdparty/angle/src/third_party/systeminfo. + + BSD 2-clause "Simplified" License. + + \code + Copyright (C) 2009 Apple Inc. All Rights Reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + 1. Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + 2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in the + documentation and/or other materials provided with the distribution. + + THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY + EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE + IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR + CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY + OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + \endcode + + \li \b{ANGLE: trace_event (Windows)} + + Used on Windows to implement OpenGL ES on top of DirectX. Configure + with \c {-no-opengl}, or \c {-opengl desktop} to exclude. + + The sources can be found in + \c qtbase/src/3rdparty/angle/src/third_party/trace_event. + + BSD 3-clause "New" or "Revised" License. + + \code + Copyright 2013 The Chromium Authors. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions are + met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above + copyright notice, this list of conditions and the following disclaimer + in the documentation and/or other materials provided with the + distribution. + * Neither the name of Google Inc. nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + \endcode + \li \b{SQLite, an embedded database. Version 3.8.10.2}\br\br The author or authors of this code dedicate any and all copyright diff --git a/doc/src/projects/creator-only/creator-projects-creating.qdoc b/doc/src/projects/creator-only/creator-projects-creating.qdoc index 5fc91df1c1..ba7a3374a4 100644 --- a/doc/src/projects/creator-only/creator-projects-creating.qdoc +++ b/doc/src/projects/creator-only/creator-projects-creating.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. @@ -126,6 +126,13 @@ Use a single main.cpp file + \li Qt for Python Application - Empty or Window + + Create a \l{https://doc.qt.io/qtforpython/index.html} + {Qt for Python} application that contains only the main + code for a QApplication or create one that contains an + empty window. + \endlist \li Libraries @@ -401,6 +408,8 @@ The above functions are also available in the context menu in the \uicontrol Projects view. + \include creator-python-project.qdocinc python project wizards + \section2 Creating OpenGL Fragment and Vertex Shaders Qt provides support for integration with OpenGL implementations on all diff --git a/doc/src/python/creator-python-project.qdocinc b/doc/src/python/creator-python-project.qdocinc new file mode 100644 index 0000000000..fdb58155a6 --- /dev/null +++ b/doc/src/python/creator-python-project.qdocinc @@ -0,0 +1,97 @@ +/**************************************************************************** +** +** Copyright (C) 2019 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the Qt Creator documentation. +** +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: https://www.gnu.org/licenses/fdl-1.3.html. +** +****************************************************************************/ + +/*! +//! [python project wizards] + + \section2 Creating Qt for Python Applications + + \l {https://doc.qt.io/qtforpython/index.html}{Qt for Python} enables you + to use Qt 5 API in Python applications. You can use the PySide2 module to + gain access to individual Qt modules, such as \l {Qt Core}, \l {Qt GUI}, + and \l {Qt Widgets}. + + The Qt for Python Application wizards generate a \c {.pyproject} file that + lists the files in the Python project and a \c {.py} file that contains + some boilerplate code. + + The \c{.pyproject} files are JSON-based configuration files that replace + the previously used \c {.pyqtc} configuration files. You can still open and + use \c {.pyqtc} files, but we recommend that you choose \c{.pyproject} files + for new projects. + + The Window wizard adds the following imports to the \c {main.py} + file to provide access to the QApplication and QMainWindow classes + in the Qt Widgets module: + + \badcode + import sys + from PySide2.QtWidgets import QApplication, QMainWindow + \endcode + + The Window wizard also adds a \c MainWindow class that inherits from + QMainWindow: + + \badcode + class MainWindow(QMainWindow): + def __init__(self): + QMainWindow.__init__(self) + \endcode + + Next, the Window wizard adds a main function, where it creates a + QApplication instance. As Qt can receive arguments from the command line, + you can pass any arguments to the QApplication object. Usually, you do not + need to pass any arguments, and you can use the following approach: + + \badcode + if __name__ == "__main__": + app = QApplication([]) + ... + \endcode + + Next, the Window wizard instantiates the \c MainWindow class and shows it: + + \badcode + window = MainWindow() + window.show() + ... + \endcode + + Finally, the Window wizard calls the \c app.exec_() method to enter the Qt + main loop and start executing the Qt code: + + \badcode + sys.exit(app.exec_()) + \endcode + + The Empty wizard adds similar code to the \c {main.py} file, but it does + not add any classes, so you need to add and instantiate them yourself. + + For examples of creating Qt for Python applications, see + \l {https://doc.qt.io/qtforpython/tutorials/index.html} + {Qt for Python Examples and Tutorials}. + +//! [python project wizards] +*/ diff --git a/doc/src/qtquick/qtquick-components.qdoc b/doc/src/qtquick/qtquick-components.qdoc index 3b2185e95e..34ee756b43 100644 --- a/doc/src/qtquick/qtquick-components.qdoc +++ b/doc/src/qtquick/qtquick-components.qdoc @@ -32,7 +32,11 @@ /*! \contentspage index.html \page quick-components.html + \if defined(qtdesignstudio) + \previouspage studio-prototyping.html + \else \previouspage creator-using-qt-quick-designer.html + \endif \nextpage quick-buttons.html \title Creating Components @@ -420,6 +424,11 @@ can be selected. \endlist + You can also use the + \l {https://doc-snapshots.qt.io/qt5-5.13/qml-qtquick-dialogs-dialog.html} + {Dialog} type in the Qt Quick Dialogs module to wrap arbitrary content into + a dialog window including a row of platform-tailored buttons. + \if defined(qtdesignstudio) \include qtdesignstudio-visual-effects.qdocinc qml visual effects \include qtdesignstudio-components.qdocinc creating studio components diff --git a/doc/src/qtquick/qtquick-designer.qdoc b/doc/src/qtquick/qtquick-designer.qdoc index 84ee8b1abc..a1f2b0455e 100644 --- a/doc/src/qtquick/qtquick-designer.qdoc +++ b/doc/src/qtquick/qtquick-designer.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. @@ -33,11 +33,12 @@ \contentspage index.html \page creator-using-qt-quick-designer.html \if defined(qtdesignstudio) - \previouspage studio-prototyping.html + \previouspage creator-quick-tour.html + \nextpage {Tutorials} \else \previouspage creator-quick-ui-forms.html - \endif \nextpage quick-components.html + \endif \title Editing QML Files in Design Mode @@ -46,7 +47,11 @@ recommended that you use UI forms for components that you want to edit in the Design mode. + \if defined(qtcreator) \image qmldesigner-visual-editor.png "Visual editor" + \else + \image studio-design-mode.png "Design mode" + \endif To manage your project in the Design mode: @@ -97,11 +102,16 @@ \endlist - \li \uicontrol {State} pane (6) displays the different states of the item. + \li \uicontrol {States} pane (6) displays the different states of the item. QML states typically describe user interface configurations, such as the UI controls, their properties and behavior and the available actions. For more information, see \l{Adding States}. + \if defined(qtdesignstudio) + \li \uicontrol Timeline pane (7) provides a timeline and keyframe based + editor that enables you to animate the properties of UI components. + \endif + \endlist \section1 Snapping to Parent and Sibling Items diff --git a/doc/src/vcs/creator-only/creator-vcs-perforce.qdoc b/doc/src/vcs/creator-only/creator-vcs-perforce.qdoc index 024a19a229..ea87f8686b 100644 --- a/doc/src/vcs/creator-only/creator-vcs-perforce.qdoc +++ b/doc/src/vcs/creator-only/creator-vcs-perforce.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. @@ -40,21 +40,11 @@ Perforce is a fast software configuration management system developed by Perforce Software. - \section1 Configuring Perforce - - When you start \QC, it looks for the executable specified - in the \uicontrol{P4 command} field in \uicontrol{Tools > Options > Version - Control > Perforce}. If the file is not found, the following error - message is displayed in the \uicontrol {Version Control} output pane: - \uicontrol {Perforce: Unable to determine the repository: "p4.exe" - terminated with exit code 1}. If you use Perforce, check that the - path to the executable is specified correctly in the \uicontrol{P4 command} - field. + Since \QC 4.9, the Perforce plugin is disabled by default. To enable + it, select \uicontrol Help > \uicontrol {About Plugins} > + \uicontrol {Version Control} > \uicontrol Perforce, and then restart \QC. - If you do not use Perforce, you can disable the Perforce plugin to - get rid of the error message. Choose \uicontrol {Help > About Plugins} and - deselect the \uicontrol Load check box for the \uicontrol Perforce plugin in - the \uicontrol {Version Control} group. + \section1 Configuring Perforce In the Perforce options, you can specify workspace details: \uicontrol {P4 user}, \uicontrol {P4 client}, and \uicontrol {P4 port}. To diff --git a/doc/src/vcs/creator-only/creator-vcs-subversion.qdoc b/doc/src/vcs/creator-only/creator-vcs-subversion.qdoc index 9c3ed45b3e..900f5a3b6f 100644 --- a/doc/src/vcs/creator-only/creator-vcs-subversion.qdoc +++ b/doc/src/vcs/creator-only/creator-vcs-subversion.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. @@ -51,4 +51,7 @@ To show whitespace changes in annotation views, deselect the \uicontrol {Ignore whitespace changes in annotation} check box. + + You can use Git as a client for a Subversion server. For more information, + see \l{Using Git with Subversion}. */ diff --git a/doc/src/vcs/creator-only/creator-vcs.qdoc b/doc/src/vcs/creator-only/creator-vcs.qdoc index 9a87e53f89..c7f3c0dc94 100644 --- a/doc/src/vcs/creator-only/creator-vcs.qdoc +++ b/doc/src/vcs/creator-only/creator-vcs.qdoc @@ -139,9 +139,10 @@ \image qtcreator-vcs-diff.png - With Git and Subversion, the diff is displayed side-by-side in a \l{Comparing Files} - {diff editor} by default. To use the inline diff view instead, select the - \uicontrol {Switch to Text Diff Editor} (1) option from the toolbar. In the inline + With Git, Mercurial, and Subversion, the diff is displayed side-by-side in + a \l{Comparing Files}{diff editor} by default. To use the inline diff view + instead, select the \uicontrol {Switch to Text Diff Editor} (1) option from + the toolbar. In the inline diff view, you can use context menu commands to apply, revert, stage, and unstage hunks, as well as send them to a code pasting service. diff --git a/doc/src/vcs/creator-vcs-git.qdoc b/doc/src/vcs/creator-vcs-git.qdoc index 2c8b6bbf9c..34dde382be 100644 --- a/doc/src/vcs/creator-vcs-git.qdoc +++ b/doc/src/vcs/creator-vcs-git.qdoc @@ -224,6 +224,9 @@ branch is shown in bold and underlined in the list of branches in the \uicontrol {Git Branches} sidebar view. + If you checked out a specific commit, the list of branches displays a + \e {Detached HEAD} entry. + For local and remote branches, the changes log can be shown by double clicking on the branch name. @@ -281,6 +284,9 @@ \row \li \uicontrol Track \li Set the current branch to track the selected one. + \row + \li \uicontrol Push + \li Push the committed changes to the selected remote branch. \endtable The following additional context-menu operations are available for |