diff options
Diffstat (limited to 'sources/pyside2/doc/index.rst')
| -rw-r--r-- | sources/pyside2/doc/index.rst | 87 |
1 files changed, 0 insertions, 87 deletions
diff --git a/sources/pyside2/doc/index.rst b/sources/pyside2/doc/index.rst deleted file mode 100644 index b0bb1d19c..000000000 --- a/sources/pyside2/doc/index.rst +++ /dev/null @@ -1,87 +0,0 @@ -|project| -************* - -|project| offers Python bindings for Qt, enabling the use of Qt5 APIs in Python -applications. It lets Python developers utilize the full potential of Qt, using -the |pymodname| module. - -The |pymodname| module provides access to the individual -Qt modules such as QtCore, QtGui, and so on. |project| also comes with the -:doc:`Shiboken2 <shiboken2:index>` CPython binding code generator, which can be -used to generate Python bindings for your C or C++ code. - -.. toctree:: - :name: mastertoc - :maxdepth: 2 - - contents.rst - Known issues <https://wiki.qt.io/Qt_for_Python/Considerations> - -Qt Modules -=========== - -Basic modules -------------- - These are the main modules that will help you build a Widget based UI. - - `Qt Core <PySide2/QtCore/index.html>`_ - Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc. - `Qt Gui <PySide2/QtGui/index.html>`_ - Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images. - `Qt Widgets <PySide2/QtWidgets/index.html>`_ - Ready to use Widgets for your application, including also graphical elements for your UI. - -QML and Qt Quick ----------------- - If you want to use the `Qml Language <https://doc.qt.io/qt-5/qmlapplications.html>`, these - modules will help you interact with it from Python. - - `Qt Qml <PySide2/QtQml/index.html>`_ - Base Python API to interact with the QML module. - `Qt Quick <PySide2/QtQuick/index.html>`_ - Provides classes for embedding Qt Quick in Qt applications. - `Qt QuickWidgets <PySide2/QtQuickWidgets/index.html>`_ - Provides the QQuickWidget class for embedding Qt Quick in widget-based applications. - -Data visualization ------------------- - - Charts, diagrams, animations: these modules provide a large amount - of classes that can help you include these elements in your UI. - - `Qt Charts <PySide2/QtCharts/index.html>`_ - Provides a set of easy to use chart components. - `Qt DataVisualization <PySide2/QtDataVisualization/index.html>`_ - Provides a way to visualize data in 3D as bar, scatter, and surface graphs. - -Multimedia ------------ - - Audio, video, and hardware interaction: check these modules if you are - looking for multimedia solutions. - - `Qt Multimedia <PySide2/QtMultimedia/index.html>`_ - Provides low-level multimedia functionality. - `Qt MultimediaWidgets <PySide2/QtMultimediaWidgets/index.html>`_ - Provides the widget-based multimedia API. - -WebEngine ---------- - - If your project is based on a browser or the features around web - based applications, these modules will help you to interact with them. - - `Qt WebEngineWidgets <PySide2/QtWebEngineWidgets/index.html>`_ - Provides widgets that can handle web content. - `Qt WebChannel <PySide2/QtWebChannel/index.html>`_ - Enables peer-to-peer communication between a server and a client - (HTML/JavaScript or QML application). - -All the modules ---------------- - - There are many other modules currently supported by |pymodname|, - here you can find a complete list of them. - - `Check all the modules <modules.html>`_ - Display a table with all the currently supported Qt modules. |