diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-14 07:56:06 +0100 |
---|---|---|
committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-03-14 11:49:39 +0100 |
commit | 8f61d67d26eb89b055edb8f9bfc2f804ad1b6fb0 (patch) | |
tree | 79be7545be4581d85644589dc5c1b4309508dc4c /sources | |
parent | 4885f61826c5d60ab7b301d8cf0539686eea9d45 (diff) |
Documentation: Clean up extra documentation
Remove obsolete modules. Update and rewrap description texts of
existing modules. Add new QtOpenGLWidgets module.
Pick-to: 6.2
Change-Id: Ifbe0fec66e964d579348ac0ef438beb8a3ca0a28
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources')
-rw-r--r-- | sources/pyside6/doc/extras/QtCore.rst | 3 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtOpenGL.rst | 22 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtOpenGLWidgets.rst | 8 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtScript.rst | 21 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtScriptTools.rst | 5 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtTest.rst | 2 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtUiTools.rst | 12 | ||||
-rw-r--r-- | sources/pyside6/doc/extras/QtXmlPatterns.rst | 12 |
8 files changed, 38 insertions, 47 deletions
diff --git a/sources/pyside6/doc/extras/QtCore.rst b/sources/pyside6/doc/extras/QtCore.rst index 694fb84e9..a0b524976 100644 --- a/sources/pyside6/doc/extras/QtCore.rst +++ b/sources/pyside6/doc/extras/QtCore.rst @@ -1,4 +1,5 @@ -All other Qt modules rely on this module. To include the definitions of the module's classes, use the following directive: +All other Qt modules rely on this module. +To include the definitions of the module's classes, use the following directive: :: diff --git a/sources/pyside6/doc/extras/QtOpenGL.rst b/sources/pyside6/doc/extras/QtOpenGL.rst index 9979f9f03..aa699a7d7 100644 --- a/sources/pyside6/doc/extras/QtOpenGL.rst +++ b/sources/pyside6/doc/extras/QtOpenGL.rst @@ -1,14 +1,26 @@ -OpenGL is a standard API for rendering 3D graphics. OpenGL only deals with 3D rendering and provides little or no support for GUI programming issues. The user interface for an OpenGL application must be created with another toolkit, such as Motif on the X platform, Microsoft Foundation Classes (MFC) under Windows, or Qt on both platforms. +OpenGL is a standard API for rendering 3D graphics. OpenGL only deals +with 3D rendering and provides little or no support for GUI +programming issues. The user interface for an OpenGL application must +be created with another toolkit, such as XCB on the X platform, +Microsoft Foundation Classes (MFC) under Windows, or Qt on both +platforms. .. note:: OpenGL is a trademark of Silicon Graphics, Inc. in the United States and other countries. -The Qt OpenGL module makes it easy to use OpenGL in Qt applications. It provides an OpenGL widget class that can be used just like any other Qt widget, except that it opens an OpenGL display buffer where you can use the OpenGL API to render the contents. -To include the definitions of the module's classes, use the following directive: +The Qt OpenGL module makes it easy to use OpenGL in Qt applications. +To include the definitions of the module's classes, use the following +directive: :: import PySide6.QtOpenGL -The Qt OpenGL module is implemented as a platform-independent wrapper around the platform-dependent GLX (version 1.3 or later), WGL, or AGL C APIs. Although the basic functionality provided is very similar to Mark Kilgard's GLUT library, applications using the Qt OpenGL module can take advantage of the whole Qt API for non-OpenGL-specific GUI functionality. +The Qt OpenGL module is implemented as a platform-independent wrapper +around the platform-dependent GLX (version 1.3 or later), WGL, or AGL +C APIs. Applications using the Qt OpenGL module can take advantage of +the whole Qt API for non-OpenGL-specific GUI functionality. + +The QtOpenGL module is available on Windows, X11 and Mac OS X. Qt for +Embedded Linux and OpenGL supports OpenGL ES (OpenGL for Embedded +Systems). -The QtOpenGL module is available on Windows, X11 and Mac OS X. Qt for Embedded Linux and OpenGL supports OpenGL ES (OpenGL for Embedded Systems).
\ No newline at end of file diff --git a/sources/pyside6/doc/extras/QtOpenGLWidgets.rst b/sources/pyside6/doc/extras/QtOpenGLWidgets.rst new file mode 100644 index 000000000..d40b89d71 --- /dev/null +++ b/sources/pyside6/doc/extras/QtOpenGLWidgets.rst @@ -0,0 +1,8 @@ +The Qt OpenGL provides the OpenGL widget class that can be used just like any +other Qt widget, except that it opens an OpenGL display buffer where you can +use the OpenGL API to render the contents. To include the definitions of +the module's classes, use the following directive: + +:: + + import PySide6.QtOpenGLWidgets diff --git a/sources/pyside6/doc/extras/QtScript.rst b/sources/pyside6/doc/extras/QtScript.rst deleted file mode 100644 index 1d2a1bd04..000000000 --- a/sources/pyside6/doc/extras/QtScript.rst +++ /dev/null @@ -1,21 +0,0 @@ -The QtScript module only provides core scripting facilities; the QtScriptTools module provides additional Qt Script-related components that application developers may find useful. - -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide6.QtScript - -License Information -------------------- - -Qt Commercial Edition licensees that wish to distribute applications that use the QtScript module need to be aware of their obligations under the GNU Library General Public License (LGPL). - -Developers using the Open Source Edition can choose to redistribute the module under the appropriate version of the GNU LGPL. -QtScript is licensed under the GNU Library General Public License. Individual contributor names and copyright dates can be found inline in the code. - -This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. - -You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. diff --git a/sources/pyside6/doc/extras/QtScriptTools.rst b/sources/pyside6/doc/extras/QtScriptTools.rst deleted file mode 100644 index 8f0c7e12b..000000000 --- a/sources/pyside6/doc/extras/QtScriptTools.rst +++ /dev/null @@ -1,5 +0,0 @@ -Applications that use the Qt Script Tools classes need to be configured to be built against the QtScriptTools module. To include the definitions of the module's classes, use the following directive: - -:: - - import PySide6.QtScriptTools diff --git a/sources/pyside6/doc/extras/QtTest.rst b/sources/pyside6/doc/extras/QtTest.rst index 1b3f98940..cebd5a053 100644 --- a/sources/pyside6/doc/extras/QtTest.rst +++ b/sources/pyside6/doc/extras/QtTest.rst @@ -4,4 +4,4 @@ To include the definitions of the module's classes, use the following directive: import PySide6.QtTest -.. note:: All macros in the C++ version of QtTest were not binded in PySide, this module is useful only for GUI testing and benchmarking, for ordinary unit testing you should use the ``unittest`` Python module. +.. note:: Not all macros in the C++ version of QtTest were exposed in PySide. This module is useful only for GUI testing and benchmarking; for ordinary unit testing you should use the ``pytest`` Python module. diff --git a/sources/pyside6/doc/extras/QtUiTools.rst b/sources/pyside6/doc/extras/QtUiTools.rst index 2769da4d6..6861605bb 100644 --- a/sources/pyside6/doc/extras/QtUiTools.rst +++ b/sources/pyside6/doc/extras/QtUiTools.rst @@ -1,6 +1,14 @@ -These forms are processed at run-time to produce dynamically-generated user interfaces. In order to generate a form at run-time, a resource file containing a UI file is needed. +Qt Designer forms are processed at run-time to produce +dynamically-generated user interfaces. In order to generate a form at +run-time, a resource file containing a UI file is needed. -A form loader object, provided by the QUiLoader class, is used to construct the user interface. This user interface can be retrieved from any QIODevice; for example, a QFile object can be used to obtain a form stored in a project's resources. The :meth:`PySide6.QtUiTools.QUiLoader.load` function takes the user interface description contained in the file and constructs the form widget. +A form loader object, provided by the ``QUiLoader`` class, is used to +construct the user interface. This user interface can be retrieved +from any ``QIODevice``; for example, a ``QFile`` object can be used to obtain +a form stored in a project's resources. The +:meth:`PySide6.QtUiTools.QUiLoader.load` function takes the user +interface description contained in the file and constructs the form +widget. To include the definitions of the module's classes, use the following directive: diff --git a/sources/pyside6/doc/extras/QtXmlPatterns.rst b/sources/pyside6/doc/extras/QtXmlPatterns.rst deleted file mode 100644 index 258fdf28d..000000000 --- a/sources/pyside6/doc/extras/QtXmlPatterns.rst +++ /dev/null @@ -1,12 +0,0 @@ -To include the definitions of the module's classes, use the following directive: - -:: - - import PySide6.QtXmlPatterns - -Further Reading ---------------- - -General overviews of XQuery and XSchema can be found in the XQuery document. - -An introduction to the XQuery language can be found in A Short Path to XQuery. |