diff options
Diffstat (limited to 'sources/pyside6/doc/modules.rst')
| -rw-r--r-- | sources/pyside6/doc/modules.rst | 313 |
1 files changed, 123 insertions, 190 deletions
diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 9b20d6906..8e77a4616 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -1,5 +1,5 @@ -Qt Modules -=========== +Qt Modules Supported by Qt for Python +===================================== .. toctree:: :hidden: @@ -7,295 +7,228 @@ Qt Modules PySide6/Qt*/index -.. panels:: - :container: container-lg pb-3 - :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 +.. grid:: 1 3 3 3 + :gutter: 2 - :mod:`QtBluetooth <PySide6.QtBluetooth>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtBluetooth <PySide6.QtBluetooth>` - The Bluetooth API provides connectivity between Bluetooth enabled devices. + The Bluetooth API provides connectivity between Bluetooth enabled + devices. - --- + .. grid-item-card:: :mod:`QtCharts <PySide6.QtCharts>` - :mod:`QtCharts <PySide6.QtCharts>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides a set of easy to use chart components. - Provides a set of easy to use chart components. + .. grid-item-card:: :mod:`QtConcurrent <PySide6.QtConcurrent>` - --- + Provides high-level APIs that make it possible to write multi-threaded + programs without using low-level threading primitives such as mutexes, + read-write locks, wait conditions, or semaphores. - :mod:`QtConcurrent <PySide6.QtConcurrent>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Provides high-level APIs that make it possible - to write multi-threaded programs without using low-level threading - primitives such as mutexes, read-write locks, wait conditions, or semaphores. + .. grid-item-card:: :mod:`QtCore <PySide6.QtCore>` - --- + Provides core non-GUI functionality. - :mod:`QtCore <PySide6.QtCore>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtDataVisualization <PySide6.QtDataVisualization>` - Provides core non-GUI functionality. + Provides a way to visualize data in 3D as bar, scatter, and surface + graphs. - --- + .. grid-item-card:: :mod:`QtDBus <PySide6.QtDBus>` - :mod:`QtDataVisualization <PySide6.QtDataVisualization>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + D-Bus is an Inter-Process Communication (IPC) and Remote Procedure + Calling (RPC) mechanism originally developed for Linux to replace + existing and competing IPC solutions with one unified protocol - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. + .. grid-item-card:: :mod:`QtDesigner <PySide6.QtDesigner>` - --- + Provides classes to extend *Qt Widgets Designer*. - :mod:`QtDBus <PySide6.QtDBus>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtGui <PySide6.QtGui>` - D-Bus is an Inter-Process Communication (IPC) and Remote Procedure - Calling (RPC) mechanism originally developed for Linux to replace - existing and competing IPC solutions with one unified protocol + Extends QtCore with GUI functionality. - --- + .. grid-item-card:: :mod:`QtHelp <PySide6.QtHelp>` - :mod:`QtDesigner <PySide6.QtDesigner>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes for integrating online documentation in applications. - Provides classes to extend Qt Designer. + .. grid-item-card:: :mod:`Qt Multimedia <PySide6.QtMultimedia>` - --- + Provides API for multimedia-specific use cases. - :mod:`QtGui <PySide6.QtGui>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt Multimedia Widgets <PySide6.QtMultimediaWidgets>` - Extends QtCore with GUI functionality. + Provides the widget-based multimedia API. - --- + .. grid-item-card:: :mod:`QtNetwork <PySide6.QtNetwork>` - :mod:`QtHelp <PySide6.QtHelp>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Offers classes that let you to write TCP/IP clients and servers. - Provides classes for integrating online documentation in applications. + .. grid-item-card:: :mod:`Qt Network Authorization <PySide6.QtNetworkAuth>` - --- + Provides a set of APIs that enable Qt applications to obtain limited + access to online accounts and HTTP services without exposing users' + passwords. - :mod:`QtNetwork <PySide6.QtNetwork>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtNfc <PySide6.QtNfc>` - Offers classes that let you to write TCP/IP clients and servers. + The NFC API provides connectivity between NFC enabled devices. - --- + .. grid-item-card:: :mod:`QtOpenGL <PySide6.QtOpenGL>` - :mod:`QtNfc <PySide6.QtNfc>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Offers classes that make it easy to use OpenGL in Qt applications. - The NFC API provides connectivity between NFC enabled devices. + .. grid-item-card:: :mod:`QtOpenGL Widgets <PySide6.QtOpenGLWidgets>` - --- + Provides the OpenGLWidget class enabling OpenGL rendering for + a certain part of the widget tree. - :mod:`QtNetworkAuth <PySide6.QtNetworkAuth>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt Positioning <PySide6.QtPositioning>` - Provides a set of APIs that enable Qt applications to obtain limited - access to online accounts and HTTP services without exposing users' - passwords. + Provides access to position, satellite info and area monitoring + classes. - --- + .. grid-item-card:: :mod:`Qt PDF <PySide6.QtPdf>` - :mod:`QtRemoteObjects <PySide6.QtRemoteObjects>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Classes and functions for rendering PDF documents. - Inter-Process Communication (IPC) module developed for Qt. This module - extends Qt's existing functionalities to enable information exchange - between processes or computers, easily. + .. grid-item-card:: :mod:`Qt PDF Widgets <PySide6.QtPdfWidgets>` - --- + A PDF viewer widget. - :mod:`QtOpenGL <PySide6.QtOpenGL>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtPrintSupport <PySide6.QtPrintSupport>` - Offers classes that make it easy to use OpenGL in Qt applications. + Provides extensive cross-platform support for printing. - --- + .. grid-item-card:: :mod:`QtQml <PySide6.QtQml>` - :mod:`QtOpenGLFunctions <PySide6.QtOpenGLFunctions>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Python API for Qt QML. - The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. + .. grid-item-card:: :mod:`QtQuick <PySide6.QtQuick>` - --- + Provides classes for embedding Qt Quick in Qt applications. - :mod:`QtOpenGLWidgets <PySide6.QtOpenGLWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` - The QOpenGLWidget class is a widget for rendering OpenGL graphics. + Provides classes for setting up the controls from C++. - --- + .. grid-item-card:: :mod:`QtQuickTest <PySide6.QtQuickTest>` - :mod:`QtPrintSupport <PySide6.QtPrintSupport>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + A unit test framework for QML applications where test cases are written as JavaScript functions. - Provides extensive cross-platform support for printing. + .. grid-item-card:: :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` - --- + Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - :mod:`QtQml <PySide6.QtQml>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtRemoteObjects <PySide6.QtRemoteObjects>` - Python API for Qt QML. + Inter-Process Communication (IPC) module developed for Qt. This module + extends Qt's existing functionalities to enable information exchange + between processes or computers, easily. - --- + .. grid-item-card:: :mod:`Qt Scxml <PySide6.QtScxml>` - :mod:`QtQuick <PySide6.QtQuick>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes to create and use state machines from SCXML files. - Provides classes for embedding Qt Quick in Qt applications. + .. grid-item-card:: :mod:`Qt Sensors <PySide6.QtSensors>` - --- + Provides access to sensor hardware. - :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt Serial Bus <PySide6.QtSerialBus>` - Provides classes for setting up the controls from C++. + Provides access to serial industrial bus interfaces. Currently, the + module supports the CAN bus and Modbus protocols. - --- + .. grid-item-card:: :mod:`Qt Serial Port <PySide6.QtSerialPort>` - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes to interact with hardware and virtual serial ports. - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. + .. grid-item-card:: :mod:`Qt Spatial Audio <PySide6.QtSpatialAudio>` - --- + Provides APIs for modeling sound source and their surrounds in 3D + space. - :mod:`Qt Scxml <PySide6.QtScxml>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtSql <PySide6.QtSql>` - Provides classes to create and use state machines from SCXML files. + Helps you provide seamless database integration to your Qt + applications. - --- + .. grid-item-card:: :mod:`QtStateMachine <PySide6.QtStateMachine>` - :mod:`QtSql <PySide6.QtSql>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes for creating and executing state graphs. - Helps you provide seamless database integration to your Qt applications. + .. grid-item-card:: :mod:`QtSvg <PySide6.QtSvg>` - --- + Provides classes for displaying the contents of SVG files. - :mod:`QtStateMachine <PySide6.QtStateMachine>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` - Provides classes for creating and executing state graphs. + Provides a widget that is used to display the contents of SVG files. - --- + .. grid-item-card:: :mod:`QtTest <PySide6.QtTest>` - :mod:`QtSerialPort <PySide6.QtSerialPort>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes for unit testing Qt applications and libraries. - Provides the basic functionality, which includes configuring, I/O - operations, getting and setting the control signals of the RS-232 - pinouts. + .. grid-item-card:: :mod:`QtUiTools <PySide6.QtUiTools>` - --- + Provides classes to handle forms created with *Qt Widgets Designer*. - :mod:`QtSvg <PySide6.QtSvg>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt WebChannel <PySide6.QtWebChannel>` - Provides classes for displaying the contents of SVG files. + Provides access to QObject or QML objects from HTML clients for + seamless integration of Qt applications with HTML/JavaScript clients. - --- + .. grid-item-card:: :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>` - :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides public API shared by both QtWebEngine and QtWebEngineWidgets. - Provides a widget that is used to display the contents of SVG files. + .. grid-item-card:: :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` - --- + Provides C++ classes for rendering web content in a QWidget based + application. - :mod:`QtTest <PySide6.QtTest>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtWebEngine QML Types <PySide6.QtWebEngineQuick>` - Provides classes for unit testing Qt applications and libraries. + Provides QML types for rendering web content within a QML application. - --- + .. grid-item-card:: :mod:`Qt WebSockets <PySide6.QtWebSockets>` - :mod:`QtUiTools <PySide6.QtUiTools>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides WebSocket communication compliant with RFC 6455. - Provides classes to handle forms created with Qt Designer. + .. grid-item-card:: :mod:`QtWidgets <PySide6.QtWidgets>` - --- + Extends Qt GUI with C++ widget functionality. - :mod:`QtWidgets <PySide6.QtWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`QtXml <PySide6.QtXml>` - Extends Qt GUI with C++ widget functionality. + Provides a C++ implementation of DOM. - --- + .. grid-item-card:: :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>` - :mod:`QtXml <PySide6.QtXml>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides basic elements required to animate 3D objects. - Provides a C++ implementation of DOM. + .. grid-item-card:: :mod:`Qt3D Core <PySide6.Qt3DCore>` - --- + Contains functionality to support near-realtime simulation systems. - :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt3D Extras <PySide6.Qt3DExtras>` - Provides basic elements required to animate 3D objects. + Provides a set of prebuilt elements to help you get started with Qt 3D. - --- + .. grid-item-card:: :mod:`Qt3D Input <PySide6.Qt3DInput>` - :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Provides classes for handling user input in applications using Qt 3D. - Provides public API shared by both QtWebEngine and QtWebEngineWidgets. + .. grid-item-card:: :mod:`Qt3D Logic <PySide6.Qt3DLogic>` - --- + Enables synchronizing frames with the Qt 3D backend. - :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + .. grid-item-card:: :mod:`Qt3D Render <PySide6.Qt3DRender>` - Provides C++ classes for rendering web content in a QWidget based application. + Contains functionality to support 2D and 3D rendering using Qt 3D. - --- + .. grid-item-card:: :mod:`QtAsyncio <PySide6.QtAsyncio>` - :mod:`QtWebEngine QML Types <PySide6.QtWebEngineQuick>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Provides QML types for rendering web content within a QML application. - - --- - - :mod:`Qt3D Core <PySide6.Qt3DCore>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Contains functionality to support near-realtime simulation systems. - - --- - - :mod:`Qt3D Extras <PySide6.Qt3DExtras>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Provides a set of prebuilt elements to help you get started with Qt 3D. - - --- - - :mod:`Qt3D Input <PySide6.Qt3DInput>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Provides classes for handling user input in applications using Qt 3D. - - --- - - :mod:`Qt3D Logic <PySide6.Qt3DLogic>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Enables synchronizing frames with the Qt 3D backend. - - --- - - :mod:`Qt3D Render <PySide6.Qt3DRender>` - ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - - Contains functionality to support 2D and 3D rendering using Qt 3D. + Provides integration between asyncio and Qt's event loop. |