summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKirill Burtsev <kirill.burtsev@qt.io>2021-04-30 22:16:30 +0200
committerKirill Burtsev <kirill.burtsev@qt.io>2021-05-06 09:07:12 +0200
commit88c9dc6801a583956e2eb5063544303b6f12f95d (patch)
treee71e2a5b07622a5cf455302b1b05d831c892e3bc
parentba57bbb0f8443a964e771fc65a3de807923bb71e (diff)
Doc: Add a note about navigation within a page to a fragment
Task-number: QTBUG-76802 Change-Id: I38cd148706c0479ffbad1e0d2877adc1cad9038d Reviewed-by: Peter Varga <pvarga@inf.u-szeged.hu> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>
-rw-r--r--src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
index 789d9794e..d88e8c48c 100644
--- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
+++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc
@@ -381,6 +381,12 @@
used as part of the user interface, and not to display external data, for example, when
displaying a list of results.
+ \note This function is not called for fragment navigation on the same page. Such navigation,
+ for example, happens by clicking a link to a '#fragment' within the page. It does not trigger
+ a load to a different document, even though it changes page's url and adds history entry.
+ It only serves as a shortcut to scroll within the page. Hence, no delegation of this navigation
+ type is expected to happen.
+
\note The loading process is started and the loadStarted() signal is emitted
\e before the request is accepted or rejected. Therefore, a loadFinished()
signal that returns \c false is to be expected even after delegating the