diff options
| author | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2016-03-01 16:21:49 +0100 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> | 2016-03-23 08:20:56 +0000 |
| commit | fab5cff1171de54f43d9ab57ed16f8d0f85b433e (patch) | |
| tree | c3b68dd687b2013ee8ea2c0d2462ee6f224bb06f /src | |
| parent | f62f223b28989ee827f26969274f544c8e7d3e97 (diff) | |
Doc: Improve docs for the zoomFactor property
In the WebEngineView type and QWebEnginePage and
QWebEngineView docs.
Change-Id: Ibbabcf6cc38a48fb14abb105f5fda4c03a89ccba
Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/webengine/doc/src/webengineview.qdoc | 2 | ||||
| -rw-r--r-- | src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc | 6 | ||||
| -rw-r--r-- | src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc | 4 |
3 files changed, 8 insertions, 4 deletions
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index d2dc627a3..da0df4d9e 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -62,7 +62,7 @@ The title of an HTML page can be accessed with the \l title property. Additionally, a web page may specify an icon, which can be accessed using the \l icon property. The \l zoomFactor - property holds the overall size of the contents of the web page. + property enables zooming the contents of the web page by a scale factor. If a certificate error is raised while loading a web page, the \l certificateError() signal is emitted. Certificate errors are handled by using the methods of the WebEngineCertificateError diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index 508c9f861..9be4a25e7 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -52,8 +52,8 @@ Additionally, a page may also specify an icon, which can be accessed using the iconUrl() property. If the title or the icon changes, the corresponding titleChanged() and iconUrlChanged() signals will be emitted. - The zoomFactor() property can be used to change the overall size - of the content displayed in the page. + The zoomFactor() property enables zooming the contents of the web page by a + scale factor. The loadStarted() signal is emitted when the page begins to load, whereas the loadProgress() signal is emitted whenever an element of the web page completes loading, such as an embedded @@ -627,6 +627,8 @@ /*! \property QWebEnginePage::zoomFactor \brief the zoom factor for the page content + + Valid values are within the range from \c{0.25} to \c{5.0}. The default factor is \c{1.0}. */ /*! diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc index d7ecdb246..976a1a924 100644 --- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc @@ -59,7 +59,7 @@ Additionally, a web site may specify an icon, which can be accessed using the iconUrl() property. If the title or the icon changes, the corresponding titleChanged() and iconUrlChanged() signals will be emitted. The - zoomFactor() property can be used to change the overall size of the contents of the web view. + zoomFactor() property enables zooming the contents of the web page by a scale factor. If you require a custom context menu, you can implement it by reimplementing \l{QWidget::}{contextMenuEvent()} and populating your QMenu with the actions @@ -231,6 +231,8 @@ /*! \property QWebEngineView::zoomFactor \brief the zoom factor for the view + + Valid values are within the range from \c{0.25} to \c{5.0}. The default factor is \c{1.0}. */ /*! |