diff options
| author | Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2020-12-27 21:45:13 +0100 |
|---|---|---|
| committer | Cristian Maureira-Fredes <Cristian.Maureira-Fredes@qt.io> | 2021-02-04 12:56:16 +0100 |
| commit | a6c7e9d7fd65946762766e40793ba86291bcca1a (patch) | |
| tree | f99eb63a95680f0ad364d838c1088e7875bc9dfc /sources/pyside6/doc/api.rst | |
| parent | 961cc3afb3b4c680f98dd52bb3d5a2d03cb424c1 (diff) | |
doc: general update and add more information
Updates:
* Refreshing the information on installing and building PySide
* Adding hyperlinks to some files
* Including PySide installation GIF (from Wiki)
* Modifying the CSS to improve the code snippets, :command: role,
and adding layout for two columns.
New tutorials
* QTableWidget
* QTreeWidget
New documentation
* Differences between Widgets and QML
* IDE information (+ QtCreator GIF from Wiki)
* When to use Shiboken
* file types explanation
* Summary on distributing applications
Pick-to: 6.0
Change-Id: I5195cc5a4af858bb7aad7891d14562ca07b6df23
Reviewed-by: Christian Tismer <tismer@stackless.com>
Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io>
Diffstat (limited to 'sources/pyside6/doc/api.rst')
| -rw-r--r-- | sources/pyside6/doc/api.rst | 57 |
1 files changed, 7 insertions, 50 deletions
diff --git a/sources/pyside6/doc/api.rst b/sources/pyside6/doc/api.rst index a246dd52c..f2eaf1f11 100644 --- a/sources/pyside6/doc/api.rst +++ b/sources/pyside6/doc/api.rst @@ -9,78 +9,35 @@ Basic modules These are the main modules that help you build a Widget-based UI. +---------------------------------------+--------------------------------------------------------+ -| :mod:`Qt Core <PySide6.QtCore>` | Provides core non-GUI functionality, like signal and | +| :mod:`QtCore <PySide6.QtCore>` | Provides core non-GUI functionality, like signal and | | | slots, properties, base classes of item models, | | | serialization, and more. | +---------------------------------------+--------------------------------------------------------+ -| :mod:`Qt GUI <PySide6.QtGui>` | Extends QtCore with GUI functionality: Events, windows | +| :mod:`QtGui <PySide6.QtGui>` | Extends QtCore with GUI functionality: Events, windows | | | and screens, OpenGL and raster-based 2D painting, as | | | well as images. | +---------------------------------------+--------------------------------------------------------+ -| :mod:`Qt Widgets <PySide6.QtWidgets>` | Provides ready to use Widgets for your application, | +| :mod:`QtWidgets <PySide6.QtWidgets>` | Provides ready to use Widgets for your application, | | | including graphical elements for your UI. | +---------------------------------------+--------------------------------------------------------+ QML and Qt Quick ---------------- -Use these modules to interact with the `QML Language <https://doc.qt.io/qt-5.qmlapplications>`, +Use these modules to interact with the `QML Language <https://doc.qt.io/qt-5.qmlapplications>`_, from Python. +-------------------------------------------------+----------------------------------------------+ -| :mod:`Qt QML <PySide6.QtQml>` | The base Python API to interact with the | +| :mod:`QtQml <PySide6.QtQml>` | The base Python API to interact with the | | | module. | +-------------------------------------------------+----------------------------------------------+ -| :mod:`Qt Quick <PySide6.QtQuick>` | Provides classes to embed Qt Quick in Qt | +| :mod:`QtQuick <PySide6.QtQuick>` | Provides classes to embed Qt Quick in Qt | | | applications. | +-------------------------------------------------+----------------------------------------------+ -| :mod:`Qt QuickWidgets <PySide6.QtQuickWidgets>` | Provides the QQuickWidget class to embed Qt | +| :mod:`QtQuickWidgets <PySide6.QtQuickWidgets>` | Provides the QQuickWidget class to embed Qt | | | Quick in widget-based applications. | +-------------------------------------------------+----------------------------------------------+ -Data visualization ------------------- - -Charts, diagrams, animations: these modules provide classes to help you include these elements in -your UI. - -+------------------------------------------------------------+-----------------------------------+ -| :mod:`Qt Charts <PySide6.QtCharts>` | Provides a set of easy to use | -| | chart components. | -+------------------------------------------------------------+-----------------------------------+ -| :mod:`Qt DataVisualization <PySide6.QtDataVisualization>` | Provides a way to visualize data | -| | in 3D as bar, scatter, or surface | -| | graphs. | -+------------------------------------------------------------+-----------------------------------+ - -Multimedia ------------ - -Audio, video, and hardware interaction: use these modules for multimedia solutions. - -+------------------------------------------------------------+-----------------------------------+ -| :mod:`Qt Multimedia <PySide6.QtMultimedia>` | Provides low-level multimedia | -| | functionality. | -+------------------------------------------------------------+-----------------------------------+ -| :mod:`Qt MultimediaWidgets <PySide6.QtMultimediaWidgets>` | Provides the widget-based | -| | multimedia API. | -+------------------------------------------------------------+-----------------------------------+ - -WebEngine ---------- - -If your project is based on a browser or the features around Web-based applications, use these -modules to interact with them. - -+---------------------------------------------------------+--------------------------------------+ -| :mod:`Qt WebEngineWidgets <PySide6.QtWebEngineWidgets>` | Provides widgets to handle Web | -| | content. | -+---------------------------------------------------------+--------------------------------------+ -| :mod:`Qt WebChannel <PySide6.QtWebChannel>` | Enables peer-to-peer communication | -| | between a server and a client | -| | (HTML/JavaScript or QML application).| -+---------------------------------------------------------+--------------------------------------+ - All the modules --------------- |