aboutsummaryrefslogtreecommitdiffstats
path: root/sources
diff options
context:
space:
mode:
authorCristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-11-09 14:32:43 +0100
committerCristián Maureira-Fredes <Cristian.Maureira-Fredes@qt.io>2021-11-10 09:52:50 +0100
commitc61a2358170b633ce590103108719ac3f6f153a2 (patch)
tree822b122ab1c85543bd2756fedec982a50fc48feb /sources
parent132d425a105749455e174563ec6b7123961c5076 (diff)
doc: replace api module table with panels
This fix the warnings introduced by a previous change. Pick-to: 6.2 Change-Id: Ie25db8f8e466103487cda9ca4032bd75fab69e7b Reviewed-by: Christian Tismer <tismer@stackless.com> Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources')
-rw-r--r--sources/pyside6/doc/api.rst74
-rw-r--r--sources/pyside6/doc/modules.rst377
-rw-r--r--sources/pyside6/doc/tutorials/index.rst1
3 files changed, 338 insertions, 114 deletions
diff --git a/sources/pyside6/doc/api.rst b/sources/pyside6/doc/api.rst
index f2eaf1f11..eac37a16c 100644
--- a/sources/pyside6/doc/api.rst
+++ b/sources/pyside6/doc/api.rst
@@ -8,18 +8,33 @@ 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. |
-+---------------------------------------+--------------------------------------------------------+
+.. panels::
+ :container: container-lg pb-3
+ :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
+
+ :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.
QML and Qt Quick
----------------
@@ -27,16 +42,31 @@ 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. |
-+-------------------------------------------------+----------------------------------------------+
+.. panels::
+ :container: container-lg pb-3
+ :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
+
+ :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.
All the modules
---------------
diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst
index 013401905..dcf481320 100644
--- a/sources/pyside6/doc/modules.rst
+++ b/sources/pyside6/doc/modules.rst
@@ -7,95 +7,288 @@ Qt Modules
PySide6/Qt*/index
-.. list-table::
- :widths: 150, 150
- :align: left
-
- - :mod:`QtBluetooth <PySide6.QtBluetooth>`
- The Bluetooth API provides connectivity between Bluetooth enabled devices.
- - :mod:`QtCharts <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>`
- Provides core non-GUI functionality.
- - :mod:`QtDataVisualization <PySide6.QtDataVisualization>`
- Provides a way to visualize data in 3D as bar, scatter, and surface graphs.
- - :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
- - :mod:`QtDesigner <PySide6.QtDesigner>`
- Provides classes to extend Qt Designer.
- - :mod:`QtGui <PySide6.QtGui>`
- Extends QtCore with GUI functionality.
- - :mod:`QtHelp <PySide6.QtHelp>`
- Provides classes for integrating online documentation in applications.
- - :mod:`QtNetwork <PySide6.QtNetwork>`
- Offers classes that let you to write TCP/IP clients and servers.
- - :mod:`QtNetworkAuth <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:`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.
- - :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>`
- Provides extensive cross-platform support for printing.
- - :mod:`QtQml <PySide6.QtQml>`
- Python API for Qt QML.
- - :mod:`QtQuick <PySide6.QtQuick>`
- Provides classes for embedding Qt Quick in Qt applications.
- - :mod:`QtQuickControls2 <PySide6.QtQuickControls2>`
- Provides classes for setting up the controls from C++.
- - :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>`
- Provides the QQuickWidget class for embedding Qt Quick in widget-based applications.
- - :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>`
- Provides classes for creating and executing state graphs.
- - :mod:`QtSerialPort <PySide6.QtSerialPort>`
- Provides the basic functionality, which includes configuring, I/O
- operations, getting and setting the control signals of the RS-232
- pinouts.
- - :mod:`QtSvg <PySide6.QtSvg>`
- Provides classes for displaying the contents of SVG files.
- - :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>`
- Provides a widget that is used to display the contents of SVG files.
- - :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>`
- Extends Qt GUI with C++ widget functionality.
- - :mod:`QtXml <PySide6.QtXml>`
- Provides a C++ implementation of DOM.
- - :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>`
- Provides basic elements required to animate 3D objects.
- - :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>`
- Provides public API shared by both QtWebEngine and QtWebEngineWidgets.
- - :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>`
- Provides C++ classes for rendering web content in a QWidget based application.
- - :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.
+.. panels::
+ :container: container-lg pb-3
+ :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
+
+ :mod:`QtBluetooth <PySide6.QtBluetooth>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ The Bluetooth API provides connectivity between Bluetooth enabled devices.
+
+ ---
+
+
+ :mod:`QtCharts <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>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides core non-GUI functionality.
+
+ ---
+
+ :mod:`QtDataVisualization <PySide6.QtDataVisualization>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides a way to visualize data in 3D as bar, scatter, and surface graphs.
+
+ ---
+
+ :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
+
+ ---
+
+ :mod:`QtDesigner <PySide6.QtDesigner>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes to extend Qt Designer.
+
+ ---
+
+ :mod:`QtGui <PySide6.QtGui>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Extends QtCore with GUI functionality.
+
+ ---
+
+ :mod:`QtHelp <PySide6.QtHelp>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes for integrating online documentation in applications.
+
+ ---
+
+ :mod:`QtNetwork <PySide6.QtNetwork>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Offers classes that let you to write TCP/IP clients and servers.
+
+ ---
+
+ :mod:`QtNetworkAuth <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:`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.
+
+ ---
+
+ :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>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides extensive cross-platform support for printing.
+
+ ---
+
+ :mod:`QtQml <PySide6.QtQml>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Python API for Qt QML.
+
+ ---
+
+ :mod:`QtQuick <PySide6.QtQuick>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes for embedding Qt Quick in Qt applications.
+
+ ---
+
+ :mod:`QtQuickControls2 <PySide6.QtQuickControls2>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes for setting up the controls from C++.
+
+ ---
+
+ :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides the QQuickWidget class for embedding Qt Quick in widget-based applications.
+
+ ---
+
+ :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>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes for creating and executing state graphs.
+
+ ---
+
+ :mod:`QtSerialPort <PySide6.QtSerialPort>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides the basic functionality, which includes configuring, I/O
+ operations, getting and setting the control signals of the RS-232
+ pinouts.
+
+ ---
+
+ :mod:`QtSvg <PySide6.QtSvg>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides classes for displaying the contents of SVG files.
+
+ ---
+
+ :mod:`QtSvgWidgets <PySide6.QtSvgWidgets>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides a widget that is used to display the contents of SVG files.
+
+ ---
+
+ :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>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Extends Qt GUI with C++ widget functionality.
+
+ ---
+
+ :mod:`QtXml <PySide6.QtXml>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides a C++ implementation of DOM.
+
+ ---
+
+ :mod:`Qt3DAnimation <PySide6.Qt3DAnimation>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides basic elements required to animate 3D objects.
+
+ ---
+
+ :mod:`QtWebEngine Core C++ Classes <PySide6.QtWebEngineCore>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides public API shared by both QtWebEngine and QtWebEngineWidgets.
+
+ ---
+
+ :mod:`QtWebEngine Widgets C++ Classes <PySide6.QtWebEngineWidgets>`
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+ Provides C++ classes for rendering web content in a QWidget based application.
+
+ ---
+
+ :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.
diff --git a/sources/pyside6/doc/tutorials/index.rst b/sources/pyside6/doc/tutorials/index.rst
index 88193af9e..2403b6d6b 100644
--- a/sources/pyside6/doc/tutorials/index.rst
+++ b/sources/pyside6/doc/tutorials/index.rst
@@ -159,6 +159,7 @@ names and how they look like.
basictutorial/widgets.rst
basictutorial/clickablebutton.rst
+ basictutorial/signals_and_slots.rst
basictutorial/dialog.rst
basictutorial/tablewidget.rst
basictutorial/treewidget.rst