diff options
Diffstat (limited to 'src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc')
| -rw-r--r-- | src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc | 43 |
1 files changed, 12 insertions, 31 deletions
diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc index 3f1b6e509..3153ec952 100644 --- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc @@ -1,24 +1,8 @@ -/* - Copyright (C) 2019 The Qt Company Ltd. - Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) - Copyright (C) 2008 Holger Hans Peter Freyther - Copyright (C) 2009 Girish Ramakrishnan <girish@forwardbias.in> - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public License - along with this library; see the file COPYING.LIB. If not, write to - the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, - Boston, MA 02110-1301, USA. -*/ +// Copyright (C) 2019 The Qt Company Ltd. +// Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) +// Copyright (C) 2008 Holger Hans Peter Freyther +// Copyright (C) 2009 Girish Ramakrishnan <girish@forwardbias.in> +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only // 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 @@ -77,7 +61,7 @@ new windows, such as pop-up windows, you can subclass QWebEngineView and reimplement the createWindow() function. - \sa {WebEngine Widgets Simple Browser Example}, {WebEngine Content Manipulation Example}, {WebEngine Markdown Editor Example} + \sa {WebEngine Widgets Simple Browser Example}, {WebEngine Content Manipulation Example} */ @@ -124,9 +108,8 @@ \fn void QWebEngineView::setHtml(const QString &html, const QUrl &baseUrl) Sets the content of the web view to the specified \a html content. - External objects, such as stylesheets or images referenced in the HTML - document, are located relative to \a baseUrl. For external objects to - be loaded, \c baseUrl cannot be empty. For example, if \a html + \a baseUrl is optional and used to resolve relative URLs in the document, + such as referenced images or stylesheets. 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, should be at \c{http://www.example.com/documents/diagram.png}. @@ -160,7 +143,7 @@ is empty, it is assumed that the content is \c{text/plain,charset=US-ASCII}. External objects referenced in the content are located relative to \a baseUrl. - For external objects to be loaded, \c baseUrl cannot be empty. + For external objects with relative URLs to be loaded, \c baseUrl cannot be empty. The data is loaded immediately; external objects are loaded asynchronously. @@ -226,6 +209,7 @@ /*! \fn QAction *QWebEngineView::pageAction(QWebEnginePage::WebAction action) const Returns a pointer to a QAction that encapsulates the specified web action \a action. + This function will also set a default styled icon to the QAction if it lacks one. */ /*! @@ -249,13 +233,12 @@ */ /*! - \fn void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options = QWebEnginePage::FindFlags(), const QWebEngineCallback<bool> &resultCallback = QWebEngineCallback<bool>()) + \fn void QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options = {}, const std::function<void(const QWebEngineFindTextResult &)> &resultCallback = std::function<void(const QWebEngineFindTextResult &)>) Finds the specified string, \a subString, in the page, using the given \a options. To clear the selection, just pass an empty string. - \a resultCallback must take a boolean parameter. It will be called with a value of \c true - if \a subString was found; otherwise the callback value will be \c false. + The \a resultCallback must take a QWebEngineFindTextResult parameter. \warning We guarantee that the callback (\a resultCallback) is always called, but it might be done during page destruction. When QWebEnginePage is deleted, the callback is triggered with an invalid @@ -392,6 +375,4 @@ It is equivalent to: \snippet qtwebengine_qwebengineview_snippet.cpp 6 - - \sa QWebEngineSettings::defaultSettings() */ |