diff options
Diffstat (limited to 'sources/pyside6/doc')
| -rw-r--r-- | sources/pyside6/doc/extras/QtWebView.rst | 25 | ||||
| -rw-r--r-- | sources/pyside6/doc/modules.rst | 4 |
2 files changed, 29 insertions, 0 deletions
diff --git a/sources/pyside6/doc/extras/QtWebView.rst b/sources/pyside6/doc/extras/QtWebView.rst new file mode 100644 index 000000000..1b029ac0d --- /dev/null +++ b/sources/pyside6/doc/extras/QtWebView.rst @@ -0,0 +1,25 @@ + +Qt WebView lets you display web content inside a QML application. To avoid including a full web +browser stack, Qt WebView uses native APIs where appropriate. + +Getting Started +^^^^^^^^^^^^^^^ + +To include the definitions of modules classes, use the following +directive: + + :: + + from PySide6.QtWebView import QtWebView + +To make the Qt WebView module function correctly across all platforms, it's +necessary to call ``QtWebView.initialize()`` before creating the QGuiApplication +instance and before window's QPlatformOpenGLContext is created. For usage, +see the ``minibrowser`` example in the PySide6 examples package. + +API Reference +^^^^^^^^^^^^^ + + * `Qt API <https://doc.qt.io/qt-6/qtwebview-index.html>`_ + +The module also provides `QML types <https://doc.qt.io/qt-6/qtwebview-index.html#qml-api>`_ diff --git a/sources/pyside6/doc/modules.rst b/sources/pyside6/doc/modules.rst index 8e77a4616..f108f5657 100644 --- a/sources/pyside6/doc/modules.rst +++ b/sources/pyside6/doc/modules.rst @@ -232,3 +232,7 @@ Qt Modules Supported by Qt for Python .. grid-item-card:: :mod:`QtAsyncio <PySide6.QtAsyncio>` Provides integration between asyncio and Qt's event loop. + + .. grid-item-card:: :mod:`QtWebView <PySide6.QtWebView>` + + Enables displaying web content in a QML application. |