diff options
Diffstat (limited to 'sources/pyside6/doc/modules.rst')
| -rw-r--r-- | sources/pyside6/doc/modules.rst | 255 |
1 files changed, 202 insertions, 53 deletions
diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 31937f291..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,79 +7,228 @@ Qt Modules PySide6/Qt*/index -.. list-table:: - :widths: 150, 150 - :align: left +.. grid:: 1 3 3 3 + :gutter: 2 + + .. grid-item-card:: :mod:`QtBluetooth <PySide6.QtBluetooth>` + + The Bluetooth API provides connectivity between Bluetooth enabled + devices. + + + .. grid-item-card:: :mod:`QtCharts <PySide6.QtCharts>` - * - :mod:`Qt Charts <PySide6.QtCharts>` Provides a set of easy to use chart components. - - :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:`QtCore <PySide6.QtCore>` + + .. 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. + + + .. grid-item-card:: :mod:`QtCore <PySide6.QtCore>` + Provides core non-GUI functionality. - - :mod:`Qt DataVisualization <PySide6.QtDataVisualization>` - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - * - :mod:`QtDesigner <PySide6.QtDesigner>` - Provides classes to extend Qt Designer. - - :mod:`QtGui <PySide6.QtGui>` + + .. grid-item-card:: :mod:`QtDataVisualization <PySide6.QtDataVisualization>` + + Provides a way to visualize data in 3D as bar, scatter, and surface + graphs. + + .. grid-item-card:: :mod:`QtDBus <PySide6.QtDBus>` + + 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 + + .. grid-item-card:: :mod:`QtDesigner <PySide6.QtDesigner>` + + Provides classes to extend *Qt Widgets Designer*. + + .. grid-item-card:: :mod:`QtGui <PySide6.QtGui>` + Extends QtCore with GUI functionality. - * - :mod:`QtHelp <PySide6.QtHelp>` + + .. grid-item-card:: :mod:`QtHelp <PySide6.QtHelp>` + Provides classes for integrating online documentation in applications. - - :mod:`QtNetwork <PySide6.QtNetwork>` + + .. grid-item-card:: :mod:`Qt Multimedia <PySide6.QtMultimedia>` + + Provides API for multimedia-specific use cases. + + .. grid-item-card:: :mod:`Qt Multimedia Widgets <PySide6.QtMultimediaWidgets>` + + Provides the widget-based multimedia API. + + .. grid-item-card:: :mod:`QtNetwork <PySide6.QtNetwork>` + Offers classes that let you to write TCP/IP clients and servers. - * - :mod:`QtOpenGL <PySide6.QtOpenGL>` + + .. 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. + + .. grid-item-card:: :mod:`QtNfc <PySide6.QtNfc>` + + The NFC API provides connectivity between NFC enabled devices. + + .. grid-item-card:: :mod:`QtOpenGL <PySide6.QtOpenGL>` + Offers classes that make it easy to use OpenGL in Qt applications. - - :mod:`QtOpenGLFunctions <PySide6.QtOpenGLFunctions>` - The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. - * - :mod:`QtOpenGLWidgets <PySide6.QtOpenGLWidgets>` - The QOpenGLWidget class is a widget for rendering OpenGL graphics. - - :mod:`QtPrintSupport <PySide6.QtPrintSupport>` + + .. grid-item-card:: :mod:`QtOpenGL Widgets <PySide6.QtOpenGLWidgets>` + + Provides the OpenGLWidget class enabling OpenGL rendering for + a certain part of the widget tree. + + .. grid-item-card:: :mod:`Qt Positioning <PySide6.QtPositioning>` + + Provides access to position, satellite info and area monitoring + classes. + + .. grid-item-card:: :mod:`Qt PDF <PySide6.QtPdf>` + + Classes and functions for rendering PDF documents. + + .. grid-item-card:: :mod:`Qt PDF Widgets <PySide6.QtPdfWidgets>` + + A PDF viewer widget. + + .. grid-item-card:: :mod:`QtPrintSupport <PySide6.QtPrintSupport>` + Provides extensive cross-platform support for printing. - * - :mod:`QtQml <PySide6.QtQml>` + + .. grid-item-card:: :mod:`QtQml <PySide6.QtQml>` + Python API for Qt QML. - - :mod:`QtQuick <PySide6.QtQuick>` + + .. grid-item-card:: :mod:`QtQuick <PySide6.QtQuick>` + Provides classes for embedding Qt Quick in Qt applications. - * - :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` + + .. grid-item-card:: :mod:`QtQuickControls2 <PySide6.QtQuickControls2>` + Provides classes for setting up the controls from C++. - - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` + + .. grid-item-card:: :mod:`QtQuickTest <PySide6.QtQuickTest>` + + A unit test framework for QML applications where test cases are written as JavaScript functions. + + .. grid-item-card:: :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` + Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - * - :mod:`Qt Scxml <PySide6.QtScxml>` + + .. grid-item-card:: :mod:`QtRemoteObjects <PySide6.QtRemoteObjects>` + + 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>` + Provides classes to create and use state machines from SCXML files. - - :mod:`QtSql <PySide6.QtSql>` - Helps you provide seamless database integration to your Qt applications. - * - :mod:`QtStateMachine <PySide6.QtStateMachine>` + + .. grid-item-card:: :mod:`Qt Sensors <PySide6.QtSensors>` + + Provides access to sensor hardware. + + .. grid-item-card:: :mod:`Qt Serial Bus <PySide6.QtSerialBus>` + + 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>` + + Provides classes to interact with hardware and virtual serial ports. + + .. grid-item-card:: :mod:`Qt Spatial Audio <PySide6.QtSpatialAudio>` + + Provides APIs for modeling sound source and their surrounds in 3D + space. + + .. grid-item-card:: :mod:`QtSql <PySide6.QtSql>` + + Helps you provide seamless database integration to your Qt + applications. + + .. grid-item-card:: :mod:`QtStateMachine <PySide6.QtStateMachine>` + Provides classes for creating and executing state graphs. - - :mod:`QtSvg <PySide6.QtSvg>` + + .. grid-item-card:: :mod:`QtSvg <PySide6.QtSvg>` + Provides classes for displaying the contents of SVG files. - * - :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` + + .. grid-item-card:: :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>` + Provides a widget that is used to display the contents of SVG files. - - :mod:`QtTest <PySide6.QtTest>` + + .. grid-item-card:: :mod:`QtTest <PySide6.QtTest>` + Provides classes for unit testing Qt applications and libraries. - * - :mod:`QtUiTools <PySide6.QtUiTools>` - Provides classes to handle forms created with Qt Designer. - - :mod:`QtWidgets <PySide6.QtWidgets>` + + .. grid-item-card:: :mod:`QtUiTools <PySide6.QtUiTools>` + + Provides classes to handle forms created with *Qt Widgets Designer*. + + .. grid-item-card:: :mod:`Qt WebChannel <PySide6.QtWebChannel>` + + 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>` + + Provides public API shared by both QtWebEngine and QtWebEngineWidgets. + + .. grid-item-card:: :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` + + Provides C++ classes for rendering web content in a QWidget based + application. + + .. grid-item-card:: :mod:`QtWebEngine QML Types <PySide6.QtWebEngineQuick>` + + Provides QML types for rendering web content within a QML application. + + .. grid-item-card:: :mod:`Qt WebSockets <PySide6.QtWebSockets>` + + Provides WebSocket communication compliant with RFC 6455. + + .. grid-item-card:: :mod:`QtWidgets <PySide6.QtWidgets>` + Extends Qt GUI with C++ widget functionality. - * - :mod:`QtXml <PySide6.QtXml>` + + .. grid-item-card:: :mod:`QtXml <PySide6.QtXml>` + Provides a C++ implementation of DOM. - - :mod:`Qt 3D Animation <PySide6.Qt3DAnimation>` + + .. grid-item-card:: :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>` + Provides basic elements required to animate 3D objects. - * - :mod:`Qt WebEngine Core C++ Classes <PySide6.QtWebEngineCore>` - Provides public API shared by both QtWebEngine and QtWebEngineWidgets. - - :mod:`Qt WebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>` - Provides C++ classes for rendering web content in a QWidget based application. - * - :mod:`Qt WebEngine QML Types <PySide6.QtWebEngineQuick>` - Provides QML types for rendering web content within a QML application. - - - * - :mod:`Qt 3D Core <PySide6.Qt3DCore>` + + .. grid-item-card:: :mod:`Qt3D Core <PySide6.Qt3DCore>` + Contains functionality to support near-realtime simulation systems. - - :mod:`Qt 3D Extras <PySide6.Qt3DExtras>` + + .. grid-item-card:: :mod:`Qt3D Extras <PySide6.Qt3DExtras>` + Provides a set of prebuilt elements to help you get started with Qt 3D. - * - :mod:`Qt 3D Input <PySide6.Qt3DInput>` + + .. grid-item-card:: :mod:`Qt3D Input <PySide6.Qt3DInput>` + Provides classes for handling user input in applications using Qt 3D. - - :mod:`Qt 3D Logic <PySide6.Qt3DLogic>` + + .. grid-item-card:: :mod:`Qt3D Logic <PySide6.Qt3DLogic>` + Enables synchronizing frames with the Qt 3D backend. - * - :mod:`Qt 3D Render <PySide6.Qt3DRender>` + + .. grid-item-card:: :mod:`Qt3D Render <PySide6.Qt3DRender>` + Contains functionality to support 2D and 3D rendering using Qt 3D. - - + + .. grid-item-card:: :mod:`QtAsyncio <PySide6.QtAsyncio>` + + Provides integration between asyncio and Qt's event loop. |