diff options
Diffstat (limited to 'sources/pyside6/doc/api.rst')
| -rw-r--r-- | sources/pyside6/doc/api.rst | 62 |
1 files changed, 37 insertions, 25 deletions
diff --git a/sources/pyside6/doc/api.rst b/sources/pyside6/doc/api.rst index f2eaf1f11..7bbe2ce1c 100644 --- a/sources/pyside6/doc/api.rst +++ b/sources/pyside6/doc/api.rst @@ -1,25 +1,30 @@ .. _pyside-api: -|project| Modules -================= +Modules API +=========== Basic modules ------------- These are the main modules that help you build a Widget-based UI. -+---------------------------------------+--------------------------------------------------------+ -| :mod:`QtCore <PySide6.QtCore>` | Provides core non-GUI functionality, like signal and | -| | slots, properties, base classes of item models, | -| | serialization, and more. | -+---------------------------------------+--------------------------------------------------------+ -| :mod:`QtGui <PySide6.QtGui>` | Extends QtCore with GUI functionality: Events, windows | -| | and screens, OpenGL and raster-based 2D painting, as | -| | well as images. | -+---------------------------------------+--------------------------------------------------------+ -| :mod:`QtWidgets <PySide6.QtWidgets>` | Provides ready to use Widgets for your application, | -| | including graphical elements for your UI. | -+---------------------------------------+--------------------------------------------------------+ +.. grid:: 1 3 3 3 + :gutter: 2 + + .. grid-item-card:: :mod:`QtCore <PySide6.QtCore>` + + Provides core non-GUI functionality, like signal and slots, properties, + base classes of item models, serialization, and more. + + .. grid-item-card:: :mod:`QtGui <PySide6.QtGui>` + + Extends QtCore with GUI functionality: Events, windows and screens, + OpenGL and raster-based 2D painting, as well as images. + + .. grid-item-card:: :mod:`QtWidgets <PySide6.QtWidgets>` + + Provides ready to use Widgets for your application, including graphical + elements for your UI. QML and Qt Quick ---------------- @@ -27,16 +32,21 @@ QML and Qt Quick Use these modules to interact with the `QML Language <https://doc.qt.io/qt-5.qmlapplications>`_, from Python. -+-------------------------------------------------+----------------------------------------------+ -| :mod:`QtQml <PySide6.QtQml>` | The base Python API to interact with the | -| | module. | -+-------------------------------------------------+----------------------------------------------+ -| :mod:`QtQuick <PySide6.QtQuick>` | Provides classes to embed Qt Quick in Qt | -| | applications. | -+-------------------------------------------------+----------------------------------------------+ -| :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` | Provides the QQuickWidget class to embed Qt | -| | Quick in widget-based applications. | -+-------------------------------------------------+----------------------------------------------+ +.. grid:: 1 3 3 3 + :gutter: 2 + + .. grid-item-card:: :mod:`QtQml <PySide6.QtQml>` + + The base Python API to interact with the module. + + .. grid-item-card:: :mod:`QtQuick <PySide6.QtQuick>` + + Provides classes to embed Qt Quick in Qt applications. + + .. grid-item-card:: :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` + + Provides the QQuickWidget class to embed Qt Quick in widget-based + applications. All the modules --------------- @@ -44,4 +54,6 @@ All the modules There are many other modules currently supported by |pymodname|, here you can find a complete list of them. - :doc:`Check all the modules <modules>` +.. toctree:: + + modules.rst |