From c61a2358170b633ce590103108719ac3f6f153a2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=C3=A1n=20Maureira-Fredes?= Date: Tue, 9 Nov 2021 14:32:43 +0100 Subject: 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 Reviewed-by: Friedemann Kleint --- sources/pyside6/doc/api.rst | 74 +++++-- sources/pyside6/doc/modules.rst | 377 ++++++++++++++++++++++++-------- sources/pyside6/doc/tutorials/index.rst | 1 + 3 files changed, 338 insertions(+), 114 deletions(-) (limited to 'sources') 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 ` | Provides core non-GUI functionality, like signal and | -| | slots, properties, base classes of item models, | -| | serialization, and more. | -+---------------------------------------+--------------------------------------------------------+ -| :mod:`QtGui ` | Extends QtCore with GUI functionality: Events, windows | -| | and screens, OpenGL and raster-based 2D painting, as | -| | well as images. | -+---------------------------------------+--------------------------------------------------------+ -| :mod:`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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides core non-GUI functionality, like signal and + slots, properties, base classes of item models, + serialization, and more. + + --- + + :mod:`QtGui ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Extends QtCore with GUI functionality: Events, windows + and screens, OpenGL and raster-based 2D painting, as + well as images. + + --- + + :mod:`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 `_, from Python. -+-------------------------------------------------+----------------------------------------------+ -| :mod:`QtQml ` | The base Python API to interact with the | -| | module. | -+-------------------------------------------------+----------------------------------------------+ -| :mod:`QtQuick ` | Provides classes to embed Qt Quick in Qt | -| | applications. | -+-------------------------------------------------+----------------------------------------------+ -| :mod:`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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + The base Python API to interact with the + module. + + --- + + :mod:`QtQuick ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes to embed Qt Quick in Qt + applications. + + --- + + :mod:`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 ` - The Bluetooth API provides connectivity between Bluetooth enabled devices. - - :mod:`QtCharts ` - Provides a set of easy to use chart components. - - :mod:`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 ` - Provides core non-GUI functionality. - - :mod:`QtDataVisualization ` - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - - :mod:`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 ` - Provides classes to extend Qt Designer. - - :mod:`QtGui ` - Extends QtCore with GUI functionality. - - :mod:`QtHelp ` - Provides classes for integrating online documentation in applications. - - :mod:`QtNetwork ` - Offers classes that let you to write TCP/IP clients and servers. - - :mod:`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 ` - 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 ` - Offers classes that make it easy to use OpenGL in Qt applications. - - :mod:`QtOpenGLFunctions ` - The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. - - :mod:`QtOpenGLWidgets ` - The QOpenGLWidget class is a widget for rendering OpenGL graphics. - - :mod:`QtPrintSupport ` - Provides extensive cross-platform support for printing. - - :mod:`QtQml ` - Python API for Qt QML. - - :mod:`QtQuick ` - Provides classes for embedding Qt Quick in Qt applications. - - :mod:`QtQuickControls2 ` - Provides classes for setting up the controls from C++. - - :mod:`QtQuickWidgets ` - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - - :mod:`Qt Scxml ` - Provides classes to create and use state machines from SCXML files. - - :mod:`QtSql ` - Helps you provide seamless database integration to your Qt applications. - - :mod:`QtStateMachine ` - Provides classes for creating and executing state graphs. - - :mod:`QtSerialPort ` - Provides the basic functionality, which includes configuring, I/O - operations, getting and setting the control signals of the RS-232 - pinouts. - - :mod:`QtSvg ` - Provides classes for displaying the contents of SVG files. - - :mod:`QtSvgWidgets ` - Provides a widget that is used to display the contents of SVG files. - - :mod:`QtTest ` - Provides classes for unit testing Qt applications and libraries. - - :mod:`QtUiTools ` - Provides classes to handle forms created with Qt Designer. - - :mod:`QtWidgets ` - Extends Qt GUI with C++ widget functionality. - - :mod:`QtXml ` - Provides a C++ implementation of DOM. - - :mod:`Qt3DAnimation ` - Provides basic elements required to animate 3D objects. - - :mod:`QtWebEngine Core C++ Classes ` - Provides public API shared by both QtWebEngine and QtWebEngineWidgets. - - :mod:`QtWebEngine Widgets C++ Classes ` - Provides C++ classes for rendering web content in a QWidget based application. - - :mod:`QtWebEngine QML Types ` - Provides QML types for rendering web content within a QML application. - - :mod:`Qt3D Core ` - Contains functionality to support near-realtime simulation systems. - - :mod:`Qt3D Extras ` - Provides a set of prebuilt elements to help you get started with Qt 3D. - - :mod:`Qt3D Input ` - Provides classes for handling user input in applications using Qt 3D. - - :mod:`Qt3D Logic ` - Enables synchronizing frames with the Qt 3D backend. - - :mod:`Qt3D Render ` - 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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + The Bluetooth API provides connectivity between Bluetooth enabled devices. + + --- + + + :mod:`QtCharts ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides a set of easy to use chart components. + + --- + + :mod:`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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides core non-GUI functionality. + + --- + + :mod:`QtDataVisualization ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides a way to visualize data in 3D as bar, scatter, and surface graphs. + + --- + + :mod:`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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes to extend Qt Designer. + + --- + + :mod:`QtGui ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Extends QtCore with GUI functionality. + + --- + + :mod:`QtHelp ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for integrating online documentation in applications. + + --- + + :mod:`QtNetwork ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Offers classes that let you to write TCP/IP clients and servers. + + --- + + :mod:`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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + 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 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Offers classes that make it easy to use OpenGL in Qt applications. + + --- + + :mod:`QtOpenGLFunctions ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + The QOpenGLFunctions class provides cross-platform access to the OpenGL ES 2.0 API. + + --- + + :mod:`QtOpenGLWidgets ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + The QOpenGLWidget class is a widget for rendering OpenGL graphics. + + --- + + :mod:`QtPrintSupport ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides extensive cross-platform support for printing. + + --- + + :mod:`QtQml ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Python API for Qt QML. + + --- + + :mod:`QtQuick ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for embedding Qt Quick in Qt applications. + + --- + + :mod:`QtQuickControls2 ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for setting up the controls from C++. + + --- + + :mod:`QtQuickWidgets ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. + + --- + + :mod:`Qt Scxml ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes to create and use state machines from SCXML files. + + --- + + :mod:`QtSql ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Helps you provide seamless database integration to your Qt applications. + + --- + + :mod:`QtStateMachine ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for creating and executing state graphs. + + --- + + :mod:`QtSerialPort ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides the basic functionality, which includes configuring, I/O + operations, getting and setting the control signals of the RS-232 + pinouts. + + --- + + :mod:`QtSvg ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for displaying the contents of SVG files. + + --- + + :mod:`QtSvgWidgets ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides a widget that is used to display the contents of SVG files. + + --- + + :mod:`QtTest ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for unit testing Qt applications and libraries. + + --- + + :mod:`QtUiTools ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes to handle forms created with Qt Designer. + + --- + + :mod:`QtWidgets ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Extends Qt GUI with C++ widget functionality. + + --- + + :mod:`QtXml ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides a C++ implementation of DOM. + + --- + + :mod:`Qt3DAnimation ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides basic elements required to animate 3D objects. + + --- + + :mod:`QtWebEngine Core C++ Classes ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides public API shared by both QtWebEngine and QtWebEngineWidgets. + + --- + + :mod:`QtWebEngine Widgets C++ Classes ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides C++ classes for rendering web content in a QWidget based application. + + --- + + :mod:`QtWebEngine QML Types ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides QML types for rendering web content within a QML application. + + --- + + :mod:`Qt3D Core ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Contains functionality to support near-realtime simulation systems. + + --- + + :mod:`Qt3D Extras ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides a set of prebuilt elements to help you get started with Qt 3D. + + --- + + :mod:`Qt3D Input ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Provides classes for handling user input in applications using Qt 3D. + + --- + + :mod:`Qt3D Logic ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + Enables synchronizing frames with the Qt 3D backend. + + --- + + :mod:`Qt3D Render ` + ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + + 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 -- cgit v1.2.3