summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSzabolcs David <davidsz@inf.u-szeged.hu>2015-04-09 07:37:32 -0700
committerAndras Becsi <andras.becsi@theqtcompany.com>2015-04-16 09:19:58 +0000
commit22090ad2a931847b988eaeba411012ab490432da (patch)
tree59418142a7c621670a094a3ec5fb6d9ac3b1942d
parent9195fc57faffde9682ef5b88ab89d07042ee194c (diff)
Quick: Document fullscreen API
Change-Id: Iade66eaea7016e6f7d73f25f8fc7af1879d099d9 Reviewed-by: Andras Becsi <andras.becsi@theqtcompany.com>
-rw-r--r--src/webengine/doc/src/qquickwebengineview_lgpl.qdoc92
1 files changed, 92 insertions, 0 deletions
diff --git a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc b/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
index 6d04473d..5f41fde6 100644
--- a/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
+++ b/src/webengine/doc/src/qquickwebengineview_lgpl.qdoc
@@ -176,6 +176,16 @@
*/
/*!
+ \qmlproperty bool WebEngineView::isFullScreen
+ \since QtWebEngine 1.1
+ \readonly
+
+ Returns \c{true} if the web view is in fullscreen mode, \c{false} otherwise.
+
+ \sa WebEngineView::fullScreenRequested(), WebEngineView::fullScreenCancelled()
+*/
+
+/*!
\qmlmethod void WebEngineView::loadHtml(string html, url baseUrl)
\brief Loads the specified \a html as the content of the web view.
@@ -253,6 +263,30 @@
*/
/*!
+ \qmlmethod void WebEngineView::fullScreenCancelled()
+ \since QtWebEngine 1.1
+
+ Immediately sets \c{isFullScreen} property to \c{false}. It can be used to notify the
+ browser engine when the windowing system forces the application to leave fullscreen mode.
+
+ \code
+ ApplicationWindow {
+ onVisibilityChanged: {
+ if (webEngineView.isFullScreen && visibility != Window.FullScreen)
+ webEngineView.fullScreenCancelled()
+ }
+
+ WebEngineView {
+ id: webEngineView
+ ...
+ }
+ }
+ \endcode
+
+ \sa WebEngineView::isFullScreen, WebEngineView::fullScreenRequested()
+*/
+
+/*!
\qmlsignal void WebEngineView::featurePermissionRequested(url securityOrigin, WebEngineView::Feature feature)
This is signal is emitted when the web site identified by \a securityOrigin requests
@@ -365,6 +399,18 @@
*/
/*!
+ \qmlsignal WebEngineView::fullScreenRequested(request)
+ \since QtWebEngine 1.1
+
+ This signal is emitted when the web page requests fullscreen mode through the
+ JavaScript API.
+
+ The corresponding handler is onFullScreenRequested.
+
+ \sa WebEngineFullScreenRequest, WebEngineView::isFullScreen
+*/
+
+/*!
\qmlproperty enumeration WebEngineView::ErrorDomain
This enumeration details various high-level error types.
@@ -479,3 +525,49 @@
\sa featurePermissionRequested(), grantFeaturePermission()
*/
+
+/*!
+ \qmltype WebEngineFullScreenRequest
+ \instantiates QQuickWebEngineFullScreenRequest
+ \inqmlmodule QtWebEngine 1.1
+ \since QtWebEngine 1.1
+
+ \brief A utility class for the WebEngineView::fullScreenRequested signal.
+
+ \sa WebEngineView::fullScreenRequested
+*/
+
+/*!
+ \qmlproperty bool WebEngineFullScreenRequest::toggleOn
+ \since QtWebEngine 1.1
+ \readonly
+
+ Returns \c{true} if the application should toggle fullscreen mode on, \c{false} otherwise.
+
+ \sa WebEngineFullScreenRequest::accept()
+*/
+
+/*!
+ \qmlmethod void WebEngineFullScreenRequest::accept()
+ \since QtWebEngine 1.1
+
+ Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen
+ property to be equal to WebEngineFullScreenRequest::toggleOn.
+
+ \code
+ ApplicationWindow {
+ id: window
+ WebEngineView {
+ onFullScreenRequested: {
+ if (request.toggleOn)
+ window.showFullScreen()
+ else
+ window.showNormal()
+ request.accept()
+ }
+ }
+ }
+ \endcode
+
+ \sa WebEngineFullScreenRequest::toggleOn()
+*/