From 3cb42b14f69ca07a95733cfcc8f6e1a22a544c07 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 28 Sep 2015 16:41:03 +0200 Subject: Doc: edit WebEngineView docs - Edit for grammar and style. - Use QDoc commands consistently. Change-Id: Iecfeaa17307befee73057f1f7760d6e10ae79e77 Reviewed-by: Joerg Bornemann --- src/webengine/doc/src/webengineview.qdoc | 152 +++++++++++++------------------ 1 file changed, 63 insertions(+), 89 deletions(-) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index f763227e4..67239edc9 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -84,7 +84,7 @@ /*! \qmlproperty url WebEngineView::url - The location of the currently displaying HTML page. This writable + The location of the currently displayed HTML page. This writable property offers the main interface to load a page into a web view. It functions the same as the \c{window.location} DOM property. @@ -95,7 +95,7 @@ \qmlproperty url WebEngineView::icon \readonly - This property holds the location of the currently displaying web site icon, + The location of the currently displayed web site icon, also known as favicon or shortcut icon. This read-only URL corresponds to the image used within a mobile browser application to represent a bookmarked page on the device's home screen. @@ -116,7 +116,7 @@ \qmlproperty int WebEngineView::loadProgress \readonly - This property holds the amount of the page that has been loaded, expressed + The amount of data from the page that has been loaded, expressed as an integer percentage in the range from \c{0} to \c{100}. */ @@ -147,7 +147,7 @@ \qmlproperty string WebEngineView::title \readonly - This property holds the title of the currently displaying HTML page, a + The title of the currently displayed HTML page. This is a read-only value that reflects the contents of the \c{} tag. */ @@ -221,15 +221,15 @@ /*! \qmlmethod void WebEngineView::loadHtml(string html, url baseUrl) - \brief Loads the specified \a html as the content of the web view. + Loads the specified \a html as the content of the web view. This method offers a lower-level alternative to the \c{url} property, 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 + External objects, such as stylesheets or images referenced in the HTML + document, should be located relative to \a baseUrl. 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, + 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}. \sa url @@ -237,10 +237,10 @@ /*! \qmlmethod void WebEngineView::runJavaScript(string script, variant callback) - \brief Runs the specified \a script in the content of the web view. + Runs the specified \a script in the content of the web view. - In case a callback function is provided it will be invoked after the script - finished running. + In case a callback function is provided, it will be invoked after the script + finishes running. \code runJavaScript("document.title", function(result) { console.log(result); }); @@ -335,9 +335,9 @@ \qmlsignal WebEngineView::loadingChanged(loadRequest) This signal is emitted when a page load begins, ends, or fails. - The corresponding handler is onLoadingChanged. + The corresponding handler is \c onLoadingChanged. - When handling the signal with onLoadingChanged, various read-only + When handling the signal with \c onLoadingChanged, various read-only parameters are available on the \a loadRequest: \table @@ -349,10 +349,7 @@ \li The location of the resource that is loading. \row \li status - \li Reflects one of four load states: - \c{WebEngineView::LoadStartedStatus}, \c{WebEngineView::LoadStoppedStatus}, - \c{WebEngineView::LoadSucceededStatus}, or \c{WebEngineView::LoadFailedStatus}. - See WebEngineLoadRequest::status and WebEngineView::LoadStatus. + \li The \l{LoadStatus}{load status} of the page. \row \li errorString \li The description of load error. @@ -361,13 +358,10 @@ \li The HTTP error code. \row \li errorDomain - \li The high-level error types, one of - \c{WebEngineView::ConnectionErrorDomain}, \c{WebEngineView::HttpErrorDomain}, \c{WebEngineView::InternalErrorDomain}, - \c{WebEngineView::DownloadErrorDomain}, or \c{WebEngineView::NoErrorDomain}. See - \l{WebEngineView::ErrorDomain} for the full list. + \li The high-level \l{ErrorDomain}{error type}. \endtable - \sa loading + \sa loading, LoadStatus, ErrorDomain */ /*! @@ -379,14 +373,14 @@ The certificate error can be rejected by calling WebEngineCertificateError::rejectCertificate, which will stop loading the request. - The certificate error can be ignored by calling WebEngineCertificateError::ignoreCertificateError - which will resume loading the request. + The certificate error can be ignored by calling + WebEngineCertificateError::ignoreCertificateError, which will resume loading the request. It is possible to defer the decision of rejecting the given certificate by calling WebEngineCertificateError::defer, which is useful when waiting for user input. - By default the invalid certificate will be automatically rejected. + By default, the invalid certificate will be automatically rejected. - The corresponding handler is onCertificateError. + The corresponding handler is \c onCertificateError. \sa WebEngineCertificateError */ @@ -400,19 +394,20 @@ events that are not cancelled with \c{preventDefault()}. \a{hoveredUrl} provides the link's location. - The corresponding handler is onLinkHovered. + The corresponding handler is \c onLinkHovered. */ /*! \qmlsignal WebEngineView::javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, message, lineNumber, sourceID) This signal is emitted when a JavaScript program tries to print a \a message to the web browser's console. - For example in case of evaluation errors the source URL may be provided in \a sourceID as well as the \a lineNumber. + For example, in case of evaluation errors the source URL may be provided in \a sourceID as well + as the \a lineNumber. - \a level indicates the severity of the event that triggered the message, i.e. if it + \a level indicates the severity of the event that triggered the message, that is, whether it was triggered by an error or a less severe event. - The corresponding handler is onJavaScriptConsoleMessage. + The corresponding handler is \c onJavaScriptConsoleMessage. */ /*! @@ -420,18 +415,18 @@ \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 - through a JavaScript call to window.open, or because the user clicked on a link - while holding Shift, Ctrl or a built-in combination that triggers the page to open + web engine view. This can either be because the current page requested it explicitly + through a JavaScript call to \c window.open, or because the user clicked on a link + while holding Shift, Ctrl, or a built-in combination that triggers the page to open in a new window. - If this signal isn't handled the requested load will fail. + If this signal is not handled, the requested load will fail. An example implementation: \snippet snippets/qtwebengine_webengineview_newviewrequested.qml 0 - The corresponding handler is onNewViewRequested. + The corresponding handler is \c onNewViewRequested. \sa WebEngineNewViewRequest, NewViewDestination, {WebEngine Quick Nano Browser} */ @@ -443,7 +438,7 @@ This signal is emitted when the web page requests fullscreen mode through the JavaScript API. - The corresponding handler is onFullScreenRequested. + The corresponding handler is \c onFullScreenRequested. \sa WebEngineFullScreenRequest, isFullScreen */ @@ -451,7 +446,7 @@ /*! \qmlproperty enumeration WebEngineView::ErrorDomain - This enumeration details various high-level error types. + Describes various high-level error types: \value WebEngineView::NoErrorDomain \value WebEngineView::InternalErrorDomain @@ -471,68 +466,42 @@ /*! \qmlproperty enumeration WebEngineView::JavaScriptConsoleMessageLevel - Indicates the severity of a JavaScript console message. + Indicates the severity of a JavaScript console message: - \table - - \header - \li Constant - \li Description - - \row - \li InfoMessageLevel - \li Message is purely informative and should be safe to ignore. - - \row - \li WarningMessageLevel - \li Message indicates there might be a problem that may need attention. - - \row - \li ErrorMessageLevel - \li Message indicates there has been an error. - - \endtable + \value InfoMessageLevel + Message is purely informative and can safely be ignored. + \value WarningMessageLevel + Message indicates there might be a problem that may need attention. + \value ErrorMessageLevel + Message indicates there has been an error. */ /*! \qmlproperty enumeration WebEngineView::LoadStatus - Reflects a page's load status. + Reflects a page's load status: - \table - - \header - \li Constant - \li Description - - \row - \li LoadStartedStatus - \li Page is currently loading. - - \row - \li LoadSucceededStatus - \li Page has successfully loaded, and is not currently loading. - - \row - \li LoadFailedStatus - \li Page has failed to load, and is not currently loading. - - \endtable + \value LoadStartedStatus + Page is currently loading. + \value LoadSucceededStatus + Page has successfully loaded, and is not currently loading. + \value LoadFailedStatus + Page has failed to load, and is not currently loading. */ /*! \qmlproperty enumeration WebEngineView::NewViewDestination - This enumeration details the format in which a new view request should be opened. + Describes how to open a new view: \value WebEngineView::NewViewInWindow - The page expects to be opened in a separate Window. + In a separate Window. \value WebEngineView::NewViewInTab - The page expects to be opened in a tab of the same window. + In a tab of the same window. \value WebEngineView::NewViewInDialog - The page expects to be opened in a Window without any tab, tool or URL bar. + In a Window without a tab bar, toolbar, or URL bar. \value WebEngineView::NewViewInBackgroundTab - The page expects to be opened in a tab of the same window, without hiding the currently visible WebEngineView. + In a tab of the same window, without hiding the currently visible web engine view. \sa WebEngineNewViewRequest::destination */ @@ -540,7 +509,7 @@ /*! \qmlproperty enumeration WebEngineView::FindFlags - This enum describes the options available to the findText() function. The options + Describes the options available to the findText() function. The options can be OR-ed together from the following list: \value FindBackward Searches backwards instead of forwards. @@ -553,12 +522,17 @@ /*! \qmlproperty enumeration WebEngineView::Feature - This enum describes the platform feature access categories that the user may be asked to grant or deny access to. + Describes the platform feature access categories that the user may be asked to grant or deny + access to: - \value Geolocation Access to location hardware or service - \value MediaAudioCapture Audio capture devices such a microphones - \value MediaVideoCapture Video devices, e.g. cameras - \value MediaAudioVideoCapture Both Audio and Video capture devices. + \value Geolocation + Location hardware or service. + \value MediaAudioCapture + Audio capture devices, such as microphones. + \value MediaVideoCapture + Video devices, such as cameras. + \value MediaAudioVideoCapture + Both audio and video capture devices. \sa featurePermissionRequested(), grantFeaturePermission() */ @@ -569,7 +543,7 @@ \inqmlmodule QtWebEngine 1.1 \since QtWebEngine 1.1 - \brief A utility class for the WebEngineView::fullScreenRequested() signal. + \brief A utility type for the WebEngineView::fullScreenRequested() signal. \sa WebEngineView::fullScreenRequested() */ -- cgit v1.2.1 From 8b1dc2b5c4c73cfb98d14f9abf2afaacb2494925 Mon Sep 17 00:00:00 2001 From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Date: Mon, 28 Sep 2015 13:41:28 +0200 Subject: Doc: add requirements for building Qt WebEngine Task-number: QTBUG-48097 Change-Id: I81665b615c6bb2a21d355fa1310ff8c1fae7e0b2 Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com> --- src/webengine/doc/src/qtwebengine-index.qdoc | 1 + .../doc/src/qtwebengine-platform-notes.qdoc | 52 ++++++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 src/webengine/doc/src/qtwebengine-platform-notes.qdoc (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc index 20d2de48c..2c3737b7d 100644 --- a/src/webengine/doc/src/qtwebengine-index.qdoc +++ b/src/webengine/doc/src/qtwebengine-index.qdoc @@ -69,6 +69,7 @@ \list \li \l{Qt WebEngine Overview} + \li \l{Qt WebEngine Platform Notes} \li \l{Qt WebEngine Web Developer Tools} \li \l{Porting from Qt WebKit to Qt WebEngine} \endlist diff --git a/src/webengine/doc/src/qtwebengine-platform-notes.qdoc b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc new file mode 100644 index 000000000..86cccfa3c --- /dev/null +++ b/src/webengine/doc/src/qtwebengine-platform-notes.qdoc @@ -0,0 +1,52 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtwebengine-platform-notes.html + \title Qt WebEngine Platform Notes + + \brief Contains information about issues that are specific to the Qt WebEngine module. + + \section1 Building Qt WebEngine from Source + + The requirements for building Qt 5 modules from source are listed separately for each supported + platform: + + \list + \li \l{Qt for Windows - Requirements} + \li \l{Qt for X11 Requirements} + \li \l{Qt for OS X - Requirements} + \endlist + + In addition, the following tools are required for building the \l {Qt WebEngine} module: + + \list + \li Windows: Visual Studio 2013 or Visual Studio 2013 Express + \li Linux: Clang or GCC version 4.7 or later + \li OS X: Xcode version 5.1 or later + \endlist +*/ -- cgit v1.2.1 From 49b796818d84ace5f20098dfe1257957b7fe5fd7 Mon Sep 17 00:00:00 2001 From: Kai Koehne <kai.koehne@theqtcompany.com> Date: Thu, 1 Oct 2015 08:34:06 +0200 Subject: Document WebEnginePage API only available in WebEngine 1.1 Task-number: QTBUG-47907 Change-Id: Ib66038fa61e091cafc7c27a87ca59c4d68b48b48 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> --- src/webengine/doc/src/webengineview.qdoc | 3 +++ 1 file changed, 3 insertions(+) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 67239edc9..06514a885 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -75,6 +75,7 @@ /*! \qmlmethod void WebEngineView::reloadAndBypassCache() + \since QtWebEngine 1.1 Reloads the current page, ignoring any cached content. @@ -207,6 +208,7 @@ /*! \qmlproperty list<WebEngineScript> WebEngineView::userScripts \readonly + \since QtWebEngine 1.1 List of script objects attached to the view. */ @@ -324,6 +326,7 @@ /*! \qmlsignal WebEngineView::featurePermissionRequested(url securityOrigin, Feature feature) + \since QtWebEngine 1.1 This signal is emitted when the web site identified by \a securityOrigin requests to make use of the resource or device identified by \a feature. -- cgit v1.2.1 From e0f8746d7da0d8c26e84472da03399ea337fc5af Mon Sep 17 00:00:00 2001 From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Date: Tue, 6 Oct 2015 12:35:35 +0200 Subject: Doc: add docs for WebEngineView 1.2 API MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Task-number: QTBUG-48560 Change-Id: I65349be1696b75dc303ae15c81f57094eea0ede4 Reviewed-by: Michael Brüning <michael.bruning@theqtcompany.com> --- src/webengine/doc/src/webengineview.qdoc | 136 +++++++++++++++++++++++++++++++ 1 file changed, 136 insertions(+) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 06514a885..fd7733d13 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -324,6 +324,26 @@ \sa isFullScreen, fullScreenRequested() */ +/*! + \qmlmethod void WebEngineView::setActiveFocusOnPress(bool arg) + \since QtWebEngine 1.2 + + Sets active focus to a clicked web engine view if \a arg is \c true. By setting it to \c false, + a web engine view can be used to create a UI element that should not get focus. This can be + useful in a hybrid UI. + + \sa activeFocusOnPressChanged() +*/ + +/*! + \qmlmethod void WebEngineView::triggerWebAction(WebAction action) + \since QtWebEngine 1.2 + + Triggers the web action \a action. + + \sa WebAction +*/ + /*! \qmlsignal WebEngineView::featurePermissionRequested(url securityOrigin, Feature feature) \since QtWebEngine 1.1 @@ -446,6 +466,35 @@ \sa WebEngineFullScreenRequest, isFullScreen */ +/*! + \qmlsignal WebEngineView::activeFocusOnPressChanged(bool) + \since QtWebEngine 1.2 + + This signal is emitted when the ability of the web engine view to get focus when clicked + changes. + + \sa setActiveFocusOnPress() +*/ + +/*! + \qmlsignal WebEngineView::backgroundColorChanged() + \since QtWebEngine 1.2 + + This signal is emitted when the web engine view background color changes. +*/ + +/*! + \qmlsignal WebEngineView::renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode) + + \since QtWebEngine 1.2 + + This signal is emitted when the render process is terminated with a non-zero exit status. + \a terminationStatus is the termination status of the process and \a exitCode is the status code + with which the process terminated. + + \sa RenderProcessTerminationStatus +*/ + /*! \qmlproperty enumeration WebEngineView::ErrorDomain @@ -522,6 +571,93 @@ \sa findText() */ +/*! + \qmlproperty enumeration WebEngineView::RenderProcessTerminationStatus + \since QtWebEngine 1.2 + + Describes the status with which the render process terminated: + + \value NormalTerminationStatus + The render process terminated normally. + \value AbnormalTerminationStatus + The render process terminated with a non-zero exit status. + \value CrashedTerminationStatus + The render process crashed, for example because of a segmentation fault. + \value KilledTerminationStatus + The render process was killed, for example by \c SIGKILL or task manager kill. +*/ + +/*! + \qmlproperty enumeration WebEngineView::WebAction + \since QtWebEngine 1.2 + + Describes the types of action that can be performed on a web page: + + \value NoWebAction + No action is triggered. + \value Back + Navigate back in the history of navigated links. + \value Forward + Navigate forward in the history of navigated links. + \value Stop + Stop loading the current page. + \value Reload + Reload the current page. + \value ReloadAndBypassCache + Reload the current page, but do not use any local cache. + \value Cut + Cut the content currently selected into the clipboard. + \value Copy + Copy the content currently selected into the clipboard. + \value Paste + Paste content from the clipboard. + \value Undo + Undo the last editing action. + \value Redo + Redo the last editing action. + \value SelectAll + Select all content. + \value PasteAndMatchStyle + Paste content from the clipboard with current style. + \value OpenLinkInThisWindow + Open the current link in the current window. (Added in Qt 5.6) + \value OpenLinkInNewWindow + Open the current link in a new window. (Added in Qt 5.6) + \value OpenLinkInNewTab + Open the current link in a new tab. (Added in Qt 5.6) + \value CopyLinkToClipboard + Copy the current link to the clipboard. (Added in Qt 5.6) + \value CopyImageToClipboard + Copy the clicked image to the clipboard. (Added in Qt 5.6) + \value CopyImageUrlToClipboard + Copy the clicked image's URL to the clipboard. (Added in Qt 5.6) + \value CopyMediaUrlToClipboard + Copy the hovered audio or video's URL to the clipboard. (Added in Qt 5.6) + \value ToggleMediaControls + Toggle between showing and hiding the controls for the hovered audio or video element. + (Added in Qt 5.6) + \value ToggleMediaLoop + Toggle whether the hovered audio or video should loop on completetion or not. + (Added in Qt 5.6) + \value ToggleMediaPlayPause + Toggle the play/pause state of the hovered audio or video element. (Added in Qt 5.6) + \value ToggleMediaMute + Mute or unmute the hovered audio or video element. (Added in Qt 5.6) + \value DownloadLinkToDisk + Download the current link to the disk. (Added in Qt 5.6) + \value DownloadImageToDisk + Download the highlighted image to the disk. (Added in Qt 5.6) + \value DownloadMediaToDisk + Download the hovered audio or video to the disk. (Added in Qt 5.6) + \value InspectElement + Trigger any attached Web Inspector to inspect the highlighed element. + (Added in Qt 5.6) + \value ExitFullScreen + Exit the fullscreen mode. (Added in Qt 5.6) + + \omitvalue WebActionCount +*/ + /*! \qmlproperty enumeration WebEngineView::Feature -- cgit v1.2.1 From 8318548b32134203a6a74029312da5cdff484a35 Mon Sep 17 00:00:00 2001 From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Date: Tue, 6 Oct 2015 17:07:08 +0200 Subject: Doc: remove doc config file from Qt WebEngineWidgets submodule MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This helps maintaining the doc dependencies. All Qt WebEngine module docs are now generated in the /qtbase/doc/qtwebengine/ folder. Note that you must run qmake -r for the docs to be generated correctly after applying this patch. Add Qt WebEngine C++ Classes page that lists the C++ classes for the submodules. Modify snippet and example paths accordingly. Change-Id: I59431c5f766f30b59654ca4e2219b76c79137225 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> --- src/webengine/doc/qtwebengine.qdocconf | 25 ++++++++------- src/webengine/doc/src/qtwebengine-index.qdoc | 3 +- src/webengine/doc/src/qtwebengine-modules.qdoc | 42 ++++++++++++++++++++++++++ 3 files changed, 57 insertions(+), 13 deletions(-) create mode 100644 src/webengine/doc/src/qtwebengine-modules.qdoc (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/qtwebengine.qdocconf b/src/webengine/doc/qtwebengine.qdocconf index f833cf0d2..e277f4190 100644 --- a/src/webengine/doc/qtwebengine.qdocconf +++ b/src/webengine/doc/qtwebengine.qdocconf @@ -4,7 +4,7 @@ project = QtWebEngine description = Qt WebEngine Reference Documentation version = $QT_VERSION -examplesinstallpath = webengine +examplesinstallpath = qhp.projects = QtWebEngine @@ -44,21 +44,24 @@ depends += qtcore \ qtquickcontrols \ qtdoc \ qtwebchannel \ - qtwebenginewidgets + qtwidgets -headerdirs += . \ - ../api \ - ../../core/api +headerdirs += .. \ + ../../core \ + ../../webenginewidgets -sourcedirs += . \ - ../api \ - ../../core/api \ - ../../core/doc/src +sourcedirs += .. \ + ../../core/ \ + ../../webenginewidgets \ exampledirs += . \ - ../../../examples/webengine \ + ../../../examples \ snippets \ - ../../core/doc/snippets + ../../core/doc/snippets \ + ../../webenginewidgets/doc/snippets + + +imagedirs += images navigation.landingpage = "Qt WebEngine" navigation.cppclassespage = "Qt WebEngine C++ Classes" diff --git a/src/webengine/doc/src/qtwebengine-index.qdoc b/src/webengine/doc/src/qtwebengine-index.qdoc index 2c3737b7d..e67bd43fd 100644 --- a/src/webengine/doc/src/qtwebengine-index.qdoc +++ b/src/webengine/doc/src/qtwebengine-index.qdoc @@ -84,8 +84,7 @@ \section1 API References \list - \li \l{Qt WebEngine Core C++ Classes} - \li \l{Qt WebEngine Widgets C++ Classes} + \li \l{Qt WebEngine C++ Classes} \li \l{Qt WebEngine QML Types} \endlist */ diff --git a/src/webengine/doc/src/qtwebengine-modules.qdoc b/src/webengine/doc/src/qtwebengine-modules.qdoc new file mode 100644 index 000000000..2e1b4c947 --- /dev/null +++ b/src/webengine/doc/src/qtwebengine-modules.qdoc @@ -0,0 +1,42 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \page qtwebengine-modules.html + \title Qt WebEngine C++ Classes + \brief Provides functionality for rendering regions of dynamic web content. + + \e {Qt WebEngine} provides functionality for rendering regions of dynamic web content. + + \section1 Classes + + \section2 Qt WebEngineCore Module + \generatelist {classesbymodule QtWebEngineCore} + + \section2 Qt WebEngineWidgets Module + \generatelist {classesbymodule QtWebEngineWidgets} +*/ -- cgit v1.2.1 From 3483e35635d24e8373ecb86114c9820093041df3 Mon Sep 17 00:00:00 2001 From: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Date: Wed, 7 Oct 2015 14:24:58 +0200 Subject: Doc: edit link to Qt WebKit docs to point to archive MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The Qt WebKit docs are not part of Qt 5.6 documentation. Change-Id: Iac913b2b94f899b0c14398c5a864b647c56995c5 Reviewed-by: Topi Reiniö <topi.reinio@digia.com> --- src/webengine/doc/src/qtwebengine-overview.qdoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc index 656dd13f1..fb2db9501 100644 --- a/src/webengine/doc/src/qtwebengine-overview.qdoc +++ b/src/webengine/doc/src/qtwebengine-overview.qdoc @@ -39,7 +39,8 @@ made fully editable by the user through the use of the \c{contenteditable} attribute on HTML elements. - Qt WebEngine supercedes the \l{Qt WebKit Widgets}{Qt WebKit} module, which is based on the + Qt WebEngine supercedes the \l{http://doc.qt.io/archives/qt-5.3/qtwebkit-index.html}{Qt WebKit} + module, which is based on the WebKit project, but has not been actively synchronized with the upstream WebKit code since Qt 5.2 and has been deprecated in Qt 5.5. For tips on how to change a Qt WebKit widgets application to use Qt WebEngine widgets, see \l{Porting from Qt WebKit to Qt WebEngine}. For new -- cgit v1.2.1 From 6df94b3cfd7eab7222542237a219144615bd434b Mon Sep 17 00:00:00 2001 From: Kai Koehne <kai.koehne@theqtcompany.com> Date: Thu, 10 Sep 2015 16:08:21 +0200 Subject: Improve runJavaScript documentation Mention that the script will run in the same JavaScript world as scripts that are part of the page. Also link to new scripts API. Change-Id: I4dd80fdd84644b1fa4ce6c63ab07c1dbba855389 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com> --- src/webengine/doc/src/webengineview.qdoc | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index fd7733d13..b734413ea 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -248,6 +248,10 @@ runJavaScript("document.title", function(result) { console.log(result); }); \endcode + The script will run in the same \e world as other scripts that are + part of the loaded site. + + See WebEngineView::userScripts for an alternative API to inject scripts. */ /*! -- cgit v1.2.1 From 96c80416cf685f9eb7765d1befff93d85606fe2a Mon Sep 17 00:00:00 2001 From: Topi Reinio <topi.reinio@digia.com> Date: Thu, 8 Oct 2015 12:25:10 +0200 Subject: Doc: Use \qml for code snippets where possible QDoc's QML parser works OK for code snippets that include a full type declaration; use \qml for these snippets to get autolinking to QML types working. Use \badcode for codeblocks that are not code or have nothing to link to. Change-Id: Iffd2f356bf0b3efc854a3755873e66f8c9478cac Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> --- src/webengine/doc/src/qtwebengine-devtools.qdoc | 4 +++- src/webengine/doc/src/qtwebengine-overview.qdoc | 4 ++-- src/webengine/doc/src/qtwebengine-qmlmodule.qdoc | 2 +- src/webengine/doc/src/webengineview.qdoc | 16 ++++++++-------- 4 files changed, 14 insertions(+), 12 deletions(-) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/qtwebengine-devtools.qdoc b/src/webengine/doc/src/qtwebengine-devtools.qdoc index 008fa925b..8d12e0eb0 100644 --- a/src/webengine/doc/src/qtwebengine-devtools.qdoc +++ b/src/webengine/doc/src/qtwebengine-devtools.qdoc @@ -37,9 +37,11 @@ To activate the developer tools, start an application that uses Qt WebEngine with the command-line arguments: - \code + + \badcode --remote-debugging-port=<port_number> \endcode + Where \c <port_number> refers to a local network port. The web developer tools can then be accessed by launching a browser at the address \c http://localhost:<port_number>. diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc index fb2db9501..11d939cf8 100644 --- a/src/webengine/doc/src/qtwebengine-overview.qdoc +++ b/src/webengine/doc/src/qtwebengine-overview.qdoc @@ -104,7 +104,7 @@ The following sample QML application loads a web page and responds to session history context: - \code + \qml import QtQuick 2.1 import QtQuick.Controls 1.1 import QtWebEngine 1.1 @@ -119,7 +119,7 @@ anchors.fill: parent } } - \endcode + \endqml \section1 Using WebEngine Core diff --git a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc index 6d3d71896..e098071b3 100644 --- a/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc +++ b/src/webengine/doc/src/qtwebengine-qmlmodule.qdoc @@ -32,7 +32,7 @@ The QML types can be imported into your application using the following import statements in your .qml file: - \code + \badcode import QtQuick 2.0 import QtWebEngine 1.1 \endcode diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index b734413ea..99bec5350 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -104,13 +104,13 @@ The following snippet uses the \c{icon} property to build an \c{Image} component: - \code + \qml Image { id: appIcon source: webView.icon != "" ? webView.icon : "fallbackFavIcon.png"; - ... + // ... } - \endcode + \endqml */ /*! @@ -311,7 +311,7 @@ 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 + \qml ApplicationWindow { onVisibilityChanged: { if (webEngineView.isFullScreen && visibility != Window.FullScreen) @@ -320,10 +320,10 @@ WebEngineView { id: webEngineView - ... + // ... } } - \endcode + \endqml \sa isFullScreen, fullScreenRequested() */ @@ -708,7 +708,7 @@ Call this method to accept the fullscreen request. It sets the WebEngineView::isFullScreen property to be equal to toggleOn. - \code + \qml ApplicationWindow { id: window WebEngineView { @@ -721,7 +721,7 @@ } } } - \endcode + \endqml \sa toggleOn */ -- cgit v1.2.1 From 0228a5bd581ae6d672ce5f39f11d6205a8bd8aaf Mon Sep 17 00:00:00 2001 From: Topi Reinio <topi.reinio@digia.com> Date: Thu, 8 Oct 2015 12:45:48 +0200 Subject: Doc: Collect external links into a single file Move external links to a dedicated .qdoc file for maintainability. Add an \externalpage that's marked internal to work around the issue of each occurrence of 'WebEngine' being autolinked to the WebEngine QML type, which is typically not desired. Change-Id: Icfdbefac7372866f5258378aa59daba1a97cc776 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> --- src/webengine/doc/src/external-resources.qdoc | 48 +++++++++++++++++++++++++ src/webengine/doc/src/qtwebengine-devtools.qdoc | 2 +- src/webengine/doc/src/qtwebengine-overview.qdoc | 10 +++--- 3 files changed, 54 insertions(+), 6 deletions(-) create mode 100644 src/webengine/doc/src/external-resources.qdoc (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/external-resources.qdoc b/src/webengine/doc/src/external-resources.qdoc new file mode 100644 index 000000000..34a66291e --- /dev/null +++ b/src/webengine/doc/src/external-resources.qdoc @@ -0,0 +1,48 @@ +/**************************************************************************** +** +** Copyright (C) 2015 The Qt Company Ltd. +** Contact: http://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:FDL$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see http://www.qt.io/terms-conditions. For further +** information use the contact form at http://www.qt.io/contact-us. +** +** GNU Free Documentation License Usage +** Alternatively, this file may be used under the terms of the GNU Free +** Documentation License version 1.3 as published by the Free Software +** Foundation and appearing in the file included in the packaging of +** this file. Please review the following information to ensure +** the GNU Free Documentation License version 1.3 requirements +** will be met: http://www.gnu.org/copyleft/fdl.html. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/*! + \externalpage http://www.chromium.org + \title Chromium Project +*/ + +/*! + \externalpage https://developers.google.com/web/tools/chrome-devtools + \title Chrome DevTools +*/ + +/* + This prevents autolinking of each occurrence of 'WebEngine' + To link to the WebEngine QML type, use explicit linking: + \l [QML] WebEngine + \sa {QtWebEngine::}{WebEngine} +*/ +/*! + \externalpage nolink + \title WebEngine + \internal +*/ diff --git a/src/webengine/doc/src/qtwebengine-devtools.qdoc b/src/webengine/doc/src/qtwebengine-devtools.qdoc index 8d12e0eb0..ee87214e1 100644 --- a/src/webengine/doc/src/qtwebengine-devtools.qdoc +++ b/src/webengine/doc/src/qtwebengine-devtools.qdoc @@ -54,5 +54,5 @@ device. For a detailed explanation of the capabilities of developer tools, see the - \l{https://developers.google.com/web/tools/chrome-devtools}{Chrome DevTools page}. + \l {Chrome DevTools} page. */ diff --git a/src/webengine/doc/src/qtwebengine-overview.qdoc b/src/webengine/doc/src/qtwebengine-overview.qdoc index 11d939cf8..15052f6e8 100644 --- a/src/webengine/doc/src/qtwebengine-overview.qdoc +++ b/src/webengine/doc/src/qtwebengine-overview.qdoc @@ -61,11 +61,11 @@ Qt WebEngine Widgets \endlist - The Qt WebEngine core is based on the \l{http://www.chromium.org}{Chromium Project}. Chromium - provides its own network and painting engines and is developed tightly together with its - dependent modules, and therefore Qt WebEngine provides better and more reliable support for the - latest HTML5 specification than Qt WebKit. However, Qt WebEngine is thus heavier than Qt WebKit - and does not provide direct access to the network stack and the HTML document through C++ APIs. + The Qt WebEngine core is based on the \l {Chromium Project}. Chromium provides its own network + and painting engines and is developed tightly together with its dependent modules, and + therefore Qt WebEngine provides better and more reliable support for the latest HTML5 + specification than Qt WebKit. However, Qt WebEngine is thus heavier than Qt WebKit and does + not provide direct access to the network stack and the HTML document through C++ APIs. Chromium is tightly integrated to the \l{Qt Quick Scene Graph}{Qt Quick scene graph}, which is based on OpenGL ES 2.0 or OpenGL 2.0 for its rendering. This provides you with one-pass -- cgit v1.2.1 From f144dbb39bead4cd9ae1e1971e8d904f13675560 Mon Sep 17 00:00:00 2001 From: Joerg Bornemann <joerg.bornemann@theqtcompany.com> Date: Thu, 1 Oct 2015 17:06:26 +0200 Subject: add signal WebEngineView.windowCloseRequested Change-Id: I47919cb21e084eaafc39411c634850c2845f5acc Reviewed-by: Allan Sandfeld Jensen <allan.jensen@theqtcompany.com> --- src/webengine/doc/src/webengineview.qdoc | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'src/webengine/doc') diff --git a/src/webengine/doc/src/webengineview.qdoc b/src/webengine/doc/src/webengineview.qdoc index 99bec5350..f230ba261 100644 --- a/src/webengine/doc/src/webengineview.qdoc +++ b/src/webengine/doc/src/webengineview.qdoc @@ -499,6 +499,16 @@ \sa RenderProcessTerminationStatus */ +/*! + \qmlsignal WebEngineView::windowCloseRequested() + \since QtWebEngine 1.2 + + This signal is emitted whenever the page requests the web browser window to be closed, + for example through the JavaScript \c{window.close()} call. + + The corresponding handler is \c onWindowCloseRequested. +*/ + /*! \qmlproperty enumeration WebEngineView::ErrorDomain -- cgit v1.2.1