diff options
Diffstat (limited to 'src/webengine/doc/src/webengineview.qdoc')
-rw-r--r-- | src/webengine/doc/src/webengineview.qdoc | 113 |
1 files changed, 99 insertions, 14 deletions
diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 5b816454c..76c742aa0 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -21,13 +21,12 @@ */ // The documentation in this file was imported from QtWebKit and is thus constrained -// by its LGPL license. Documentation written from scratch for new methods should be -// placed inline in the code as usual. +// by its LGPL license. /*! \qmltype WebEngineView \instantiates QQuickWebEngineView - \inqmlmodule QtWebEngine 1.0 + \inqmlmodule QtWebEngine 1.1 \since QtWebEngine 1.0 \brief A WebEngineView renders web content within a QML application. */ @@ -49,6 +48,17 @@ */ /*! + \qmlmethod void WebEngineView::goBackOrForward(int offset) + \since QtWebEngine 1.1 + + If \a offset is positive, goes forward the specified number of offset + pages in the current session history. If offset is negative, it goes + back. If the offset is invalid, the page is not changed. + + \sa WebEngineView::goBack, WebEngineView::goForward +*/ + +/*! \qmlmethod void WebEngineView::stop() Stops loading the current page. @@ -59,6 +69,16 @@ Reloads the current page. This function is equivalent to the \c{window.location.reload()} DOM method. + + \sa WebEngineView::reloadAndBypassCache +*/ + +/*! + \qmlmethod void WebEngineView::reloadAndBypassCache() + + Reloads the current page, ignoring any cached content. + + \sa WebEngineView::reload */ /*! @@ -94,6 +114,7 @@ /*! \qmlproperty int WebEngineView::loadProgress + \readonly This property holds the amount of the page that has been loaded, expressed as an integer percentage in the range from \c{0} to \c{100}. @@ -101,6 +122,7 @@ /*! \qmlproperty bool WebEngineView::canGoBack + \readonly Returns \c{true} if there are prior session history entries, \c{false} otherwise. @@ -108,6 +130,7 @@ /*! \qmlproperty bool WebEngineView::canGoForward + \readonly Returns \c{true} if there are subsequent session history entries, \c{false} otherwise. @@ -115,6 +138,7 @@ /*! \qmlproperty bool WebEngineView::loading + \readonly Returns \c{true} if the HTML page is currently loading, \c{false} otherwise. */ @@ -134,7 +158,65 @@ Returns \c{true} if the web view is in fullscreen mode, \c{false} otherwise. - \sa WebEngineView::fullScreenRequested(), WebEngineView::fullScreenCancelled() + \sa WebEngineView::fullScreenRequested, WebEngineView::fullScreenCancelled +*/ + +/*! + \qmlproperty WebEngineHistory WebEngineView::navigationHistory + \since QtWebEngine 1.1 + \readonly + + The navigation history of the current view. + + \sa WebEngineHistory +*/ + +/*! + \qmlproperty QQmlWebChannel WebEngineView::webChannel + \since QtWebEngine 1.1 + + The web channel instance used by this view. + This channel is automatically using the internal QtWebEngine transport mechanism over Chromium IPC, + and exposed in the javascript context of the page it is rendering as \c qt.webChannelTransport. + This transport object is used when instantiating the JavaScript counterpart of QWebChannel using + the \l{Qt WebChannel JavaScript API}. + + \note The view does not take ownership for an assigned webChannel object. +*/ + +/*! + \qmlproperty WebEngineProfile WebEngineView::profile + \since QtWebEngine 1.1 + + The current profile used for the view. + + \sa WebEngineProfile +*/ + +/*! + \qmlproperty WebEngineSettings WebEngineView::settings + \readonly + \since QtWebEngine 1.1 + + Settings used by this view. + + \sa WebEngineSettings +*/ + + +/*! + \qmlproperty list<WebEngineScript> WebEngineView::userScripts + \readonly + + List of script objects attached to the view. +*/ + +/*! + \qmlproperty real WebEngineView::zoomFactor + \since QtWebEngine 1.1 + + 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}. */ /*! @@ -153,7 +235,6 @@ \sa WebEngineView::url */ - /*! \qmlmethod void WebEngineView::runJavaScript(string script, variant callback) \brief Runs the specified \a script in the content of the web view. @@ -207,13 +288,15 @@ */ /*! - \qmlmethod void WebEngineView::grantFeaturePermission(url securityOrigin, WebEngineView::Feature feature, bool granted) + \qmlmethod WebEngineView::grantFeaturePermission(url securityOrigin, Feature feature, bool granted) + \since QtWebEngine 1.1 Sets the permission for the web site identified by \a securityOrigin to use \a feature. - \sa featurePermissionRequested() + \sa WebEngineView::featurePermissionRequested */ + /*! \qmlmethod void WebEngineView::fullScreenCancelled() \since QtWebEngine 1.1 @@ -235,16 +318,16 @@ } \endcode - \sa WebEngineView::isFullScreen, WebEngineView::fullScreenRequested() + \sa WebEngineView::isFullScreen, WebEngineView::fullScreenRequested */ /*! - \qmlsignal void WebEngineView::featurePermissionRequested(url securityOrigin, WebEngineView::Feature feature) + \qmlsignal WebEngineView::featurePermissionRequested(url securityOrigin, Feature feature) This is signal is emitted when the web site identified by \a securityOrigin requests to make use of the resource or device identified by \a feature. - \sa grantFeaturePermission() + \sa WebEngineView::grantFeaturePermission */ /*! @@ -288,6 +371,7 @@ /*! \qmlsignal WebEngineView::certificateError(error) + \since QtWebEngine 1.1 This signal is emitted when an invalid certificate error is raised while loading a given request. @@ -332,6 +416,7 @@ /*! \qmlsignal WebEngineView::newViewRequested(request) + \since QtWebEngine 1.1 This signal is emitted when a page load is requested to happen in a separate WebEngineView. This can either be because the current page requested it explicitly @@ -351,7 +436,7 @@ */ /*! - \qmlsignal WebEngineView::fullScreenRequested(request) + \qmlsignal WebEngineView::fullScreenRequested(WebEngineFullScreenRequest request) \since QtWebEngine 1.1 This signal is emitted when the web page requests fullscreen mode through the @@ -367,7 +452,7 @@ This enumeration details various high-level error types. - \value NoErrorDomain + \value WebEngineView::NoErrorDomain \value WebEngineView::InternalErrorDomain Content fails to be interpreted by Qt WebEngine. \value WebEngineView::ConnectionErrorDomain @@ -474,7 +559,7 @@ \value MediaVideoCapture Video devices, e.g. cameras \value MediaAudioVideoCapture Both Audio and Video capture devices. - \sa featurePermissionRequested(), grantFeaturePermission() + \sa WebEngineView::featurePermissionRequested, WebEngineView::grantFeaturePermission */ @@ -521,5 +606,5 @@ } \endcode - \sa WebEngineFullScreenRequest::toggleOn() + \sa WebEngineFullScreenRequest::toggleOn */ |