aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside2/doc/api.rst
diff options
context:
space:
mode:
authorCristián Maureira-Fredes <cristian.maureira-fredes@qt.io>2019-11-26 08:16:03 +0100
committerCristián Maureira-Fredes <cristian.maureira-fredes@qt.io>2019-12-03 10:43:45 +0100
commitd4764a4c514ec15f4cd680143cbd189482af6251 (patch)
treee3ab990446021a30ff00a54769d9a62266a893a2 /sources/pyside2/doc/api.rst
parent26404dd4b6c61083bf5de1c1c2208bf2350aba0e (diff)
New documentation structure
- New structure for the landing page, - Some rst were renamed to the new structure, - New sections "Videos", "Examples" and "Getting Started" were created, - Information from the wiki was used to create the Getting Started sections, - FAQ section was removed, - Removing pyhtml2devhelp.py since it is unused, - The new CSS modifications were copied over the Shiboken2 directory. Task-number: PYSIDE-1067 Change-Id: I1ba53cd0030d6d02449fecdfea70efb49421ad3b Reviewed-by: Friedemann Kleint <Friedemann.Kleint@qt.io> Reviewed-by: Kavindra Palaraja <kpalaraja@luxoft.com>
Diffstat (limited to 'sources/pyside2/doc/api.rst')
-rw-r--r--sources/pyside2/doc/api.rst67
1 files changed, 67 insertions, 0 deletions
diff --git a/sources/pyside2/doc/api.rst b/sources/pyside2/doc/api.rst
new file mode 100644
index 000000000..34d065f49
--- /dev/null
+++ b/sources/pyside2/doc/api.rst
@@ -0,0 +1,67 @@
+.. _pyside-api:
+|project| Modules
+=================
+
+Basic modules
+-------------
+ These are the main modules that will help you build a Widget based UI.
+
+ :mod:`Qt Core <PySide2.QtCore>`
+ Provides core non-GUI functionality, like signal and slots, properties, base classes of item models, serialization, etc.
+ :mod:`Qt GUI <PySide2.QtGui>`
+ Extends QtCore with GUI functionality: Events, windows and screens, OpenGL and raster-based 2D painting, images.
+ :mod:`Qt Widgets <PySide2.QtWidgets>`
+ 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>`, these
+ modules will help you interact with it from Python.
+
+ :mod:`Qt QML <PySide2.QtQml>`
+ Base Python API to interact with the QML module.
+ :mod:`Qt Quick <PySide2.QtQuick>`
+ Provides classes for embedding Qt Quick in Qt applications.
+ :mod:`Qt QuickWidgets <PySide2.QtQuickWidgets>`
+ Provides the QQuickWidget class for embedding Qt Quick in widget-based applications.
+
+Data visualization
+------------------
+
+ Charts and diagrams: these modules provide a large amount
+ of classes that can help you include these elements in your UI.
+
+ :mod:`Qt Charts <PySide2.QtCharts>`
+ Provides a set of easy to use chart components.
+ :mod:`Qt DataVisualization <PySide2.QtDataVisualization>`
+ 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.
+
+ :mod:`Qt Multimedia <PySide2.QtMultimedia>`
+ Provides low-level multimedia functionality.
+ :mod:`Qt MultimediaWidgets <PySide2.QtMultimediaWidgets>`
+ 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.
+
+ :mod:`Qt WebEngineWidgets <PySide2.QtWebEngineWidgets>`
+ Provides widgets that can handle web content.
+ :mod:`Qt WebChannel <PySide2.QtWebChannel>`
+ Enables peer-to-peer communication between a server and a client
+ (HTML/JavaScript or QML application).
+
+All the modules
+---------------
+
+ Here is a complete list of modules supported by |pymodname|.
+
+ :doc:`Modules <modules>`