Commit 32424c28 authored by Leena Miettinen's avatar Leena Miettinen Committed by Joerg Bornemann
Browse files

Doc: add docs for WebEngineSingleton type


Task-number: QTBUG-47912
Change-Id: Iabc06b4ce78eb81955d60cdebccef40fef9a21b3
Reviewed-by: default avatarKai Koehne <kai.koehne@theqtcompany.com>
Showing with 36 additions and 0 deletions
...@@ -41,11 +41,47 @@ ...@@ -41,11 +41,47 @@
QT_BEGIN_NAMESPACE QT_BEGIN_NAMESPACE
/*!
\qmltype WebEngine
\instantiates QQuickWebEngineSingleton
\inqmlmodule QtWebEngine 1.1
\since QtWebEngine 1.1
\brief Provides access to the default settings and profiles shared by all web engine views.
The WebEngine singleton type provides access to the default profile and the default settings
shared by all web engine views. It can be used to change settings globally, as illustrated by
the following code snippet:
\code
Component.onCompleted: {
WebEngine.settings.javaScriptEnabled = true;
}
\endcode
*/
/*!
\qmlproperty WebEngineSettings WebEngine::settings
\readonly
\since QtWebEngine 1.1
Default settings for all web engine views.
\sa WebEngineSettings
*/
QQuickWebEngineSettings *QQuickWebEngineSingleton::settings() const QQuickWebEngineSettings *QQuickWebEngineSingleton::settings() const
{ {
return defaultProfile()->settings(); return defaultProfile()->settings();
} }
/*!
\qmlproperty WebEngineProfile WebEngine::defaultProfile
\readonly
\since QtWebEngine 1.1
Default profile for all web engine views.
\sa WebEngineProfile
*/
QQuickWebEngineProfile *QQuickWebEngineSingleton::defaultProfile() const QQuickWebEngineProfile *QQuickWebEngineSingleton::defaultProfile() const
{ {
return QQuickWebEngineProfile::defaultProfile(); return QQuickWebEngineProfile::defaultProfile();
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment