summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2019-05-13 09:57:13 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2019-06-07 14:44:43 +0200
commit156826376f47924e4ef57695ee233b051c336406 (patch)
treed46935274aa112dd63d63e5452d7154ebd5f4094
parentf7cc2f2a8038182d4c2c3c76a6ca97394a22b213 (diff)
Doc: Improve documentation for QWebEngineView::setHtml()
...and QWebEngineView::setContent()and WebEngineView.loadHtml() The baseUrl cannot be empty. Fixes: QTBUG-75760 Change-Id: If276767ed6a7a9421292299e0ac79d02bbbca0e3 Reviewed-by: Michal Klocek <michal.klocek@qt.io>
-rw-r--r--src/webengine/doc/src/webengineview_lgpl.qdoc3
-rw-r--r--src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc9
2 files changed, 9 insertions, 3 deletions
diff --git a/src/webengine/doc/src/webengineview_lgpl.qdoc b/src/webengine/doc/src/webengineview_lgpl.qdoc
index 6759c1a36..d790cccea 100644
--- a/src/webengine/doc/src/webengineview_lgpl.qdoc
+++ b/src/webengine/doc/src/webengineview_lgpl.qdoc
@@ -376,7 +376,8 @@
which references HTML pages via URL.
External objects, such as stylesheets or images referenced in the HTML
- document, should be located relative to \a baseUrl. For example, if \a html
+ document, should be located relative to \a baseUrl. For external objects to
+ be loaded, \c baseUrl cannot be empty. For example, if \a html
is retrieved from \c http://www.example.com/documents/overview.html, which
is the base URL, then an image referenced with the relative URL, \c diagram.png,
should be at \c{http://www.example.com/documents/diagram.png}.
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
index fce1e8d8f..1b7812dff 100644
--- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc
@@ -1,5 +1,5 @@
/*
- Copyright (C) 2015 The Qt Company Ltd.
+ Copyright (C) 2019 The Qt Company Ltd.
Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
Copyright (C) 2008 Holger Hans Peter Freyther
Copyright (C) 2009 Girish Ramakrishnan <girish@forwardbias.in>
@@ -125,7 +125,11 @@
Sets the content of the web view to the specified \a html content.
External objects, such as stylesheets or images referenced in the HTML
- document, are located relative to \a baseUrl.
+ document, are located relative to \a baseUrl. For external objects to
+ be loaded, \c baseUrl cannot be empty. For example, if \a html
+ is retrieved from \c http://www.example.com/documents/overview.html, which
+ is the base URL, then an image referenced with the relative URL, \c diagram.png,
+ should be at \c{http://www.example.com/documents/diagram.png}.
The HTML document is loaded immediately, whereas external objects are loaded asynchronously.
@@ -156,6 +160,7 @@
is empty, it is assumed that the content is \c{text/plain,charset=US-ASCII}.
External objects referenced in the content are located relative to \a baseUrl.
+ For external objects to be loaded, \c baseUrl cannot be empty.
The data is loaded immediately; external objects are loaded asynchronously.