diff options
Diffstat (limited to 'src/webenginewidgets')
18 files changed, 8 insertions, 3404 deletions
diff --git a/src/webenginewidgets/api/qwebenginehistory.cpp b/src/webenginewidgets/api/qwebenginehistory.cpp index cbd3fb3b1..8d4267b53 100644 --- a/src/webenginewidgets/api/qwebenginehistory.cpp +++ b/src/webenginewidgets/api/qwebenginehistory.cpp @@ -45,10 +45,6 @@ #include "qwebenginepage_p.h" #include "web_contents_adapter.h" -#if defined(Q_OS_WIN) -#define __func__ __FUNCTION__ -#endif - QT_BEGIN_NAMESPACE QWebEngineHistoryItemPrivate::QWebEngineHistoryItemPrivate(QWebEnginePagePrivate *page, int index) @@ -101,23 +97,6 @@ QDateTime QWebEngineHistoryItem::lastVisited() const return d->page ? d->page->webContents()->getNavigationEntryTimestamp(d->index) : QDateTime(); } -QIcon QWebEngineHistoryItem::icon() const -{ - qWarning("Not implemented: %s", __func__); - return QIcon(); -} - -QVariant QWebEngineHistoryItem::userData() const -{ - return QVariant(); -} - -void QWebEngineHistoryItem::setUserData(const QVariant& userData) -{ - Q_UNUSED(userData); - qWarning("Not implemented: %s", __func__); -} - bool QWebEngineHistoryItem::isValid() const { Q_D(const QWebEngineHistoryItem); @@ -269,17 +248,6 @@ int QWebEngineHistory::count() const return d->page->webContents()->navigationEntryCount(); } -int QWebEngineHistory::maximumItemCount() const -{ - return 100; -} - -void QWebEngineHistory::setMaximumItemCount(int count) -{ - Q_UNUSED(count); - qWarning("Not implemented: %s", __func__); -} - QDataStream& operator<<(QDataStream& stream, const QWebEngineHistory& history) { history.d_func()->page->webContents()->serializeNavigationHistory(stream); diff --git a/src/webenginewidgets/api/qwebenginehistory.h b/src/webenginewidgets/api/qwebenginehistory.h index b8ea6b863..b56cdd883 100644 --- a/src/webenginewidgets/api/qwebenginehistory.h +++ b/src/webenginewidgets/api/qwebenginehistory.h @@ -47,11 +47,6 @@ public: QString title() const; QDateTime lastVisited() const; - QIcon icon() const; - - QVariant userData() const; - void setUserData(const QVariant& userData); - bool isValid() const; private: QWebEngineHistoryItem(QWebEngineHistoryItemPrivate *priv); @@ -87,9 +82,6 @@ public: int count() const; - int maximumItemCount() const; - void setMaximumItemCount(int count); - private: QWebEngineHistory(QWebEngineHistoryPrivate *d); ~QWebEngineHistory(); diff --git a/src/webenginewidgets/api/qwebenginehistoryinterface.h b/src/webenginewidgets/api/qwebenginehistoryinterface.h deleted file mode 100644 index b8108c516..000000000 --- a/src/webenginewidgets/api/qwebenginehistoryinterface.h +++ /dev/null @@ -1,46 +0,0 @@ -/* - Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2007 Staikos Computing Services, Inc. <info@staikos.net> - - 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. - - This class provides all functionality needed for tracking global history. -*/ - -#ifndef QWEBENGINEHISTORYINTERFACE_H -#define QWEBENGINEHISTORYINTERFACE_H - -#include <QtCore/qobject.h> -#include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h> - -QT_BEGIN_NAMESPACE - -class QWEBENGINEWIDGETS_EXPORT QWebEngineHistoryInterface : public QObject { - Q_OBJECT -public: - QWebEngineHistoryInterface(QObject *parent = 0); - ~QWebEngineHistoryInterface(); - - static void setDefaultInterface(QWebEngineHistoryInterface *defaultInterface); - static QWebEngineHistoryInterface *defaultInterface(); - - virtual bool historyContains(const QString &url) const = 0; - virtual void addHistoryEntry(const QString &url) = 0; -}; - -QT_END_NAMESPACE - -#endif // QWEBENGINEHISTORYINTERFACE_H diff --git a/src/webenginewidgets/api/qwebengineinspector.h b/src/webenginewidgets/api/qwebengineinspector.h deleted file mode 100644 index 9427b4e5c..000000000 --- a/src/webenginewidgets/api/qwebengineinspector.h +++ /dev/null @@ -1,43 +0,0 @@ -/* - Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -#ifndef QWEBENGINEINSPECTOR_H -#define QWEBENGINEINSPECTOR_H - -#include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h> - -QT_BEGIN_NAMESPACE - -class QWebEnginePage; -class QWebEngineInspectorPrivate; - -class QWEBENGINEWIDGETS_EXPORT QWebEngineInspector : public QWidget { - Q_OBJECT -public: - QWebEngineInspector(QWidget* parent = 0); - ~QWebEngineInspector(); - - void setPage(QWebEnginePage* page); - QWebEnginePage* page() const; -}; - -QT_END_NAMESPACE - -#endif // QWEBENGINEINSPECTOR_H diff --git a/src/webenginewidgets/api/qwebenginepage.h b/src/webenginewidgets/api/qwebenginepage.h index 29ba140bc..4e0eaf27f 100644 --- a/src/webenginewidgets/api/qwebenginepage.h +++ b/src/webenginewidgets/api/qwebenginepage.h @@ -23,7 +23,6 @@ #define QWEBENGINEPAGE_H #include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h> -#include <QtWebEngineWidgets/qwebenginesettings.h> #include <QtCore/qobject.h> #include <QtCore/qurl.h> @@ -32,24 +31,10 @@ #include <QtWidgets/qwidget.h> QT_BEGIN_NAMESPACE -class QUndoStack; class QMenu; -class QPrinter; - -// FIXME: Just forward-declare the to-be-removed frame and element classes for now. -// Referencing calls should be ported to be page-friendly or removed individually. -class QWebEngineFrame; -class QWebEngineElement; -class QWebEngineElementCollection; - class QWebEngineHistory; -class QWebEngineHistoryItem; class QWebEnginePage; class QWebEnginePagePrivate; -class QWebEnginePluginFactory; -class QWebEngineSecurityOrigin; -class QtViewportAttributesPrivate; -class QWebEngineHitTestResultPrivate; namespace QtWebEnginePrivate { @@ -82,92 +67,20 @@ private: friend class QWebEnginePage; }; -class QWEBENGINEWIDGETS_EXPORT QWebEngineHitTestResult { -public: - QWebEngineHitTestResult(); - QWebEngineHitTestResult(const QWebEngineHitTestResult &other); - QWebEngineHitTestResult &operator=(const QWebEngineHitTestResult &other); - ~QWebEngineHitTestResult(); - - bool isNull() const; - - QPoint pos() const; - QRect boundingRect() const; - QWebEngineElement enclosingBlockElement() const; - QString title() const; - - QString linkText() const; - QUrl linkUrl() const; - QUrl linkTitle() const; - QWebEngineFrame *linkTargetFrame() const; - QWebEngineElement linkElement() const; - - QString alternateText() const; // for img, area, input and applet - - QUrl imageUrl() const; - QPixmap pixmap() const; - - bool isContentEditable() const; - bool isContentSelected() const; - - QWebEngineElement element() const; - - QWebEngineFrame *frame() const; -}; - class QWEBENGINEWIDGETS_EXPORT QWebEnginePage : public QObject { Q_OBJECT -// Hack to avoid undefined symbols with properties until we have them implemented. -#ifndef Q_MOC_RUN - Q_PROPERTY(bool modified READ isModified) Q_PROPERTY(QString selectedText READ selectedText) - Q_PROPERTY(QString selectedHtml READ selectedHtml) Q_PROPERTY(bool hasSelection READ hasSelection) - Q_PROPERTY(QSize viewportSize READ viewportSize WRITE setViewportSize) - Q_PROPERTY(QSize preferredContentsSize READ preferredContentsSize WRITE setPreferredContentsSize) - Q_PROPERTY(bool forwardUnsupportedContent READ forwardUnsupportedContent WRITE setForwardUnsupportedContent) - Q_PROPERTY(LinkDelegationPolicy linkDelegationPolicy READ linkDelegationPolicy WRITE setLinkDelegationPolicy) - Q_PROPERTY(QPalette palette READ palette WRITE setPalette) - Q_PROPERTY(bool contentEditable READ isContentEditable WRITE setContentEditable) - Q_ENUMS(LinkDelegationPolicy NavigationType WebAction) // Ex-QWebFrame properties - Q_PROPERTY(qreal textSizeMultiplier READ textSizeMultiplier WRITE setTextSizeMultiplier DESIGNABLE false) Q_PROPERTY(QUrl requestedUrl READ requestedUrl) - Q_PROPERTY(QIcon icon READ icon) - Q_PROPERTY(QSize contentsSize READ contentsSize) - Q_PROPERTY(QPoint scrollPosition READ scrollPosition WRITE setScrollPosition) - Q_PROPERTY(bool focus READ hasFocus) -#endif Q_PROPERTY(qreal zoomFactor READ zoomFactor WRITE setZoomFactor) Q_PROPERTY(QString title READ title) Q_PROPERTY(QUrl url READ url WRITE setUrl) public: - enum NavigationType { - NavigationTypeLinkClicked, - NavigationTypeFormSubmitted, - NavigationTypeBackOrForward, - NavigationTypeReload, - NavigationTypeFormResubmitted, - NavigationTypeOther - }; - enum WebAction { NoWebAction = - 1, - - OpenLink, - - OpenLinkInNewWindow, - OpenFrameInNewWindow, - - DownloadLinkToDisk, - CopyLinkToClipboard, - - OpenImageInNewWindow, - DownloadImageToDisk, - CopyImageToClipboard, - Back, Forward, Stop, @@ -179,70 +92,10 @@ public: Undo, Redo, - MoveToNextChar, - MoveToPreviousChar, - MoveToNextWord, - MoveToPreviousWord, - MoveToNextLine, - MoveToPreviousLine, - MoveToStartOfLine, - MoveToEndOfLine, - MoveToStartOfBlock, - MoveToEndOfBlock, - MoveToStartOfDocument, - MoveToEndOfDocument, - SelectNextChar, - SelectPreviousChar, - SelectNextWord, - SelectPreviousWord, - SelectNextLine, - SelectPreviousLine, - SelectStartOfLine, - SelectEndOfLine, - SelectStartOfBlock, - SelectEndOfBlock, - SelectStartOfDocument, - SelectEndOfDocument, - DeleteStartOfWord, - DeleteEndOfWord, - - SetTextDirectionDefault, - SetTextDirectionLeftToRight, - SetTextDirectionRightToLeft, - - ToggleBold, - ToggleItalic, - ToggleUnderline, - - InspectElement, - - InsertParagraphSeparator, - InsertLineSeparator, - SelectAll, ReloadAndBypassCache, PasteAndMatchStyle, - RemoveFormat, - - ToggleStrikethrough, - ToggleSubscript, - ToggleSuperscript, - InsertUnorderedList, - InsertOrderedList, - Indent, - Outdent, - - AlignCenter, - AlignJustified, - AlignLeft, - AlignRight, - - StopScheduledPageRefresh, - - CopyImageUrlToClipboard, - - OpenLinkInThisWindow, WebActionCount }; @@ -252,36 +105,13 @@ public: FindCaseSensitively = 2, }; Q_DECLARE_FLAGS(FindFlags, FindFlag) - - enum LinkDelegationPolicy { - DontDelegateLinks, - DelegateExternalLinks, - DelegateAllLinks - }; - enum WebWindowType { WebBrowserWindow, WebBrowserTab, WebDialog }; - enum PermissionPolicy { - PermissionUnknown, - PermissionGrantedByUser, - PermissionDeniedByUser - }; - - enum Feature { - Notifications, - Geolocation - }; - // Ex-QWebFrame enum - enum ValueOwnership { - QtOwnership, - ScriptOwnership, - AutoOwnership - }; enum FileSelectionMode { FileSelectOpen, @@ -295,152 +125,30 @@ public: Error }; - class QWEBENGINEWIDGETS_EXPORT ViewportAttributes { - public: - ViewportAttributes(); - ViewportAttributes(const QWebEnginePage::ViewportAttributes& other); - - ~ViewportAttributes(); - - QWebEnginePage::ViewportAttributes& operator=(const QWebEnginePage::ViewportAttributes& other); - - inline qreal initialScaleFactor() const { return m_initialScaleFactor; } - inline qreal minimumScaleFactor() const { return m_minimumScaleFactor; } - inline qreal maximumScaleFactor() const { return m_maximumScaleFactor; } - inline qreal devicePixelRatio() const { return m_devicePixelRatio; } - inline bool isUserScalable() const { return m_isUserScalable; } - inline bool isValid() const { return m_isValid; } - inline QSizeF size() const { return m_size; } - - private: - QSharedDataPointer<QtViewportAttributesPrivate> d; - qreal m_initialScaleFactor; - qreal m_minimumScaleFactor; - qreal m_maximumScaleFactor; - qreal m_devicePixelRatio; - bool m_isUserScalable; - bool m_isValid; - QSizeF m_size; - - friend class QWebEnginePage; - }; - - explicit QWebEnginePage(QObject *parent = 0); ~QWebEnginePage(); - - QWebEngineFrame *mainFrame() const; - QWebEngineFrame *currentFrame() const; - QWebEngineFrame* frameAt(const QPoint& pos) const; - QWebEngineHistory *history() const; - QWebEngineSettings *settings() const; void setView(QWidget *view); QWidget *view() const; - bool isModified() const; -#ifndef QT_NO_UNDOSTACK - QUndoStack *undoStack() const; -#endif - - void setNetworkAccessManager(QNetworkAccessManager *manager); - QNetworkAccessManager *networkAccessManager() const; - - void setPluginFactory(QWebEnginePluginFactory *factory); - QWebEnginePluginFactory *pluginFactory() const; - - quint64 totalBytes() const; - quint64 bytesReceived() const; - bool hasSelection() const; QString selectedText() const; - QString selectedHtml() const; #ifndef QT_NO_ACTION QAction *action(WebAction action) const; #endif virtual void triggerAction(WebAction action, bool checked = false); - QSize viewportSize() const; - void setViewportSize(const QSize &size); - ViewportAttributes viewportAttributesForSize(const QSize& availableSize) const; - - QSize preferredContentsSize() const; - void setPreferredContentsSize(const QSize &size) const; - void setActualVisibleContentRect(const QRect& rect) const; - virtual bool event(QEvent*); - bool focusNextPrevChild(bool next); - - QVariant inputMethodQuery(Qt::InputMethodQuery property) const; - void findText(const QString &subString, FindFlags options = 0, const QWebEngineCallback<bool> &resultCallback = QWebEngineCallback<bool>()); - - void setForwardUnsupportedContent(bool forward); - bool forwardUnsupportedContent() const; - - void setLinkDelegationPolicy(LinkDelegationPolicy policy); - LinkDelegationPolicy linkDelegationPolicy() const; - - void setPalette(const QPalette &palette); - QPalette palette() const; - - void setContentEditable(bool editable); - bool isContentEditable() const; - -#ifndef QT_NO_CONTEXTMENU - bool swallowContextMenuEvent(QContextMenuEvent *event); -#endif - void updatePositionDependentActions(const QPoint &pos); - QMenu *createStandardContextMenu(); - void setFeaturePermission(QWebEngineFrame* frame, Feature feature, PermissionPolicy policy); - - QStringList supportedContentTypes() const; - bool supportsContentType(const QString& mimeType) const; - - enum Extension { - ErrorPageExtension - }; - class ExtensionOption - {}; - class ExtensionReturn - {}; - - enum ErrorDomain { QtNetwork, Http, WebKit }; - class ErrorPageExtensionOption : public ExtensionOption { - public: - QUrl url; - QWebEngineFrame* frame; - ErrorDomain domain; - int error; - QString errorString; - }; - - class ErrorPageExtensionReturn : public ExtensionReturn { - public: - ErrorPageExtensionReturn() : contentType(QLatin1String("text/html")), encoding(QLatin1String("utf-8")) {}; - QString contentType; - QString encoding; - QUrl baseUrl; - QByteArray content; - }; - - - virtual bool extension(Extension extension, const ExtensionOption *option = 0, ExtensionReturn *output = 0) { Q_UNUSED(extension); Q_UNUSED(option); Q_UNUSED(output); Q_UNREACHABLE(); return false; } - virtual bool supportsExtension(Extension extension) const { Q_UNUSED(extension); Q_UNREACHABLE(); return false; } - - virtual bool shouldInterruptJavaScript() { Q_UNREACHABLE(); return false; } - // Ex-QWebFrame methods void load(const QUrl &url); - void load(const QNetworkRequest &request, QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray &body = QByteArray()); void setHtml(const QString &html, const QUrl &baseUrl = QUrl()); void setContent(const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl()); - void addToJavaScriptWindowObject(const QString &name, QObject *object, ValueOwnership ownership = QtOwnership); void toHtml(const QWebEngineCallback<const QString &> &resultCallback) const; void toPlainText(const QWebEngineCallback<const QString &> &resultCallback) const; @@ -448,139 +156,38 @@ public: void setUrl(const QUrl &url); QUrl url() const; QUrl requestedUrl() const; - QIcon icon() const; - QMultiMap<QString, QString> metaData() const; - - QString frameName() const; - - QWebEngineFrame *parentFrame() const; - QList<QWebEngineFrame*> childFrames() const; - - Qt::ScrollBarPolicy scrollBarPolicy(Qt::Orientation orientation) const; - void setScrollBarPolicy(Qt::Orientation orientation, Qt::ScrollBarPolicy policy); - - void setScrollBarValue(Qt::Orientation orientation, int value); - int scrollBarValue(Qt::Orientation orientation) const; - int scrollBarMinimum(Qt::Orientation orientation) const; - int scrollBarMaximum(Qt::Orientation orientation) const; - QRect scrollBarGeometry(Qt::Orientation orientation) const; - - void scroll(int, int); - QPoint scrollPosition() const; - void setScrollPosition(const QPoint &pos); - - void scrollToAnchor(const QString& anchor); - - enum RenderLayer { - ContentsLayer = 0x10, - ScrollBarLayer = 0x20, - PanIconLayer = 0x40, - - AllLayers = 0xff - }; - Q_DECLARE_FLAGS(RenderLayers, RenderLayer) - - void render(QPainter*, const QRegion& clip = QRegion()); - void render(QPainter*, RenderLayers layer, const QRegion& clip = QRegion()); - - void setTextSizeMultiplier(qreal factor); - qreal textSizeMultiplier() const; qreal zoomFactor() const; void setZoomFactor(qreal factor); - bool hasFocus() const; - void setFocus(); - - QPoint pos() const; - QRect geometry() const; - QSize contentsSize() const; - - QWebEngineElement documentElement() const; - QWebEngineElementCollection findAllElements(const QString &selectorQuery) const; - QWebEngineElement findFirstElement(const QString &selectorQuery) const; - - QWebEngineHitTestResult hitTestContent(const QPoint &pos) const; - - QWebEngineSecurityOrigin securityOrigin() const; - void runJavaScript(const QString& scriptSource, const QString &xPath = QString()); void runJavaScript(const QString& scriptSource, const QWebEngineCallback<const QVariant &> &resultCallback, const QString &xPath = QString()); -public Q_SLOTS: - // Ex-QWebFrame slot -#ifndef QT_NO_PRINTER - void print(QPrinter *printer) const { Q_UNUSED(printer); Q_UNREACHABLE(); } -#endif - - Q_SIGNALS: void loadStarted(); void loadProgress(int progress); void loadFinished(bool ok); - void linkHovered(const QString &link, const QString &title, const QString &textContent); - void statusBarMessage(const QString& text); void selectionChanged(); - void frameCreated(QWebEngineFrame *frame); void geometryChangeRequested(const QRect& geom); - void repaintRequested(const QRect& dirtyRect); - void scrollRequested(int dx, int dy, const QRect& scrollViewRect); void windowCloseRequested(); - void printRequested(QWebEngineFrame *frame); - void linkClicked(const QUrl &url); - - void toolBarVisibilityChangeRequested(bool visible); - void statusBarVisibilityChangeRequested(bool visible); - void menuBarVisibilityChangeRequested(bool visible); - - void unsupportedContent(QNetworkReply *reply); - void downloadRequested(const QNetworkRequest &request); - - void microFocusChanged(); - void contentsChanged(); - void databaseQuotaExceeded(QWebEngineFrame* frame, QString databaseName); - void applicationCacheQuotaExceeded(QWebEngineSecurityOrigin* origin, quint64 defaultOriginQuota, quint64 totalSpaceNeeded); - - void saveFrameStateRequested(QWebEngineFrame* frame, QWebEngineHistoryItem* item); - void restoreFrameStateRequested(QWebEngineFrame* frame); - - void viewportChangeRequested(); - - void featurePermissionRequested(QWebEngineFrame* frame, QWebEnginePage::Feature feature); - void featurePermissionRequestCanceled(QWebEngineFrame* frame, QWebEnginePage::Feature feature); void authenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator); void proxyAuthenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator, const QString &proxyHost); // Ex-QWebFrame signals - void javaScriptWindowObjectCleared(); - - void provisionalLoad(); void titleChanged(const QString &title); void urlChanged(const QUrl &url); - void initialLayoutCompleted(); - - void iconChanged(); - - void contentsSizeChanged(const QSize &size); - - void pageChanged(); - protected: virtual QWebEnginePage *createWindow(WebWindowType type); - virtual QObject *createPlugin(const QString &classid, const QUrl &url, const QStringList ¶mNames, const QStringList ¶mValues) { Q_UNUSED(classid); Q_UNUSED(url); Q_UNUSED(paramNames); Q_UNUSED(paramValues); Q_UNREACHABLE(); return 0; } - virtual bool acceptNavigationRequest(QWebEngineFrame *frame, const QNetworkRequest &request, NavigationType type) { Q_UNUSED(frame); Q_UNUSED(&request); Q_UNUSED(type); Q_UNREACHABLE(); return false; } virtual QStringList chooseFiles(FileSelectionMode mode, const QStringList &oldFiles, const QStringList &acceptedMimeTypes); virtual void javaScriptAlert(const QUrl &securityOrigin, const QString& msg); virtual bool javaScriptConfirm(const QUrl &securityOrigin, const QString& msg); virtual bool javaScriptPrompt(const QUrl &securityOrigin, const QString& msg, const QString& defaultValue, QString* result); virtual void javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString& message, int lineNumber, const QString& sourceID); - virtual QString userAgentForUrl(const QUrl& url) const { Q_UNUSED(url); Q_UNREACHABLE(); return QString(); } - private: Q_DECLARE_PRIVATE(QWebEnginePage); #ifndef QT_NO_ACTION @@ -591,8 +198,6 @@ private: friend class QWebEngineViewPrivate; }; -Q_DECLARE_OPERATORS_FOR_FLAGS(QWebEnginePage::FindFlags); -Q_DECLARE_OPERATORS_FOR_FLAGS(QWebEnginePage::RenderLayers); QT_END_NAMESPACE diff --git a/src/webenginewidgets/api/qwebenginesecurityorigin.h b/src/webenginewidgets/api/qwebenginesecurityorigin.h deleted file mode 100644 index c943bec84..000000000 --- a/src/webenginewidgets/api/qwebenginesecurityorigin.h +++ /dev/null @@ -1,52 +0,0 @@ -/* - Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -#ifndef QWEBENGINESECURITYORIGIN_H_ -#define QWEBENGINESECURITYORIGIN_H_ - -#include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h> - -QT_BEGIN_NAMESPACE -class QWebEngineDatabase; -class QWebEngineSecurityOriginPrivate; - -class QWEBENGINEWIDGETS_EXPORT QWebEngineSecurityOrigin { -public: - static QList<QWebEngineSecurityOrigin> allOrigins(); - static void addLocalScheme(const QString& scheme); - static void removeLocalScheme(const QString& scheme); - static QStringList localSchemes(); - - ~QWebEngineSecurityOrigin(); - - QString scheme() const; - QString host() const; - int port() const; - - qint64 databaseUsage() const; - qint64 databaseQuota() const; - void setDatabaseQuota(qint64 quota); - void setApplicationCacheQuota(qint64 quota); - QList<QWebEngineDatabase> databases() const; -}; - -QT_END_NAMESPACE - -#endif // QWEBENGINESECURITYORIGIN_H_ diff --git a/src/webenginewidgets/api/qwebenginesettings.h b/src/webenginewidgets/api/qwebenginesettings.h deleted file mode 100644 index 177a975fd..000000000 --- a/src/webenginewidgets/api/qwebenginesettings.h +++ /dev/null @@ -1,170 +0,0 @@ -/* - Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -#ifndef QWEBENGINESETTINGS_H -#define QWEBENGINESETTINGS_H - -#include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h> -#include <QtCore/qstring.h> - -QT_BEGIN_NAMESPACE - -class QIcon; -class QPixmap; -class QUrl; -class QWebEngineSettingsPrivate; - -class QWEBENGINEWIDGETS_EXPORT QWebEngineSettings { -public: - enum FontFamily { - StandardFont, - FixedFont, - SerifFont, - SansSerifFont, - CursiveFont, - FantasyFont - }; - enum WebAttribute { - AutoLoadImages, - JavascriptEnabled, - JavaEnabled, - PluginsEnabled, - PrivateBrowsingEnabled, - JavascriptCanOpenWindows, - JavascriptCanAccessClipboard, - DeveloperExtrasEnabled, - LinksIncludedInFocusChain, - ZoomTextOnly, - PrintElementBackgrounds, - OfflineStorageDatabaseEnabled, - OfflineWebApplicationCacheEnabled, - LocalStorageEnabled, -#if defined(QT_DEPRECATED) || defined(qdoc) - LocalStorageDatabaseEnabled = LocalStorageEnabled, -#endif - LocalContentCanAccessRemoteUrls, - DnsPrefetchEnabled, - XSSAuditingEnabled, - AcceleratedCompositingEnabled, - SpatialNavigationEnabled, - LocalContentCanAccessFileUrls, - TiledBackingStoreEnabled, - FrameFlatteningEnabled, - SiteSpecificQuirksEnabled, - JavascriptCanCloseWindows, - WebGLEnabled, - CSSRegionsEnabled, - HyperlinkAuditingEnabled, - CSSGridLayoutEnabled, - ScrollAnimatorEnabled, - CaretBrowsingEnabled, - NotificationsEnabled - }; - enum WebGraphic { - MissingImageGraphic, - MissingPluginGraphic, - DefaultFrameIconGraphic, - TextAreaSizeGripCornerGraphic, - DeleteButtonGraphic, - InputSpeechButtonGraphic, - SearchCancelButtonGraphic, - SearchCancelButtonPressedGraphic - }; - enum FontSize { - MinimumFontSize, - MinimumLogicalFontSize, - DefaultFontSize, - DefaultFixedFontSize - }; - enum ThirdPartyCookiePolicy { - AlwaysAllowThirdPartyCookies, - AlwaysBlockThirdPartyCookies, - AllowThirdPartyWithExistingCookies - }; - - static QWebEngineSettings *globalSettings(); - - void setFontFamily(FontFamily which, const QString &family); - QString fontFamily(FontFamily which) const; - void resetFontFamily(FontFamily which); - - void setFontSize(FontSize type, int size); - int fontSize(FontSize type) const; - void resetFontSize(FontSize type); - - void setAttribute(WebAttribute attr, bool on); - bool testAttribute(WebAttribute attr) const; - void resetAttribute(WebAttribute attr); - - void setUserStyleSheetUrl(const QUrl &location); - QUrl userStyleSheetUrl() const; - - void setDefaultTextEncoding(const QString &encoding); - QString defaultTextEncoding() const; - - static void setIconDatabasePath(const QString &location); - static QString iconDatabasePath(); - static void clearIconDatabase(); - static QIcon iconForUrl(const QUrl &url); - - //static QWebEnginePluginDatabase *pluginDatabase(); - - static void setWebGraphic(WebGraphic type, const QPixmap &graphic); - static QPixmap webGraphic(WebGraphic type); - - static void setMaximumPagesInCache(int pages); - static int maximumPagesInCache(); - static void setObjectCacheCapacities(int cacheMinDeadCapacity, int cacheMaxDead, int totalCapacity); - - static void setOfflineStoragePath(const QString& path); - static QString offlineStoragePath(); - static void setOfflineStorageDefaultQuota(qint64 maximumSize); - static qint64 offlineStorageDefaultQuota(); - - static void setOfflineWebApplicationCachePath(const QString& path); - static QString offlineWebApplicationCachePath(); - static void setOfflineWebApplicationCacheQuota(qint64 maximumSize); - static qint64 offlineWebApplicationCacheQuota(); - - void setLocalStoragePath(const QString& path); - QString localStoragePath() const; - - static void clearMemoryCaches(); - - static void enablePersistentStorage(const QString& path = QString()); - - void setThirdPartyCookiePolicy(ThirdPartyCookiePolicy); - QWebEngineSettings::ThirdPartyCookiePolicy thirdPartyCookiePolicy() const; - - void setCSSMediaType(const QString&); - QString cssMediaType() const; - -private: - Q_DISABLE_COPY(QWebEngineSettings) - - QWebEngineSettings(); - ~QWebEngineSettings(); - - QWebEngineSettingsPrivate *d; -}; - -QT_END_NAMESPACE - -#endif // QWEBENGINESETTINGS_H diff --git a/src/webenginewidgets/api/qwebengineview.h b/src/webenginewidgets/api/qwebengineview.h index 5e7dfa0e9..02f599d45 100644 --- a/src/webenginewidgets/api/qwebengineview.h +++ b/src/webenginewidgets/api/qwebengineview.h @@ -31,33 +31,18 @@ QT_BEGIN_NAMESPACE class QContextMenuEvent; -class QIcon; -class QNetworkRequest; -class QPrinter; class QUrl; class QWebEnginePage; class QWebEngineViewPrivate; -class QWebEngineNetworkRequest; class QWEBENGINEWIDGETS_EXPORT QWebEngineView : public QWidget { Q_OBJECT -// Hack to avoid undefined symbols with properties until we have them implemented. -#ifndef Q_MOC_RUN Q_PROPERTY(QString title READ title) Q_PROPERTY(QUrl url READ url WRITE setUrl) - Q_PROPERTY(QIcon icon READ icon) Q_PROPERTY(QString selectedText READ selectedText) - Q_PROPERTY(QString selectedHtml READ selectedHtml) Q_PROPERTY(bool hasSelection READ hasSelection) - Q_PROPERTY(bool modified READ isModified) - //Q_PROPERTY(Qt::TextInteractionFlags textInteractionFlags READ textInteractionFlags WRITE setTextInteractionFlags) - Q_PROPERTY(qreal textSizeMultiplier READ textSizeMultiplier WRITE setTextSizeMultiplier DESIGNABLE false) Q_PROPERTY(qreal zoomFactor READ zoomFactor WRITE setZoomFactor) - Q_PROPERTY(QPainter::RenderHints renderHints READ renderHints WRITE setRenderHints) - Q_FLAGS(QPainter::RenderHints) -#endif - public: explicit QWebEngineView(QWidget* parent = 0); virtual ~QWebEngineView(); @@ -66,45 +51,26 @@ public: void setPage(QWebEnginePage* page); void load(const QUrl& url); - void load(const QNetworkRequest& request, QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray &body = QByteArray()); void setHtml(const QString& html, const QUrl& baseUrl = QUrl()); void setContent(const QByteArray& data, const QString& mimeType = QString(), const QUrl& baseUrl = QUrl()); QWebEngineHistory* history() const; - QWebEngineSettings* settings() const; QString title() const; void setUrl(const QUrl &url); QUrl url() const; - QIcon icon() const; bool hasSelection() const; QString selectedText() const; - QString selectedHtml() const; #ifndef QT_NO_ACTION QAction* pageAction(QWebEnginePage::WebAction action) const; #endif void triggerPageAction(QWebEnginePage::WebAction action, bool checked = false); - bool isModified() const; - - /* - Qt::TextInteractionFlags textInteractionFlags() const; - void setTextInteractionFlags(Qt::TextInteractionFlags flags); - void setTextInteractionFlag(Qt::TextInteractionFlag flag); - */ - qreal zoomFactor() const; void setZoomFactor(qreal factor); - void setTextSizeMultiplier(qreal factor); - qreal textSizeMultiplier() const; - - QPainter::RenderHints renderHints() const; - void setRenderHints(QPainter::RenderHints hints); - void setRenderHint(QPainter::RenderHint hint, bool enabled = true); - void findText(const QString &subString, QWebEnginePage::FindFlags options = 0, const QWebEngineCallback<bool> &resultCallback = QWebEngineCallback<bool>()); virtual QSize sizeHint() const { return QSize(800, 600); } @@ -115,17 +81,12 @@ public Q_SLOTS: void forward(); void reload(); - void print(QPrinter*) const { } - Q_SIGNALS: void loadStarted(); void loadProgress(int progress); void loadFinished(bool); void titleChanged(const QString& title); - void statusBarMessage(const QString& text); - void linkClicked(const QUrl&); void selectionChanged(); - void iconChanged(); void urlChanged(const QUrl&); protected: diff --git a/src/webenginewidgets/doc/snippets/qtwebengine_qwebengineinspector_snippet.cpp b/src/webenginewidgets/doc/snippets/qtwebengine_qwebengineinspector_snippet.cpp deleted file mode 100644 index 5e57de027..000000000 --- a/src/webenginewidgets/doc/snippets/qtwebengine_qwebengineinspector_snippet.cpp +++ /dev/null @@ -1,38 +0,0 @@ -/* - Copyright (C) 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions - are met: - 1. Redistributions of source code must retain the above copyright - notice, this list of conditions and the following disclaimer. - 2. Redistributions in binary form must reproduce the above copyright - notice, this list of conditions and the following disclaimer in the - documentation and/or other materials provided with the distribution. - - THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY - EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED - WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY - DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES - (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; - LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON - ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT - (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS - SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -*/ - -void wrapInFunction() -{ - -//! [0] - // ... - QWebPage *page = new QWebPage; - // ... - - QWebInspector *inspector = new QWebInspector; - inspector->setPage(page); -//! [0] - -} - diff --git a/src/webenginewidgets/doc/snippets/webelement/main.cpp b/src/webenginewidgets/doc/snippets/webelement/main.cpp deleted file mode 100644 index b1781a6f4..000000000 --- a/src/webenginewidgets/doc/snippets/webelement/main.cpp +++ /dev/null @@ -1,125 +0,0 @@ -/* - Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -#include <QApplication> -#include <QUrl> -#include <qwebview.h> -#include <qwebframe.h> -#include <qwebelement.h> - -static QWebFrame *frame; - -static void traverse() -{ -//! [Traversing with QWebElement] - frame->setHtml("<html><body><p>First Paragraph</p><p>Second Paragraph</p></body></html>"); - QWebElement doc = frame->documentElement(); - QWebElement body = doc.firstChild(); - QWebElement firstParagraph = body.firstChild(); - QWebElement secondParagraph = firstParagraph.nextSibling(); -//! [Traversing with QWebElement] -} - -static void findButtonAndClick() -{ - - frame->setHtml("<form name=\"myform\" action=\"submit_form.asp\" method=\"get\">" - "<input type=\"text\" name=\"myfield\">" - "<input type=\"submit\" value=\"Submit\">" - "</form>"); - -//! [Calling a DOM element method] - - QWebElement document = frame->documentElement(); - /* Assume that the document has the following structure: - - <form name="myform" action="submit_form.asp" method="get"> - <input type="text" name="myfield"> - <input type="submit" value="Submit"> - </form> - - */ - - QWebElement button = document.findFirst("input[type=submit]"); - button.evaluateJavaScript("click()"); - -//! [Calling a DOM element method] - - } - -static void autocomplete1() -{ - QWebElement document = frame->documentElement(); - -//! [autocomplete1] - QWebElement firstTextInput = document.findFirst("input[type=text]"); - QString storedText = firstTextInput.attribute("value"); -//! [autocomplete1] - -} - - -static void autocomplete2() -{ - - QWebElement document = frame->documentElement(); - QString storedText = "text"; - -//! [autocomplete2] - QWebElement firstTextInput = document.findFirst("input[type=text]"); - textInput.setAttribute("value", storedText); -//! [autocomplete2] - -} - - -static void findAll() -{ -//! [FindAll] - QWebElement document = frame->documentElement(); - /* Assume the document has the following structure: - - <p class=intro> - <span>Intro</span> - <span>Snippets</span> - </p> - <p> - <span>Content</span> - <span>Here</span> - </p> - */ - -//! [FindAll intro] - QWebElementCollection allSpans = document.findAll("span"); - QWebElementCollection introSpans = document.findAll("p.intro span"); -//! [FindAll intro] //! [FindAll] -} - -int main(int argc, char *argv[]) -{ - QApplication app(argc, argv); - QWebView *view = new QWebView(0); - frame = view->page()->mainFrame(); - traverse(); - findAll(); - findButtonAndClick(); - autocomplete1(); - autocomplete2(); - return 0; -} diff --git a/src/webenginewidgets/doc/snippets/webelement/webelement.pro b/src/webenginewidgets/doc/snippets/webelement/webelement.pro deleted file mode 100644 index fbe701314..000000000 --- a/src/webenginewidgets/doc/snippets/webelement/webelement.pro +++ /dev/null @@ -1,2 +0,0 @@ -TEMPLATE = app -SOURCES = main.cpp diff --git a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc index 83bc8ecdf..3ddb45dd1 100644 --- a/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginehistory_lgpl.qdoc @@ -41,15 +41,9 @@ \row \li url() \li The location of the page. \row \li originalUrl() \li The URL used to access the page. \row \li lastVisited() \li The date and time of the user's last visit to the page. - \row \li icon() \li The icon associated with the page that was provided by the server. - \row \li userData() \li The user specific data that was stored with the history item. \endtable - \note QWebEngineHistoryItem objects are value based, but \e{explicitly shared}. Changing - a QWebEngineHistoryItem instance by calling setUserData() will change all copies of that - instance. - - \sa QWebEngineHistory, QWebEnginePage::history(), QWebEngineHistoryInterface + \sa QWebEngineHistory, QWebEnginePage::history() */ /*! @@ -89,40 +83,14 @@ \fn QString QWebEngineHistoryItem::title() const Returns the title of the page associated with the history item. - \sa icon(), url(), lastVisited() + \sa url(), lastVisited() */ /*! \fn QDateTime QWebEngineHistoryItem::lastVisited() const Returns the date and time that the page associated with the item was last visited. - \sa title(), icon(), url() -*/ - -/*! - \fn QIcon QWebEngineHistoryItem::icon() const - Returns the icon associated with the history item. - - \sa title(), url(), lastVisited() -*/ - -/*! - \fn QVariant QWebEngineHistoryItem::userData() const - \since 4.5 - Returns the user specific data that was stored with the history item. - - \sa setUserData() -*/ - -/*! - \fn void QWebEngineHistoryItem::setUserData(const QVariant& userData) - \since 4.5 - - Stores user specific data \a userData with the history item. - - \note All copies of this item will be modified. - - \sa userData() + \sa title(), url() */ /*! @@ -161,7 +129,7 @@ QWebEngineHistory's state can be saved to a QDataStream using the >> operator and loaded by using the << operator. - \sa QWebEngineHistoryItem, QWebEngineHistoryInterface, QWebEnginePage + \sa QWebEngineHistoryItem, QWebEnginePage */ /*! diff --git a/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc deleted file mode 100644 index 00e4f1a7d..000000000 --- a/src/webenginewidgets/doc/src/qwebenginehistoryinterface_lgpl.qdoc +++ /dev/null @@ -1,84 +0,0 @@ -/* - Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2007 Staikos Computing Services Inc. <info@staikos.net> - - 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. - - This class provides all functionality needed for tracking global history. -*/ - -// 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. - -/*! - \class QWebEngineHistoryInterface - \since 4.4 - \brief The QWebEngineHistoryInterface class provides an interface to implement link history. - - \inmodule QtWebEngine - - The QWebEngineHistoryInterface is an interface that can be used to - keep track of visited links. It contains two pure virtual methods that - are called by the WebKit engine: addHistoryEntry() is used to add - urls that have been visited to the interface, while - historyContains() is used to query whether the given url has been - visited by the user. By default the QWebEngineHistoryInterface is not set, so WebKit does not keep - track of visited links. - - \note The history tracked by QWebEngineHistoryInterface is not specific to an instance of QWebEnginePage - but applies to all pages. -*/ - -/*! - \fn void QWebEngineHistoryInterface::setDefaultInterface(QWebEngineHistoryInterface* defaultInterface) - Sets a new default interface, \a defaultInterface, that will be used by all of WebKit - to keep track of visited links. - - If an interface without a parent has already been set, the old interface will be deleted. - When the application exists QWebEngineHistoryInterface will automatically delete the - \a defaultInterface if it does not have a parent. -*/ - -/*! - \fn QWebEngineHistoryInterface* QWebEngineHistoryInterface::defaultInterface() - Returns the default interface that will be used by WebKit. If no default interface has been set, - WebKit will not keep track of visited links and a null pointer will be returned. - \sa setDefaultInterface() -*/ - -/*! - \fn QWebEngineHistoryInterface::QWebEngineHistoryInterface(QObject* parent) - Constructs a new QWebEngineHistoryInterface with parent \a parent. -*/ - -/*! - \fn QWebEngineHistoryInterface::~QWebEngineHistoryInterface() - Destroys the interface. If this is currently the default interface it will be unset. -*/ - -/*! - \fn bool QWebEngineHistoryInterface::historyContains(const QString &url) const = 0 - - Called by the WebKit engine to query whether a certain \a url has been visited by the user already. - Returns true if the \a url is part of the history of visited links; otherwise returns false. -*/ - -/*! - \fn void QWebEngineHistoryInterface::addHistoryEntry(const QString &url) = 0 - - Called by WebKit to add another \a url to the list of visited pages. -*/ diff --git a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc deleted file mode 100644 index 2e0c6ec82..000000000 --- a/src/webenginewidgets/doc/src/qwebengineinspector_lgpl.qdoc +++ /dev/null @@ -1,104 +0,0 @@ -/* - Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -// 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. - -/*! - \class QWebEngineInspector - \since 4.6 - \inmodule QtWebEngine - \brief The QWebEngineInspector class allows the placement and control of a - QWebEnginePage's inspector. - The inspector can display a page's hierarchy, its loading statistics and - the current state of its individual elements. It is mostly used by web - developers. - - The QWebEnginePage to be inspected must be specified using the setPage() method. - - A typical use of QWebEngineInspector follows: - - \snippet snippets/qtwebengine_qwebengineinspector_snippet.cpp 0 - - A QWebEngineInspector can be made visible either programmatically using - setVisible(), or by the user through the attached QWebEnginePage's context - menu. - - \note A QWebEngineInspector will display a blank widget if either: - \list - \li page() is null - \li QWebEngineSettings::DeveloperExtrasEnabled is false - \endlist - - \section1 Resources - - This class acts mostly as a container and a controller for the inspector. - Most of the resources needed by the inspector are owned by the associated - QWebEnginePage and are allocated the first time that: - \list - \li an element is inspected - \li the QWebEngineInspector is shown. - \endlist - - \section1 Inspector configuration persistence - - The inspector allows the user to configure some options through its - user interface (e.g. the resource tracking "Always enable" option). - The inspector UI is itself a web page and is using HTML local storage - to persist those settings. - Since the internal QWebEnginePage used by the inspector isn't exposed in the API, - the only way to enable those settings to be persisted is currently to enable - local storage globally through QWebEngineSettings::globalSettings(). - - \sa QWebEngineSettings::localStoragePath(), QWebEngineSettings::LocalStorageEnabled -*/ - -/*! - \fn QWebEngineInspector::QWebEngineInspector(QWidget* parent) - Constructs an unbound QWebEngineInspector with \a parent as its parent. -*/ - -/*! - \fn QWebEngineInspector::~QWebEngineInspector() - Destroys the inspector. -*/ - -/*! - \fn void QWebEngineInspector::setPage(QWebEnginePage* page) - Bind this inspector to the QWebEnginePage to be inspected. - - \b {Notes:} - \list - \li There can only be one QWebEngineInspector associated with a QWebEnginePage - and vice versa. - \li Calling this method with a null \a page will break the current association, if any. - \li If \a page is already associated to another QWebEngineInspector, the association - will be replaced and the previous QWebEngineInspector will become unbound - \endlist - - \sa page() -*/ - -/*! - \fn QWebEnginePage* QWebEngineInspector::page() const - Returns the inspected QWebEnginePage. - If no web page is currently associated, a null pointer is returned. -*/ diff --git a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc index a32406264..3019ed5ed 100644 --- a/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebenginepage_lgpl.qdoc @@ -115,15 +115,6 @@ */ /*! - \property QWebEnginePage::palette - \brief the page's palette - - The base brush of the palette is used to draw the background of the main frame. - - By default, this property contains the application's default palette. -*/ - -/*! \fn QVariant QWebEnginePage::inputMethodQuery(Qt::InputMethodQuery property) const This method is used by the input method to query a set of properties of the page to be able to support complex input method operations as support for surrounding @@ -143,47 +134,6 @@ \value FindBackward Searches backwards instead of forwards. \value FindCaseSensitively By default findText() works case insensitive. Specifying this option changes the behavior to a case sensitive find operation. - \value FindWrapsAroundDocument Makes findText() restart from the beginning of the document if the end - was reached and the text was not found. - \value HighlightAllOccurrences Highlights all existing occurrences of a specific string. - (This value was introduced in 4.6.) - \value FindAtWordBeginningsOnly Searches for the sub-string only at the beginnings of words. - (This value was introduced in 5.2.) - \value TreatMedialCapitalAsWordBeginning Treats a capital letter occurring anywhere in the middle of a word - as the beginning of a new word. - (This value was introduced in 5.2.) - \value FindBeginsInSelection Begin searching inside the text selection first. - (This value was introduced in 5.2.) -*/ - -/*! - \enum QWebEnginePage::LinkDelegationPolicy - - This enum defines the delegation policies a webpage can have when activating links and emitting - the linkClicked() signal. - - \value DontDelegateLinks No links are delegated. Instead, QWebEnginePage tries to handle them all. - \value DelegateExternalLinks When activating links that point to documents not stored on the - local filesystem or an equivalent - such as the Qt resource system - then linkClicked() is emitted. - \value DelegateAllLinks Whenever a link is activated the linkClicked() signal is emitted. - - \sa QWebEnginePage::linkDelegationPolicy -*/ - -/*! - \enum QWebEnginePage::NavigationType - - This enum describes the types of navigation available when browsing through hyperlinked - documents. - - \value NavigationTypeLinkClicked The user clicked on a link or pressed return on a focused link. - \value NavigationTypeFormSubmitted The user activated a submit button for an HTML form. - \value NavigationTypeBackOrForward Navigation to a previously shown document in the back or forward history is requested. - \value NavigationTypeReload The user activated the reload action. - \value NavigationTypeFormResubmitted An HTML form was submitted a second time. - \value NavigationTypeOther A navigation to another document using a method not listed above. - - \sa acceptNavigationRequest() */ /*! @@ -195,24 +145,10 @@ actions can be be determined by checking \l{QAction::}{isEnabled()} on the action returned by action(). - One method of enabling the text editing, cursor movement, and text selection actions - is by setting \l contentEditable to true. - \value NoWebAction No action is triggered. - \value OpenLink Open the current link. - \value OpenLinkInNewWindow Open the current link in a new window. - \value OpenLinkInThisWindow Open the current link without opening a new window. Used on links that would default to opening in another frame or a new window. (Added in Qt 5.0) - \value OpenFrameInNewWindow Replicate the current frame in a new window. - \value DownloadLinkToDisk Download the current link to the disk. - \value CopyLinkToClipboard Copy the current link to the clipboard. - \value OpenImageInNewWindow Open the highlighted image in a new window. - \value DownloadImageToDisk Download the highlighted image to the disk. - \value CopyImageToClipboard Copy the highlighted image to the clipboard. (Added in Qt 4.8) - \value CopyImageUrlToClipboard Copy the highlighted image's URL to the clipboard. \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 StopScheduledPageRefresh Stop all pending page refresh/redirect requests. (Added in Qt 4.7) \value Reload Reload the current page. \value ReloadAndBypassCache Reload the current page, but do not use any local cache. (Added in Qt 4.6) \value Cut Cut the content currently selected into the clipboard. @@ -220,55 +156,8 @@ \value Paste Paste content from the clipboard. \value Undo Undo the last editing action. \value Redo Redo the last editing action. - \value MoveToNextChar Move the cursor to the next character. - \value MoveToPreviousChar Move the cursor to the previous character. - \value MoveToNextWord Move the cursor to the next word. - \value MoveToPreviousWord Move the cursor to the previous word. - \value MoveToNextLine Move the cursor to the next line. - \value MoveToPreviousLine Move the cursor to the previous line. - \value MoveToStartOfLine Move the cursor to the start of the line. - \value MoveToEndOfLine Move the cursor to the end of the line. - \value MoveToStartOfBlock Move the cursor to the start of the block. - \value MoveToEndOfBlock Move the cursor to the end of the block. - \value MoveToStartOfDocument Move the cursor to the start of the document. - \value MoveToEndOfDocument Move the cursor to the end of the document. - \value SelectNextChar Select to the next character. - \value SelectPreviousChar Select to the previous character. - \value SelectNextWord Select to the next word. - \value SelectPreviousWord Select to the previous word. - \value SelectNextLine Select to the next line. - \value SelectPreviousLine Select to the previous line. - \value SelectStartOfLine Select to the start of the line. - \value SelectEndOfLine Select to the end of the line. - \value SelectStartOfBlock Select to the start of the block. - \value SelectEndOfBlock Select to the end of the block. - \value SelectStartOfDocument Select to the start of the document. - \value SelectEndOfDocument Select to the end of the document. - \value DeleteStartOfWord Delete to the start of the word. - \value DeleteEndOfWord Delete to the end of the word. - \value SetTextDirectionDefault Set the text direction to the default direction. - \value SetTextDirectionLeftToRight Set the text direction to left-to-right. - \value SetTextDirectionRightToLeft Set the text direction to right-to-left. - \value ToggleBold Toggle the formatting between bold and normal weight. - \value ToggleItalic Toggle the formatting between italic and normal style. - \value ToggleUnderline Toggle underlining. - \value InspectElement Show the Web Inspector with the currently highlighted HTML element. - \value InsertParagraphSeparator Insert a new paragraph. - \value InsertLineSeparator Insert a new line. \value SelectAll Selects all content. \value PasteAndMatchStyle Paste content from the clipboard with current style. (Added in Qt 4.6) - \value RemoveFormat Removes formatting and style. (Added in Qt 4.6) - \value ToggleStrikethrough Toggle the formatting between strikethrough and normal style. (Added in Qt 4.6) - \value ToggleSubscript Toggle the formatting between subscript and baseline. (Added in Qt 4.6) - \value ToggleSuperscript Toggle the formatting between supercript and baseline. (Added in Qt 4.6) - \value InsertUnorderedList Toggles the selection between an ordered list and a normal block. (Added in Qt 4.6) - \value InsertOrderedList Toggles the selection between an ordered list and a normal block. (Added in Qt 4.6) - \value Indent Increases the indentation of the currently selected format block by one increment. (Added in Qt 4.6) - \value Outdent Decreases the indentation of the currently selected format block by one increment. (Added in Qt 4.6) - \value AlignCenter Applies center alignment to content. (Added in Qt 4.6) - \value AlignJustified Applies full justification to content. (Added in Qt 4.6) - \value AlignLeft Applies left justification to content. (Added in Qt 4.6) - \value AlignRight Applies right justification to content. (Added in Qt 4.6) \omitvalue WebActionCount @@ -285,72 +174,6 @@ */ /*! - \class QWebEnginePage::ViewportAttributes - \since 4.7 - \brief The QWebEnginePage::ViewportAttributes class describes hints that can be applied to a viewport. - - QWebEnginePage::ViewportAttributes provides a description of a viewport, such as viewport geometry, - initial scale factor with limits, plus information about whether a user should be able - to scale the contents in the viewport or not, ie. by zooming. - - ViewportAttributes can be set by a web author using the viewport meta tag extension, documented - at \l{http://developer.apple.com/safari/library/documentation/appleapplications/reference/safariwebcontent/usingtheviewport/usingtheviewport.html}{Safari Reference Library: Using the Viewport Meta Tag}. - - All values might not be set, as such when dealing with the hints, the developer needs to - check whether the values are valid. Negative values denote an invalid qreal value. - - \inmodule QtWebEngine -*/ - -/*! - \fn QWebEnginePage::ViewportAttributes::ViewportAttributes() - Constructs an empty QWebEnginePage::ViewportAttributes. -*/ - -/*! - \fn QWebEnginePage::ViewportAttributes::ViewportAttributes(const QWebEnginePage::ViewportAttributes& other) - Constructs a QWebEnginePage::ViewportAttributes which is a copy from \a other . -*/ - -/*! - \fn QWebEnginePage::ViewportAttributes::~ViewportAttributes() - Destroys the QWebEnginePage::ViewportAttributes. -*/ - -/*! - \fn QWebEnginePage::ViewportAttributes& QWebEnginePage::ViewportAttributes::operator=(const QWebEnginePage::ViewportAttributes& other) - Assigns the given QWebEnginePage::ViewportAttributes to this viewport hints and returns a - reference to this. -*/ - -/*! \fn inline bool QWebEnginePage::ViewportAttributes::isValid() const - Returns whether this is a valid ViewportAttributes or not. - - An invalid ViewportAttributes will have an empty QSize, negative values for scale factors and - true for the boolean isUserScalable. -*/ - -/*! \fn inline QSize QWebEnginePage::ViewportAttributes::size() const - Returns the size of the viewport. -*/ - -/*! \fn inline qreal QWebEnginePage::ViewportAttributes::initialScaleFactor() const - Returns the initial scale of the viewport as a multiplier. -*/ - -/*! \fn inline qreal QWebEnginePage::ViewportAttributes::minimumScaleFactor() const - Returns the minimum scale value of the viewport as a multiplier. -*/ - -/*! \fn inline qreal QWebEnginePage::ViewportAttributes::maximumScaleFactor() const - Returns the maximum scale value of the viewport as a multiplier. -*/ - -/*! \fn inline bool QWebEnginePage::ViewportAttributes::isUserScalable() const - Determines whether or not the scale can be modified by the user. -*/ - -/*! \fn QWebEnginePage::QWebEnginePage(QObject *parent) Constructs an empty QWebEnginePage with parent \a parent. */ @@ -361,33 +184,6 @@ */ /*! - \fn QWebEngineFrame *QWebEnginePage::mainFrame() const - Returns the main frame of the page. - - The main frame provides access to the hierarchy of sub-frames and is also needed if you - want to explicitly render a web page into a given painter. - - \sa currentFrame() -*/ - -/*! - \fn QWebEngineFrame *QWebEnginePage::currentFrame() const - Returns the frame currently active. - - \sa mainFrame(), frameCreated() -*/ - -/*! - \fn QWebEngineFrame* QWebEnginePage::frameAt(const QPoint& pos) const - \since 4.6 - - Returns the frame at the given point \a pos, or 0 if there is no frame at - that position. - - \sa mainFrame(), currentFrame() -*/ - -/*! \fn QWebEngineHistory *QWebEnginePage::history() const Returns a pointer to the view's history of navigated web pages. */ @@ -444,16 +240,6 @@ */ /*! - \fn bool QWebEnginePage::shouldInterruptJavaScript() - \since 4.6 - This function is called when a JavaScript program is running for a long period of time. - - If the user wanted to stop the JavaScript the implementation should return true; otherwise false. - - The default implementation executes the query using QMessageBox::information with QMessageBox::Yes and QMessageBox::No buttons. -*/ - -/*! \fn QWebEnginePage *QWebEnginePage::createWindow(WebWindowType type) This function is called whenever WebKit wants to create a new window of the given \a type, for example when a JavaScript program requests to open a document in a new window. @@ -469,24 +255,7 @@ reimplementing this method application must also set the JavaScriptCanOpenWindows attribute of QWebEngineSettings to true in order for it to get called. - \sa acceptNavigationRequest(), QWebEngineView::createWindow() -*/ - -/*! - \fn QObject *QWebEnginePage::createPlugin(const QString &classid, const QUrl &url, const QStringList ¶mNames, const QStringList ¶mValues) - This function is called whenever WebKit encounters a HTML object element with type "application/x-qt-plugin". It is - called regardless of the value of QWebEngineSettings::PluginsEnabled. The \a classid, \a url, \a paramNames and \a paramValues - correspond to the HTML object element attributes and child elements to configure the embeddable object. -*/ - -/*! - \fn QStringList QWebEnginePage::supportedContentTypes() const - Returns the list of all content types supported by QWebEnginePage. -*/ - -/*! - \fn bool QWebEnginePage::supportsContentType(const QString& mimeType) const - Returns true if QWebEnginePage can handle the given \a mimeType; otherwise, returns false. + \sa QWebEngineView::createWindow() */ /*! @@ -502,97 +271,6 @@ */ /*! - \property QWebEnginePage::viewportSize - \brief the size of the viewport - - The size affects for example the visibility of scrollbars - if the document is larger than the viewport. - - By default, for a newly-created Web page, this property contains a size with - zero width and height. - - \sa render(), preferredContentsSize -*/ - -/*! - \fn QWebEnginePage::ViewportAttributes QWebEnginePage::viewportAttributesForSize(const QSize& availableSize) const - Computes the optimal viewport configuration given the \a availableSize, when - user interface components are disregarded. - - The configuration is also dependent on the device screen size which is obtained - automatically. For testing purposes the size can be overridden by setting two - environment variables QTWEBKIT_DEVICE_WIDTH and QTWEBKIT_DEVICE_HEIGHT, which - both needs to be set. - - The ViewportAttributes includes a pixel density ratio, which will also be exposed to - the web author though the -webkit-pixel-ratio media feature. This is the ratio - between 1 density-independent pixel (DPI) and physical pixels. - - A density-independent pixel is equivalent to one physical pixel on a 160 DPI screen, - so on our platform assumes that as the baseline density. - - The conversion of DIP units to screen pixels is quite simple: - - pixels = DIPs * (density / 160). - - Thus, on a 240 DPI screen, 1 DIPs would equal 1.5 physical pixels. - - An invalid instance will be returned in the case an empty size is passed to the - method. - - \note The density is automatically obtained from the DPI of the screen where the page - is being shown, but as many X11 servers are reporting wrong DPI, it is possible to - override it using QX11Info::setAppDpiY(). -*/ - -/*! - \property QWebEnginePage::preferredContentsSize - \since 4.6 - \brief a custom size used for laying out the page contents. - - By default all pages are laid out using the viewport of the page as the base. - - As pages mostly are designed for desktop usage, they often do not layout properly - on small devices as the contents require a certain view width. For this reason - it is common to use a different layout size and then scale the contents to fit - within the actual view. - - If this property is set to a valid size, this size is used for all layout needs - instead of the size of the viewport. - - Setting an invalid size, makes the page fall back to using the viewport size for layout. - - \sa viewportSize -*/ - -/* - \fn void QWebEnginePage::setActualVisibleContentRect(const QRect& rect) const - This function is to be called after any (animated) scroll/pan has ended, in the case the application handles the - scrolling/panning of the web contents. This is commonly used in combination with tiling where is it common for - the application to pan the actual view, which then resizes itself to the size of the contents. - - \note Calling this function makes WebKit stop trying to calculate the visibleContentRect. To turn that on - again, call this method with an empty rect. - - \sa QWebEngineSettings::TiledBackingStoreEnabled -*/ - -/*! - \fn bool QWebEnginePage::acceptNavigationRequest(QWebEngineFrame *frame, const QNetworkRequest &request, QWebEnginePage::NavigationType type) - - This function is called whenever WebKit requests to navigate \a frame to the resource specified by \a request by means of - the specified navigation type \a type. - - If \a frame is a null pointer then navigation to a new window is requested. If the request is - accepted createWindow() will be called. - - The default implementation interprets the page's linkDelegationPolicy and emits linkClicked accordingly or returns true - to let QWebEnginePage handle the navigation itself. - - \sa createWindow() -*/ - -/*! \property QWebEnginePage::hasSelection \brief whether this page contains selected content or not. @@ -605,17 +283,7 @@ By default, this property contains an empty string. - \sa selectionChanged(), selectedHtml() -*/ - -/*! - \since 4.8 - \property QWebEnginePage::selectedHtml - \brief the HTML currently selected - - By default, this property contains an empty string. - - \sa selectionChanged(), selectedText() + \sa selectionChanged() */ /*! @@ -632,285 +300,6 @@ */ /*! - \property QWebEnginePage::modified - \brief whether the page contains unsubmitted form data, or the contents have been changed. - - By default, this property is false. - - \sa contentsChanged(), contentEditable, undoStack() -*/ - -/*! - \fn QUndoStack *QWebEnginePage::undoStack() const - Returns a pointer to the undo stack used for editable content. - - \sa modified -*/ - -/*! - \fn bool QWebEnginePage::focusNextPrevChild(bool next) - Similar to QWidget::focusNextPrevChild() it focuses the next focusable web element - if \a next is true; otherwise the previous element is focused. - - Returns true if it can find a new focusable element, or false if it can't. -*/ - -/*! - \property QWebEnginePage::contentEditable - \brief whether the content in this QWebEnginePage is editable or not - \since 4.5 - - If this property is enabled the contents of the page can be edited by the user through a visible - cursor. If disabled (the default) only HTML elements in the web page with their - \c{contenteditable} attribute set are editable. - - \sa modified, contentsChanged(), WebAction -*/ - -/*! - \property QWebEnginePage::forwardUnsupportedContent - \brief whether QWebEnginePage should forward unsupported content - - If enabled, the unsupportedContent() signal is emitted with a network reply that - can be used to read the content. - - If disabled, the download of such content is aborted immediately. - - By default unsupported content is not forwarded. -*/ - -/*! - \property QWebEnginePage::linkDelegationPolicy - \brief how QWebEnginePage should delegate the handling of links through the - linkClicked() signal - - The default is to delegate no links. -*/ - -/*! - \fn bool QWebEnginePage::swallowContextMenuEvent(QContextMenuEvent *event) - Filters the context menu event, \a event, through handlers for scrollbars and - custom event handlers in the web page. Returns true if the event was handled; - otherwise false. - - A web page may swallow a context menu event through a custom event handler, allowing for context - menus to be implemented in HTML/JavaScript. This is used by \l{http://maps.google.com/}{Google - Maps}, for example. -*/ - -/*! - \fn void QWebEnginePage::updatePositionDependentActions(const QPoint &pos) - Updates the page's actions depending on the position \a pos. For example if \a pos is over an image - element the CopyImageToClipboard action is enabled. -*/ - -/*! - \enum QWebEnginePage::Extension - - This enum describes the types of extensions that the page can support. Before using these extensions, you - should verify that the extension is supported by calling supportsExtension(). - - \value ChooseMultipleFilesExtension Whether the web page supports multiple file selection. - This extension is invoked when the web content requests one or more file names, for example - as a result of the user clicking on a "file upload" button in a HTML form where multiple - file selection is allowed. - - \value ErrorPageExtension Whether the web page can provide an error page when loading fails. - (introduced in Qt 4.6) - - \sa ChooseMultipleFilesExtensionOption, ChooseMultipleFilesExtensionReturn, ErrorPageExtensionOption, ErrorPageExtensionReturn -*/ - -/*! - \enum QWebEnginePage::ErrorDomain - \since 4.6 - - This enum describes the domain of an ErrorPageExtensionOption object (i.e. the layer in which the error occurred). - - \value QtNetwork The error occurred in the QtNetwork layer; the error code is of type QNetworkReply::NetworkError. - \value Http The error occurred in the HTTP layer; the error code is a HTTP status code (see QNetworkRequest::HttpStatusCodeAttribute). - \value WebKit The error is an internal WebKit error. -*/ - -/*! - \class QWebEnginePage::ExtensionOption - \since 4.4 - \brief The ExtensionOption class provides an extended input argument to QWebEnginePage's extension support. - - \inmodule QtWebEngine - - \sa QWebEnginePage::extension(), QWebEnginePage::ExtensionReturn -*/ - -/*! - \class QWebEnginePage::ExtensionReturn - \since 4.4 - \brief The ExtensionReturn class provides an output result from a QWebEnginePage's extension. - - \inmodule QtWebEngine - - \sa QWebEnginePage::extension(), QWebEnginePage::ExtensionOption -*/ - -/*! - \class QWebEnginePage::ErrorPageExtensionOption - \since 4.6 - \brief The ErrorPageExtensionOption class describes the option - for the error page extension. - - \inmodule QtWebEngine - - The ErrorPageExtensionOption class holds the \a url for which an error occurred as well as - the associated \a frame. - - The error itself is reported by an error \a domain, the \a error code as well as \a errorString. - - \sa QWebEnginePage::extension(), QWebEnginePage::ErrorPageExtensionReturn -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionOption::url - \brief the url for which an error occurred -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionOption::frame - \brief the frame associated with the error -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionOption::domain - \brief the domain that reported the error -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionOption::error - \brief the error code. Interpretation of the value depends on the \a domain - \sa QWebEnginePage::ErrorDomain -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionOption::errorString - \brief a string that describes the error -*/ - -/*! - \class QWebEnginePage::ErrorPageExtensionReturn - \since 4.6 - \brief The ErrorPageExtensionReturn describes the error page, which will be shown for the - frame for which the error occurred. - - \inmodule QtWebEngine - - The ErrorPageExtensionReturn class holds the data needed for creating an error page. Some are - optional such as \a contentType, which defaults to "text/html", as well as the \a encoding, which - is assumed to be UTF-8 if not indicated otherwise. - - The error page is stored in the \a content byte array, as HTML content. In order to convert a - QString to a byte array, the QString::toUtf8() method can be used. - - External objects such as stylesheets or images referenced in the HTML are located relative to - \a baseUrl. - - \sa QWebEnginePage::extension(), QWebEnginePage::ErrorPageExtensionOption, QString::toUtf8() -*/ - -/*! - \fn QWebEnginePage::ErrorPageExtensionReturn::ErrorPageExtensionReturn() - - Constructs a new error page object. -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionReturn::contentType - \brief the error page's content type -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionReturn::encoding - \brief the error page encoding -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionReturn::baseUrl - \brief the base url - - External objects such as stylesheets or images referenced in the HTML are located relative to this url. -*/ - -/*! - \variable QWebEnginePage::ErrorPageExtensionReturn::content - \brief the HTML content of the error page -*/ - -/*! - \class QWebEnginePage::ChooseMultipleFilesExtensionOption - \since 4.5 - \brief The ChooseMultipleFilesExtensionOption class describes the option - for the multiple files selection extension. - - \inmodule QtWebEngine - - The ChooseMultipleFilesExtensionOption class holds the frame originating the request - and the suggested filenames which might be provided. - - \sa QWebEnginePage::extension(), QWebEnginePage::chooseFile(), QWebEnginePage::ChooseMultipleFilesExtensionReturn -*/ - -/*! - \variable QWebEnginePage::ChooseMultipleFilesExtensionOption::parentFrame - \brief The frame in which the request originated -*/ - -/*! - \variable QWebEnginePage::ChooseMultipleFilesExtensionOption::suggestedFileNames - \brief The suggested filenames -*/ - -/*! - \variable QWebEnginePage::ChooseMultipleFilesExtensionReturn::fileNames - \brief The selected filenames -*/ - -/*! - \class QWebEnginePage::ChooseMultipleFilesExtensionReturn - \since 4.5 - \brief The ChooseMultipleFilesExtensionReturn describes the return value - for the multiple files selection extension. - - \inmodule QtWebEngine - - The ChooseMultipleFilesExtensionReturn class holds the filenames selected by the user - when the extension is invoked. - - \sa QWebEnginePage::extension(), QWebEnginePage::ChooseMultipleFilesExtensionOption -*/ - -/*! - \fn bool QWebEnginePage::extension(Extension extension, const ExtensionOption *option, ExtensionReturn *output) - This virtual function can be reimplemented in a QWebEnginePage subclass to provide support for extensions. The \a option - argument is provided as input to the extension; the output results can be stored in \a output. - - The behavior of this function is determined by \a extension. The \a option - and \a output values are typically casted to the corresponding types (for - example, ChooseMultipleFilesExtensionOption and - ChooseMultipleFilesExtensionReturn for ChooseMultipleFilesExtension). - - You can call supportsExtension() to check if an extension is supported by the page. - - Returns true if the extension was called successfully; otherwise returns false. - - \sa supportsExtension(), Extension -*/ - -/*! - \fn bool QWebEnginePage::supportsExtension(Extension extension) const - This virtual function returns true if the web page supports \a extension; otherwise false is returned. - - \sa extension() -*/ - -/*! \fn bool QWebEnginePage::findText(const QString &subString, FindFlags options) Finds the specified string, \a subString, in the page, using the given \a options. @@ -927,13 +316,6 @@ */ /*! - \fn QWebEngineSettings *QWebEnginePage::settings() const - Returns a pointer to the page's settings object. - - \sa QWebEngineSettings::globalSettings() -*/ - -/*! \fn QString QWebEnginePage::chooseFile(QWebEngineFrame *parentFrame, const QString& suggestedFile) This function is called when the web content requests a file name, for example as a result of the user clicking on a "file upload" button in a HTML form. @@ -945,87 +327,6 @@ */ /*! - \fn void QWebEnginePage::setNetworkAccessManager(QNetworkAccessManager *manager) - Sets the QNetworkAccessManager \a manager responsible for serving network requests for this - QWebEnginePage. - - \note It is currently not supported to change the network access manager after the - QWebEnginePage has used it. The results of doing this are undefined. - - \sa networkAccessManager() -*/ - -/*! - \fn QNetworkAccessManager *QWebEnginePage::networkAccessManager() const - Returns the QNetworkAccessManager that is responsible for serving network - requests for this QWebEnginePage. - - \sa setNetworkAccessManager() -*/ - -/*! - \fn void QWebEnginePage::setPluginFactory(QWebEnginePluginFactory *factory) - Sets the QWebEnginePluginFactory \a factory responsible for creating plugins embedded into this - QWebEnginePage. - - Note: The plugin factory is only used if the QWebEngineSettings::PluginsEnabled attribute is enabled. - - \sa pluginFactory() -*/ - -/*! - \fn QWebEnginePluginFactory *QWebEnginePage::pluginFactory() const - Returns the QWebEnginePluginFactory that is responsible for creating plugins embedded into - this QWebEnginePage. If no plugin factory is installed a null pointer is returned. - - \sa setPluginFactory() -*/ - -/*! - \fn QString QWebEnginePage::userAgentForUrl(const QUrl&) const - This function is called when a user agent for HTTP requests is needed. You can reimplement this - function to dynamically return different user agents for different URLs, based on the \a url parameter. - - The default implementation returns the following value: - - "Mozilla/5.0 (%Platform%%Security%%Subplatform%) AppleWebKit/%WebKitVersion% (KHTML, like Gecko) %AppVersion Safari/%WebKitVersion%" - - In this string the following values are replaced at run-time: - \list - \li %Platform% expands to the windowing system followed by "; " if it is not Windows (e.g. "X11; "). - \li %Security% expands to "N; " if SSL is disabled. - \li %Subplatform% expands to the operating system version (e.g. "Windows NT 6.1" or "Intel Mac OS X 10.5"). - \li %WebKitVersion% is the version of WebKit the application was compiled against. - \li %AppVersion% expands to QCoreApplication::applicationName()/QCoreApplication::applicationVersion() if they're set; otherwise defaulting to Qt and the current Qt version. - \endlist -*/ - -/*! - \fn quint64 QWebEnginePage::totalBytes() const - Returns the total number of bytes that were received from the network to render the current page, - including extra content such as embedded images. - - \sa bytesReceived() -*/ - -/*! - \fn quint64 QWebEnginePage::bytesReceived() const - Returns the number of bytes that were received from the network to render the current page. - - \sa totalBytes(), loadProgress() -*/ - -/*! - \since 4.8 - \fn void QWebEnginePage::viewportChangeRequested() - - Page authors can provide the supplied values by using the viewport meta tag. More information - about this can be found at \l{http://developer.apple.com/safari/library/documentation/appleapplications/reference/safariwebcontent/usingtheviewport/usingtheviewport.html}{Safari Reference Library: Using the Viewport Meta Tag}. - - \sa QWebEnginePage::ViewportAttributes, setPreferredContentsSize() -*/ - -/*! \fn void QWebEnginePage::loadStarted() This signal is emitted when a page starts loading content. @@ -1055,34 +356,6 @@ */ /*! - \fn void QWebEnginePage::linkHovered(const QString &link, const QString &title, const QString &textContent) - - This signal is emitted when the mouse hovers over a link. - - \a link contains the link url. - \a title is the link element's title, if it is specified in the markup. - \a textContent provides text within the link element, e.g., text inside an HTML anchor tag. - - When the mouse leaves the link element the signal is emitted with empty parameters. - - \sa linkClicked() -*/ - -/*! - \fn void QWebEnginePage::statusBarMessage(const QString& text) - - This signal is emitted when the statusbar \a text is changed by the page. -*/ - -/*! - \fn void QWebEnginePage::frameCreated(QWebEngineFrame *frame) - - This signal is emitted whenever the page creates a new \a frame. - - \sa currentFrame() -*/ - -/*! \fn void QWebEnginePage::selectionChanged() This signal is emitted whenever the selection changes, either interactively @@ -1092,16 +365,6 @@ */ /*! - \fn void QWebEnginePage::contentsChanged() - \since 4.5 - - This signal is emitted whenever the text in form elements changes - as well as other editable content. - - \sa contentEditable, modified, toHtml(), toPlainText() -*/ - -/*! \fn void QWebEnginePage::geometryChangeRequested(const QRect& geom) This signal is emitted whenever the document wants to change the position and size of the @@ -1109,28 +372,6 @@ */ /*! - \fn void QWebEnginePage::repaintRequested(const QRect& dirtyRect) - - This signal is emitted whenever this QWebEnginePage should be updated. It's useful - when rendering a QWebEnginePage without a QWebEngineView. - \a dirtyRect contains the area that needs to be updated. To paint the QWebEnginePage get - the mainFrame() and call the render(QPainter*, const QRegion&) method with the - \a dirtyRect as the second parameter. - - \sa mainFrame() - \sa view() -*/ - -/*! - \fn void QWebEnginePage::scrollRequested(int dx, int dy, const QRect& rectToScroll) - - This signal is emitted whenever the content given by \a rectToScroll needs - to be scrolled \a dx and \a dy downwards and no view was set. - - \sa view() -*/ - -/*! \fn void QWebEnginePage::windowCloseRequested() This signal is emitted whenever the page requests the web browser window to be closed, @@ -1138,157 +379,6 @@ */ /*! - \fn void QWebEnginePage::printRequested(QWebEngineFrame *frame) - - This signal is emitted whenever the page requests the web browser to print \a frame, - for example through the JavaScript \c{window.print()} call. - - \sa print(), QPrintPreviewDialog -*/ - -/*! - \fn void QWebEnginePage::unsupportedContent(QNetworkReply *reply) - - This signal is emitted when WebKit cannot handle a link the user navigated to or a - web server's response includes a "Content-Disposition" header with the 'attachment' - directive. If "Content-Disposition" is present in \a reply, the web server is indicating - that the client should prompt the user to save the content regardless of content-type. - See RFC 2616 sections 19.5.1 for details about Content-Disposition. - - At signal emission time the meta-data of the QNetworkReply \a reply is available. - - \note The receiving slot is responsible for deleting the QNetworkReply \a reply. - - \note This signal is only emitted if the forwardUnsupportedContent property is set to true. - - \sa downloadRequested() -*/ - -/*! - \fn void QWebEnginePage::downloadRequested(const QNetworkRequest &request) - - This signal is emitted when the user decides to download a link. The url of - the link as well as additional meta-information is contained in \a request. - - \sa unsupportedContent() -*/ - -/*! - \fn void QWebEnginePage::microFocusChanged() - - This signal is emitted when for example the position of the cursor in an editable form - element changes. It is used to inform input methods about the new on-screen position where - the user is able to enter text. This signal is usually connected to the - QWidget::updateMicroFocus() slot. -*/ - -/*! - \fn void QWebEnginePage::linkClicked(const QUrl &url) - - This signal is emitted whenever the user clicks on a link and the page's linkDelegationPolicy - property is set to delegate the link handling for the specified \a url. - - By default no links are delegated and are handled by QWebEnginePage instead. - - \note This signal possibly won't be emitted for clicked links which use - JavaScript to trigger navigation. - - \sa linkHovered() -*/ - -/*! - \fn void QWebEnginePage::toolBarVisibilityChangeRequested(bool visible) - - This signal is emitted whenever the visibility of the toolbar in a web browser - window that hosts QWebEnginePage should be changed to \a visible. -*/ - -/*! - \fn void QWebEnginePage::statusBarVisibilityChangeRequested(bool visible) - - This signal is emitted whenever the visibility of the statusbar in a web browser - window that hosts QWebEnginePage should be changed to \a visible. -*/ - -/*! - \fn void QWebEnginePage::menuBarVisibilityChangeRequested(bool visible) - - This signal is emitted whenever the visibility of the menubar in a web browser - window that hosts QWebEnginePage should be changed to \a visible. -*/ - -/*! - \fn void QWebEnginePage::databaseQuotaExceeded(QWebEngineFrame* frame, QString databaseName); - \since 4.5 - - This signal is emitted whenever the web site shown in \a frame is asking to store data - to the database \a databaseName and the quota allocated to that web site is exceeded. - - \sa QWebEngineDatabase -*/ -/*! - \fn void QWebEnginePage::applicationCacheQuotaExceeded(QWebEngineSecurityOrigin* origin, quint64 defaultOriginQuota, quint64 totalSpaceNeeded); - - This signal is emitted whenever the web site is asking to store data to the application cache - database databaseName and the quota allocated to that web site is exceeded. - -*/ - -/*! - \since 4.5 - \fn void QWebEnginePage::saveFrameStateRequested(QWebEngineFrame* frame, QWebEngineHistoryItem* item); - - This signal is emitted shortly before the history of navigated pages - in \a frame is changed, for example when navigating back in the history. - - The provided QWebEngineHistoryItem, \a item, holds the history entry of the frame before - the change. - - A potential use-case for this signal is to store custom data in - the QWebEngineHistoryItem associated to the frame, using QWebEngineHistoryItem::setUserData(). -*/ - -/*! - \since 4.5 - \fn void QWebEnginePage::restoreFrameStateRequested(QWebEngineFrame* frame); - - This signal is emitted when the load of \a frame is finished and the application may now update its state accordingly. -*/ - -/*! - \enum QWebEnginePage::RenderLayer - - This enum describes the layers available for rendering using \l{QWebEnginePage::}{render()}. - The layers can be OR-ed together from the following list: - - \value ContentsLayer The web content of the frame - \value ScrollBarLayer The scrollbars of the frame - \value PanIconLayer The icon used when panning the frame - - \value AllLayers Includes all the above layers -*/ - -/*! - \fn void QWebEnginePage::addToJavaScriptWindowObject(const QString &name, QObject *object, ValueOwnership own) - - Make \a object available under \a name from within the frame's JavaScript - context. The \a object will be inserted as a child of the frame's window - object. - - Qt properties will be exposed as JavaScript properties and slots as - JavaScript methods. - The interaction between C++ and JavaScript is explained in the documentation of the \l{The Qt WebKit Bridge}{Qt WebKit bridge}. - - If you want to ensure that your QObjects remain accessible after loading a - new URL, you should add them in a slot connected to the - javaScriptWindowObjectCleared() signal. - - If Javascript is not enabled for this page, then this method does nothing. - - The ownership of \a object is specified using \a own. -*/ - -/*! \fn QString QWebEnginePage::toHtml() const Returns the frame's content as HTML, enclosed in HTML and BODY tags. @@ -1311,39 +401,6 @@ */ /*! - \fn QMultiMap<QString, QString> QWebEnginePage::metaData() const - \since 4.5 - \brief Returns the meta data in this frame as a QMultiMap - - The meta data consists of the name and content attributes of the - of the \c{<meta>} tags in the HTML document. - - For example: - - \code - <html> - <head> - <meta name="description" content="This document is a tutorial about Qt development"> - <meta name="keywords" content="Qt, WebKit, Programming"> - </head> - ... - </html> - \endcode - - Given the above HTML code the metaData() function will return a map with two entries: - \table - \header \li Key - \li Value - \row \li "description" - \li "This document is a tutorial about Qt development" - \row \li "keywords" - \li "Qt, WebKit, Programming" - \endtable - - This function returns a multi map to support multiple meta tags with the same attribute name. -*/ - -/*! \property QWebEnginePage::url \brief the url of the frame currently viewed @@ -1365,25 +422,6 @@ */ /*! - \since 4.6 - \property QWebEnginePage::baseUrl - \brief the base URL of the frame, can be used to resolve relative URLs - \since 4.6 -*/ - -/*! - \property QWebEnginePage::icon - \brief the icon associated with this frame - - \sa iconChanged(), QWebEngineSettings::iconForUrl() -*/ - -/*! - \fn QString QWebEnginePage::frameName() const - The name of this frame as defined by the parent frame. -*/ - -/*! \fn void QWebEnginePage::load(const QUrl &url) Loads \a url into this frame. @@ -1393,18 +431,6 @@ */ /*! - \fn void QWebEnginePage::load(const QNetworkRequest &req, QNetworkAccessManager::Operation operation, const QByteArray &body) - Loads a network request, \a req, into this frame, using the method specified in \a - operation. - - \a body is optional and is only used for POST operations. - - \note The view remains the same until enough data has arrived to display the new content. - - \sa setUrl() -*/ - -/*! \fn void QWebEnginePage::setHtml(const QString &html, const QUrl &baseUrl) Sets the content of this frame to \a html. \a baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets. @@ -1446,218 +472,12 @@ */ /*! - \fn QWebEnginePage *QWebEnginePage::parentFrame() const - Returns the parent frame of this frame, or 0 if the frame is the web pages - main frame. - - This is equivalent to qobject_cast<QWebEnginePage*>(frame->parent()). - - \sa childFrames() -*/ - -/*! - \fn QList<QWebEnginePage*> QWebEnginePage::childFrames() const - Returns a list of all frames that are direct children of this frame. - - \sa parentFrame() -*/ - -/*! - \fn Qt::ScrollBarPolicy QWebEnginePage::scrollBarPolicy(Qt::Orientation orientation) const - Returns the scrollbar policy for the scrollbar defined by \a orientation. -*/ - -/*! - \fn void QWebEnginePage::setScrollBarPolicy(Qt::Orientation orientation, Qt::ScrollBarPolicy policy) - Sets the scrollbar policy for the scrollbar defined by \a orientation to \a policy. -*/ - -/*! - \fn void QWebEnginePage::setScrollBarValue(Qt::Orientation orientation, int value) - Sets the current \a value for the scrollbar with orientation \a orientation. - - The scrollbar forces the \a value to be within the legal range: minimum <= value <= maximum. - - Changing the value also updates the thumb position. - - \sa scrollBarMinimum(), scrollBarMaximum() -*/ - -/*! - \fn int QWebEnginePage::scrollBarValue(Qt::Orientation orientation) const - Returns the current value for the scrollbar with orientation \a orientation, or 0 - if no scrollbar is found for \a orientation. - - \sa scrollBarMinimum(), scrollBarMaximum() -*/ - -/*! - \fn int QWebEnginePage::scrollBarMaximum(Qt::Orientation orientation) const - Returns the maximum value for the scrollbar with orientation \a orientation, or 0 - if no scrollbar is found for \a orientation. - - \sa scrollBarMinimum() -*/ - -/*! - \fn int QWebEnginePage::scrollBarMinimum(Qt::Orientation orientation) const - Returns the minimum value for the scrollbar with orientation \a orientation. - - The minimum value is always 0. - - \sa scrollBarMaximum() -*/ - -/*! - \fn QRect QWebEnginePage::scrollBarGeometry(Qt::Orientation orientation) const - \since 4.6 - Returns the geometry for the scrollbar with orientation \a orientation. - - If the scrollbar does not exist an empty rect is returned. -*/ - -/*! - \fn void QWebEnginePage::scroll(int dx, int dy) - \since 4.5 - Scrolls the frame \a dx pixels to the right and \a dy pixels downward. Both - \a dx and \a dy may be negative. - - \sa QWebEnginePage::scrollPosition -*/ - -/*! - \property QWebEnginePage::scrollPosition - \since 4.5 - \brief the position the frame is currently scrolled to. -*/ - -/*! - \fn void QWebEnginePage::scrollToAnchor(const QString& anchor) - \since 4.7 - Scrolls the frame to the given \a anchor name. -*/ - -/*! - \fn void QWebEnginePage::render(QPainter* painter, RenderLayers layer, const QRegion& clip) - \since 4.6 - Render the \a layer of the frame using \a painter clipping to \a clip. - - \sa print() -*/ - -/*! - \fn void QWebEnginePage::render(QPainter* painter, const QRegion& clip) - Render the frame into \a painter clipping to \a clip. -*/ - -/*! - \property QWebEnginePage::textSizeMultiplier - \brief the scaling factor for all text in the frame - \obsolete - - Use setZoomFactor instead, in combination with the ZoomTextOnly attribute in - QWebEngineSettings. - - \note Setting this property also enables the ZoomTextOnly attribute in - QWebEngineSettings. -*/ - -/*! - \fn void QWebEnginePage::setTextSizeMultiplier(qreal factor) - Sets the value of the multiplier used to scale the text in a Web frame to - the \a factor specified. -*/ - -/*! - \fn qreal QWebEnginePage::textSizeMultiplier() const - Returns the value of the multiplier used to scale the text in a Web frame. -*/ - -/*! \property QWebEnginePage::zoomFactor \since 4.5 \brief the zoom factor for the frame */ /*! - \property QWebEnginePage::focus - \since 4.6 - - Returns true if this frame has keyboard input focus; otherwise, returns false. -*/ - -/*! - \fn void QWebEnginePage::setFocus() - \since 4.6 - - Gives keyboard input focus to this frame. -*/ - -/*! - \fn QPoint QWebEnginePage::pos() const - Returns the position of the frame relative to it's parent frame. -*/ - -/*! - \fn QRect QWebEnginePage::geometry() const - Return the geometry of the frame relative to it's parent frame. -*/ - -/*! - \property QWebEnginePage::contentsSize - \brief the size of the contents in this frame - - \sa contentsSizeChanged() -*/ - -/*! - \fn QWebEngineElement QWebEnginePage::documentElement() const - \since 4.6 - - Returns the document element of this frame. - - The document element provides access to the entire structured - content of the frame. -*/ - -/*! - \fn QWebElementCollection QWebEnginePage::findAllElements(const QString &selectorQuery) const - \since 4.6 - Returns a new list of elements matching the given CSS selector \a selectorQuery. - If there are no matching elements, an empty list is returned. - - \l{http://www.w3.org/TR/REC-CSS2/selector.html#q1}{Standard CSS2 selector} syntax is - used for the query. - - \sa QWebEngineElement::findAll() -*/ - -/*! - \fn QWebEngineElement QWebEnginePage::findFirstElement(const QString &selectorQuery) const - \since 4.6 - Returns the first element in the frame's document that matches the - given CSS selector \a selectorQuery. If there is no matching element, a - null element is returned. - - \l{http://www.w3.org/TR/REC-CSS2/selector.html#q1}{Standard CSS2 selector} syntax is - used for the query. - - \sa QWebEngineElement::findFirst() -*/ - -/*! - \fn QWebEngineHitTestResult QWebEnginePage::hitTestContent(const QPoint &pos) const - Performs a hit test on the frame contents at the given position \a pos and returns the hit test result. -*/ - -/*! - \fn void QWebEnginePage::print(QPrinter *printer) const - Prints the frame to the given \a printer. - - \sa render() -*/ - -/*! \fn QVariant QWebEnginePage::evaluateJavaScript(const QString& scriptSource) Evaluates the JavaScript defined by \a scriptSource using this frame as context and returns the result of the last executed statement. @@ -1666,30 +486,6 @@ */ /*! - \fn QWebEngineSecurityOrigin QWebEnginePage::securityOrigin() const - \since 4.5 - - Returns the frame's security origin. -*/ - -/*! - \fn void QWebEnginePage::javaScriptWindowObjectCleared() - - This signal is emitted whenever the global window object of the JavaScript - environment is cleared, e.g., before starting a new load. - - If you intend to add QObjects to a QWebEnginePage using - addToJavaScriptWindowObject(), you should add them in a slot connected - to this signal. This ensures that your objects remain accessible when - loading new URLs. -*/ - -/*! - \fn void QWebEnginePage::provisionalLoad() - \internal -*/ - -/*! \fn void QWebEnginePage::titleChanged(const QString &title) This signal is emitted whenever the title of the frame changes. @@ -1706,163 +502,3 @@ \sa url() */ - -/*! - \fn void QWebEnginePage::initialLayoutCompleted() - - This signal is emitted when the frame is laid out the first time. - This is the first time you will see contents displayed on the frame. - - \note A frame can be laid out multiple times. -*/ - -/*! - \fn void QWebEnginePage::iconChanged() - - This signal is emitted when the icon ("favicon") associated with the frame - has been loaded. - - \sa icon() -*/ - -/*! - \fn void QWebEnginePage::contentsSizeChanged(const QSize &size) - \since 4.6 - - This signal is emitted when the frame's contents size changes - to \a size. - - \sa contentsSize() -*/ - -/*! - \class QWebEngineHitTestResult - \since 4.4 - \brief The QWebEngineHitTestResult class provides information about the web - page content after a hit test. - - \inmodule QtWebEngine - - QWebEngineHitTestResult is returned by QWebEnginePage::hitTestContent() to provide - information about the content of the web page at the specified position. -*/ - -/*! - \fn QWebEngineHitTestResult::QWebEngineHitTestResult() - Constructs a null hit test result. -*/ - -/*! - \fn QWebEngineHitTestResult::QWebEngineHitTestResult(const QWebEngineHitTestResult &other) - Constructs a hit test result from \a other. -*/ - -/*! - \fn QWebEngineHitTestResult &QWebEngineHitTestResult::operator=(const QWebEngineHitTestResult &other) - Assigns the \a other hit test result to this. -*/ - -/*! - \fn QWebEngineHitTestResult::~QWebEngineHitTestResult() - Destructor. -*/ - -/*! - \fn bool QWebEngineHitTestResult::isNull() const - Returns true if the hit test result is null; otherwise returns false. -*/ - -/*! - \fn QPoint QWebEngineHitTestResult::pos() const - Returns the position where the hit test occurred in the coordinates of frame containing the element hit. - - \sa frame() -*/ - -/*! - \fn QRect QWebEngineHitTestResult::boundingRect() const - \since 4.5 - Returns the bounding rect of the element. -*/ - -/*! - \fn QWebEngineElement QWebEngineHitTestResult::enclosingBlockElement() const - \since 4.6 - Returns the block element that encloses the element hit. - - A block element is an element that is rendered using the - CSS "block" style. This includes for example text - paragraphs. -*/ - -/*! - \fn QString QWebEngineHitTestResult::title() const - Returns the title of the nearest enclosing HTML element. -*/ - -/*! - \fn QString QWebEngineHitTestResult::linkText() const - Returns the text of the link. -*/ - -/*! - \fn QUrl QWebEngineHitTestResult::linkUrl() const - Returns the url to which the link points to. -*/ - -/*! - \fn QUrl QWebEngineHitTestResult::linkTitle() const - Returns the title of the link. -*/ - -/*! - \fn QWebEngineElement QWebEngineHitTestResult::linkElement() const - \since 4.6 - Returns the element that represents the link. - - \sa linkTargetFrame() -*/ - -/*! - \fn QWebEnginePage *QWebEngineHitTestResult::linkTargetFrame() const - Returns the frame that will load the link if it is activated. - - \sa linkElement() -*/ - -/*! - \fn QString QWebEngineHitTestResult::alternateText() const - Returns the alternate text of the element. This corresponds to the HTML alt attribute. -*/ - -/*! - \fn QUrl QWebEngineHitTestResult::imageUrl() const - Returns the url of the image. -*/ - -/*! - \fn QPixmap QWebEngineHitTestResult::pixmap() const - Returns a QPixmap containing the image. A null pixmap is returned if the - element being tested is not an image. -*/ - -/*! - \fn bool QWebEngineHitTestResult::isContentEditable() const - Returns true if the content is editable by the user; otherwise returns false. -*/ - -/*! - \fn bool QWebEngineHitTestResult::isContentSelected() const - Returns true if the content tested is part of the selection; otherwise returns false. -*/ - -/*! - \fn QWebEngineElement QWebEngineHitTestResult::element() const - \since 4.6 - Returns the underlying DOM element as QWebEngineElement. -*/ - -/*! - \fn QWebEnginePage *QWebEngineHitTestResult::frame() const - Returns the frame of the element hit. -*/ diff --git a/src/webenginewidgets/doc/src/qwebenginesecurityorigin_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesecurityorigin_lgpl.qdoc deleted file mode 100644 index ec75f5fe4..000000000 --- a/src/webenginewidgets/doc/src/qwebenginesecurityorigin_lgpl.qdoc +++ /dev/null @@ -1,149 +0,0 @@ -/* - Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -// 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. - -/*! - \class QWebEngineSecurityOrigin - \since 4.5 - \brief The QWebEngineSecurityOrigin class defines a security boundary for web sites. - - \inmodule QtWebEngine - - QWebEngineSecurityOrigin provides access to the security domains defined by web sites. - An origin consists of a host name, a scheme, and a port number. Web sites - with the same security origin can access each other's resources for client-side - scripting or databases. - - For example the site \c{http://www.example.com/my/page.html} is allowed to share the same - database as \c{http://www.example.com/my/overview.html}, or access each other's - documents when used in HTML frame sets and JavaScript. At the same time it prevents - \c{http://www.malicious.com/evil.html} from accessing \c{http://www.example.com/}'s resources, - because they are of a different security origin. - - By default local schemes like \c{file://} and \c{qrc://} are concidered to be in the same - security origin, and can access each other's resources. You can add additional local schemes - by using QWebEngineSecurityOrigin::addLocalScheme(), or override the default same-origin behavior - by setting QWebEngineSettings::LocalContentCanAccessFileUrls to \c{false}. - - \note Local resources are by default restricted from accessing remote content, which - means your \c{file://} will not be able to access \c{http://domain.com/foo.html}. You - can relax this restriction by setting QWebEngineSettings::LocalContentCanAccessRemoteUrls to - \c{true}. - - Call QWebEnginePage::securityOrigin() to get the QWebEngineSecurityOrigin for a frame in a - web page, and use host(), scheme() and port() to identify the security origin. - - Use databases() to access the databases defined within a security origin. The - disk usage of the origin's databases can be limited with setDatabaseQuota(). - databaseQuota() and databaseUsage() report the current limit as well as the - current usage. - - For more information refer to the - \l{http://en.wikipedia.org/wiki/Same_origin_policy}{"Same origin policy" Wikipedia Article}. - - \sa QWebEnginePage::securityOrigin() -*/ - -/*! - \fn QString QWebEngineSecurityOrigin::scheme() const - Returns the scheme defining the security origin. -*/ - -/*! - \fn QString QWebEngineSecurityOrigin::host() const - Returns the host name defining the security origin. -*/ - -/*! - \fn int QWebEngineSecurityOrigin::port() const - Returns the port number defining the security origin. -*/ - -/*! - \fn qint64 QWebEngineSecurityOrigin::databaseUsage() const - Returns the number of bytes all databases in the security origin - use on the disk. -*/ - -/*! - \fn qint64 QWebEngineSecurityOrigin::databaseQuota() const - Returns the quota for the databases in the security origin. -*/ - -/*! - \fn void QWebEngineSecurityOrigin::setDatabaseQuota(qint64 quota) - Sets the quota for the databases in the security origin to \a quota bytes. - - If the quota is set to a value less than the current usage, the quota will remain - and no data will be purged to meet the new quota. However, no new data can be added - to databases in this origin. -*/ - -/*! - \fn QWebEngineSecurityOrigin::~QWebEngineSecurityOrigin() - Destroys the security origin. -*/ - -/*! - \fn QList<QWebEngineSecurityOrigin> QWebEngineSecurityOrigin::allOrigins() - Returns a list of all security origins with a database quota defined. -*/ - -/*! - \fn QList<QWebEngineDatabase> QWebEngineSecurityOrigin::databases() const - Returns a list of all databases defined in the security origin. -*/ - -/*! - \fn void QWebEngineSecurityOrigin::addLocalScheme(const QString& scheme) - \since 4.6 - - Adds the given \a scheme to the list of schemes that are considered equivalent - to the \c file: scheme. - - Cross domain restrictions depend on the two web settings QWebEngineSettings::LocalContentCanAccessFileUrls - and QWebEngineSettings::LocalContentCanAccessFileUrls. By default all local schemes are concidered to be - in the same security origin, and local schemes can not access remote content. -*/ - -/*! - \fn void QWebEngineSecurityOrigin::removeLocalScheme(const QString& scheme) - \since 4.6 - - Removes the given \a scheme from the list of local schemes. - - \note You can not remove the \c{file://} scheme from the list - of local schemes. - - \sa addLocalScheme() -*/ - -/*! - \fn QStringList QWebEngineSecurityOrigin::localSchemes() - \since 4.6 - Returns a list of all the schemes concidered to be local. - - By default this is \c{file://} and \c{qrc://}. - - \sa addLocalScheme(), removeLocalScheme() -*/ diff --git a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc deleted file mode 100644 index af639f196..000000000 --- a/src/webenginewidgets/doc/src/qwebenginesettings_lgpl.qdoc +++ /dev/null @@ -1,579 +0,0 @@ -/* - Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies). - Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies) - - 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. -*/ - -// 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. - -/*! - \class QWebEngineSettings - \since 4.4 - \brief The QWebEngineSettings class provides an object to store the settings used - by QWebEnginePage. - - \inmodule QtWebEngine - - Each QWebEnginePage object has its own QWebEngineSettings object, which configures the - settings for that page. If a setting is not configured, then it is looked - up in the global settings object, which can be accessed using - globalSettings(). - - QWebEngineSettings allows configuration of browser properties, such as font sizes and - families, the location of a custom style sheet, and generic attributes like - JavaScript and plugins. Individual attributes are set using the setAttribute() - function. The \l{QWebEngineSettings::WebAttribute}{WebAttribute} enum further describes - each attribute. - - QWebEngineSettings also configures global properties such as the web page memory - cache, icon database, local database storage and offline - applications storage. - - \section1 Enabling Plugins - - Support for browser plugins can enabled by setting the - \l{QWebEngineSettings::PluginsEnabled}{PluginsEnabled} attribute. For many applications, - this attribute is enabled for all pages by setting it on the - \l{globalSettings()}{global settings object}. Qt WebKit will always ignore this setting - when processing Qt plugins. The decision to allow a Qt plugin is made by the client - in its reimplementation of QWebEnginePage::createPlugin(). - - \section1 Web Application Support - - WebKit provides support for features specified in \l{HTML 5} that improve the - performance and capabilities of Web applications. These include client-side - (offline) storage and the use of a Web application cache. - - Client-side (offline) storage is an improvement over the use of cookies to - store persistent data in Web applications. Applications can configure and - enable the use of an offline storage database by calling the - setOfflineStoragePath() with an appropriate file path, and can limit the quota - for each application by calling setOfflineStorageDefaultQuota(). - - \sa QWebEnginePage::settings(), QWebEngineView::settings(), {WebEngine Tab Browser Example} -*/ - -/*! - \fn QWebEngineSettings* QWebEngineSettings::globalSettings() - Returns the global settings object. - - Any setting changed on the default object is automatically applied to all - QWebEnginePage instances where the particular setting is not overridden already. -*/ - -/*! - \enum QWebEngineSettings::FontFamily - - This enum describes the generic font families defined by CSS 2. - For more information see the - \l{http://www.w3.org/TR/REC-CSS2/fonts.html#generic-font-families}{CSS standard}. - - \value StandardFont - \value FixedFont - \value SerifFont - \value SansSerifFont - \value CursiveFont - \value FantasyFont -*/ - -/*! - \enum QWebEngineSettings::FontSize - - This enum describes the font sizes configurable through QWebEngineSettings. - - \value MinimumFontSize The hard minimum font size. - \value MinimumLogicalFontSize The minimum logical font size that is applied - when zooming out with QWebEnginePage::setTextSizeMultiplier(). - \value DefaultFontSize The default font size for regular text. - \value DefaultFixedFontSize The default font size for fixed-pitch text. -*/ - -/*! - \enum QWebEngineSettings::ThirdPartyCookiePolicy - - This enum describes the policies configurable for accepting and sending - third-party cookies. These are cookies that are set or retrieved when fetching - a resource that is stored for a different registry-controlled domain from the page containing it. - - \value AlwaysAllowThirdPartyCookies Allow third-party resources to set and retrieve cookies. - \value AlwaysBlockThirdPartyCookies Never allow third-party resources to set and retrieve cookies. - \value AllowThirdPartyWithExistingCookies If the cookie jar already contains cookies - from a third-party, allow it to set and retrieve new and existing cookies. - - \since QtWebKit 2,3 -*/ - -/*! - \enum QWebEngineSettings::WebGraphic - - This enums describes the standard graphical elements used in webpages. - - \value MissingImageGraphic The replacement graphic shown when an image could not be loaded. - \value MissingPluginGraphic The replacement graphic shown when a plugin could not be loaded. - \value DefaultFrameIconGraphic The default icon for QWebEnginePage::icon(). - \value TextAreaSizeGripCornerGraphic The graphic shown for the size grip of text areas. - \value DeleteButtonGraphic The graphic shown for the WebKit-Editing-Delete-Button in Deletion UI. - \value InputSpeechButtonGraphic The graphic shown in input fields that support speech recognition. - \value SearchCancelButtonGraphic The graphic shown for clearing the text in a search field. - \value SearchCancelButtonPressedGraphic The graphic shown when SearchCancelButtonGraphic is pressed. -*/ - -/*! - \enum QWebEngineSettings::WebAttribute - - This enum describes various attributes that are configurable through QWebEngineSettings. - - \value AutoLoadImages Specifies whether images are automatically loaded in - web pages. This is enabled by default. - \value DnsPrefetchEnabled Specifies whether Qt WebKit will try to pre-fetch DNS entries to - speed up browsing. This only works as a global attribute. Only for Qt 4.6 and later. This is disabled by default. - \value JavascriptEnabled Enables or disables the running of JavaScript - programs. This is enabled by default - \value JavaEnabled Enables or disables Java applets. - Currently Java applets are not supported. - \value PluginsEnabled Enables or disables plugins in Web pages (e.g. using NPAPI). Qt plugins - with a mimetype such as "application/x-qt-plugin" are not affected by this setting. This is disabled by default. - \value PrivateBrowsingEnabled Private browsing prevents WebKit from - recording visited pages in the history and storing web page icons. This is disabled by default. - \value JavascriptCanOpenWindows Specifies whether JavaScript programs - can open new windows. This is disabled by default. - \value JavascriptCanCloseWindows Specifies whether JavaScript programs - can close windows. This is disabled by default. - \value JavascriptCanAccessClipboard Specifies whether JavaScript programs - can read or write to the clipboard. This is disabled by default. - \value DeveloperExtrasEnabled Enables extra tools for Web developers. - Currently this enables the "Inspect" element in the context menu as - well as the use of QWebEngineInspector which controls the web inspector - for web site debugging. This is disabled by default. - \value SpatialNavigationEnabled Enables or disables the Spatial Navigation - feature, which consists in the ability to navigate between focusable - elements in a Web page, such as hyperlinks and form controls, by using - Left, Right, Up and Down arrow keys. For example, if a user presses the - Right key, heuristics determine whether there is an element he might be - trying to reach towards the right and which element he probably wants. - This is disabled by default. - \value LinksIncludedInFocusChain Specifies whether hyperlinks should be - included in the keyboard focus chain. This is enabled by default. - \value ZoomTextOnly Specifies whether the zoom factor on a frame applies - only to the text or to all content. This is disabled by default. - \value PrintElementBackgrounds Specifies whether the background color and images - are also drawn when the page is printed. This is enabled by default. - \value OfflineStorageDatabaseEnabled Specifies whether support for the HTML 5 - offline storage feature is enabled or not. This is disabled by default. - \value OfflineWebApplicationCacheEnabled Specifies whether support for the HTML 5 - web application cache feature is enabled or not. This is disabled by default. - \value LocalStorageEnabled Specifies whether support for the HTML 5 - local storage feature is enabled or not. This is disabled by default. - (This value was introduced in 4.6.) - \value LocalStorageDatabaseEnabled \e{This enum value is deprecated.} Use - QWebEngineSettings::LocalStorageEnabled instead. - \value LocalContentCanAccessRemoteUrls Specifies whether locally loaded documents are - allowed to access remote urls. This is disabled by default. For more information - about security origins and local vs. remote content see QWebEngineSecurityOrigin. - (This value was introduced in 4.6.) - \value LocalContentCanAccessFileUrls Specifies whether locally loaded documents are - allowed to access other local urls. This is enabled by default. For more information - about security origins and local vs. remote content see QWebEngineSecurityOrigin. - \value XSSAuditingEnabled Specifies whether load requests should be monitored for cross-site - scripting attempts. Suspicious scripts will be blocked and reported in the inspector's - JavaScript console. Enabling this feature might have an impact on performance - and it is disabled by default. - \value AcceleratedCompositingEnabled This feature, when used in conjunction with - QGraphicsWebView, accelerates animations of web content. CSS animations of the transform and - opacity properties will be rendered by composing the cached content of the animated elements. - This is enabled by default. - \value TiledBackingStoreEnabled This setting enables the tiled backing store feature - for a QGraphicsWebView. With the tiled backing store enabled, the web page contents in and around - the current visible area is speculatively cached to bitmap tiles. The tiles are automatically kept - in sync with the web page as it changes. Enabling tiling can significantly speed up painting heavy - operations like scrolling. Enabling the feature increases memory consumption. It does not work well - with contents using CSS fixed positioning (see also \l{QGraphicsWebView::}{resizesToContents} property). - \l{QGraphicsWebView::}{tiledBackingStoreFrozen} property allows application to temporarily - freeze the contents of the backing store. This is disabled by default. - \value FrameFlatteningEnabled With this setting each subframe is expanded to its contents. - On touch devices, it is desired to not have any scrollable sub parts of the page - as it results in a confusing user experience, with scrolling sometimes scrolling sub parts - and at other times scrolling the page itself. For this reason iframes and framesets are - barely usable on touch devices. This will flatten all the frames to become one scrollable page. - This is disabled by default. - \value SiteSpecificQuirksEnabled This setting enables WebKit's workaround for broken sites. It is - enabled by default. - \value CSSGridLayoutEnabled This setting enables support for the CSS 3 Grid Layout module. This - CSS module is currently only a draft and support for it is disabled by default. - \value ScrollAnimatorEnabled This setting enables animated scrolling. It is disabled by default. - \value CaretBrowsingEnabled This setting enables caret browsing. It is disabled by default. - \value NotificationsEnabled Specifies whether support for the HTML 5 web notifications is enabled - or not. This is enabled by default. -*/ - -/*! - \fn void QWebEngineSettings::setFontSize(FontSize type, int size) - Sets the font size for \a type to \a size. -*/ - -/*! - \fn int QWebEngineSettings::fontSize(FontSize type) const - Returns the default font size for \a type. -*/ - -/*! - \fn void QWebEngineSettings::resetFontSize(FontSize type) - Resets the font size for \a type to the size specified in the global - settings object. - - This function has no effect on the global QWebEngineSettings instance. -*/ - -/*! - \fn void QWebEngineSettings::setUserStyleSheetUrl(const QUrl& location) - Specifies the location of a user stylesheet to load with every web page. - - The \a location must be either a path on the local filesystem, or a data URL - with UTF-8 and Base64 encoded data, such as: - - "data:text/css;charset=utf-8;base64,cCB7IGJhY2tncm91bmQtY29sb3I6IHJlZCB9Ow==" - - \note If the base64 data is not valid, the style will not be applied. - - \sa userStyleSheetUrl() -*/ - -/*! - \fn QUrl QWebEngineSettings::userStyleSheetUrl() const - Returns the location of the user stylesheet. - - \sa setUserStyleSheetUrl() -*/ - -/*! - \fn void QWebEngineSettings::setDefaultTextEncoding(const QString& encoding) - \since 4.6 - Specifies the default text encoding system. - - The \a encoding, must be a string describing an encoding such as "utf-8", - "iso-8859-1", etc. If left empty a default value will be used. For a more - extensive list of encoding names see \l{QTextCodec} - - \sa defaultTextEncoding() -*/ - -/*! - \fn QString QWebEngineSettings::defaultTextEncoding() const - \since 4.6 - Returns the default text encoding. - - \sa setDefaultTextEncoding() -*/ - -/*! - \fn void QWebEngineSettings::setIconDatabasePath(const QString& path) - Sets the path of the icon database to \a path. The icon database is used - to store "favicons" associated with web sites. - - \a path must point to an existing directory. - - Setting an empty path disables the icon database. - - \sa iconDatabasePath(), clearIconDatabase() -*/ - -/*! - \fn QString QWebEngineSettings::iconDatabasePath() - Returns the path of the icon database or an empty string if the icon - database is disabled. - - \sa setIconDatabasePath(), clearIconDatabase() -*/ - -/*! - \fn void QWebEngineSettings::clearIconDatabase() - Clears the icon database. -*/ - -/*! - \fn QIcon QWebEngineSettings::iconForUrl(const QUrl& url) - Returns the web site's icon for \a url. - - If the web site does not specify an icon \b OR if the icon is not in the - database, a null QIcon is returned. - - \note The returned icon's size is arbitrary. - - \sa setIconDatabasePath() -*/ - -/*! - \fn void QWebEngineSettings::setWebGraphic(WebGraphic type, const QPixmap& graphic) - Sets \a graphic to be drawn when Qt WebKit needs to draw an image of the - given \a type. - - For example, when an image cannot be loaded, the pixmap specified by - \l{QWebEngineSettings::WebGraphic}{MissingImageGraphic} is drawn instead. - - \sa webGraphic() -*/ - -/*! - \fn QPixmap QWebEngineSettings::webGraphic(WebGraphic type) - Returns a previously set pixmap used to draw replacement graphics of the - specified \a type. - - \sa setWebGraphic() -*/ - -/*! - \fn void QWebEngineSettings::clearMemoryCaches() - Frees up as much memory as possible by calling the JavaScript garbage collector and cleaning all memory caches such - as page, object and font cache. - - \since 4.6 - */ - -/*! - \fn void QWebEngineSettings::setMaximumPagesInCache(int pages) - Sets the maximum number of pages to hold in the memory page cache to \a pages. - - The Page Cache allows for a nicer user experience when navigating forth or back - to pages in the forward/back history, by pausing and resuming up to \a pages. - - For more information about the feature, please refer to: - - http://webkit.org/blog/427/webkit-page-cache-i-the-basics/ -*/ - -/*! - \fn int QWebEngineSettings::maximumPagesInCache() - Returns the maximum number of web pages that are kept in the memory cache. -*/ - -/*! - \fn void QWebEngineSettings::setObjectCacheCapacities(int cacheMinDeadCapacity, int cacheMaxDead, int totalCapacity) - Specifies the capacities for the memory cache for dead objects such as - stylesheets or scripts. - - The \a cacheMinDeadCapacity specifies the \e minimum number of bytes that - dead objects should consume when the cache is under pressure. - - \a cacheMaxDead is the \e maximum number of bytes that dead objects should - consume when the cache is \b not under pressure. - - \a totalCapacity specifies the \e maximum number of bytes that the cache - should consume \b overall. - - The cache is enabled by default. Calling setObjectCacheCapacities(0, 0, 0) - will disable the cache. Calling it with one non-zero enables it again. -*/ - -/*! - \fn void QWebEngineSettings::setThirdPartyCookiePolicy(ThirdPartyCookiePolicy policy) - Sets the third-party cookie policy, the default is AlwaysAllowThirdPartyCookies. -*/ - -/*! - \fn QWebEngineSettings::ThirdPartyCookiePolicy QWebEngineSettings::thirdPartyCookiePolicy() const - Returns the third-party cookie policy. -*/ - -/*! - \fn void QWebEngineSettings::setCSSMediaType(const QString& type) - Sets the CSS media type to \a type. - - Setting this will override the normal value of the CSS media property. - - \note Setting the value to null QString will restore the default value. -*/ - -/*! - \fn QString QWebEngineSettings::cssMediaType() const - Returns the current CSS media type. - - \note It will only return the value set through setCSSMediaType and not the one used internally. -*/ - -/*! - \fn void QWebEngineSettings::setFontFamily(FontFamily which, const QString& family) - Sets the actual font family to \a family for the specified generic family, - \a which. -*/ - -/*! - \fn QString QWebEngineSettings::fontFamily(FontFamily which) const - Returns the actual font family for the specified generic font family, - \a which. -*/ - -/*! - \fn void QWebEngineSettings::resetFontFamily(FontFamily which) - Resets the actual font family specified by \a which to the one set - in the global QWebEngineSettings instance. - - This function has no effect on the global QWebEngineSettings instance. -*/ - -/*! - \fn void QWebEngineSettings::setAttribute(WebAttribute attribute, bool on) - - Enables or disables the specified \a attribute feature depending on the - value of \a on. -*/ - -/*! - \fn bool QWebEngineSettings::testAttribute(WebAttribute attribute) const - - Returns true if \a attribute is enabled; otherwise returns false. -*/ - -/*! - \fn void QWebEngineSettings::resetAttribute(WebAttribute attribute) - - Resets the setting of \a attribute to the value specified in the - global QWebEngineSettings instance. - - This function has no effect on the global QWebEngineSettings instance. - - \sa globalSettings() -*/ - -/*! - \fn void QWebEngineSettings::setOfflineStoragePath(const QString& path) - \since 4.5 - - Sets \a path as the save location for HTML5 client-side database storage data. - - \a path must point to an existing directory. - - Setting an empty path disables the feature. - - Support for client-side databases can enabled by setting the - \l{QWebEngineSettings::OfflineStorageDatabaseEnabled}{OfflineStorageDatabaseEnabled} attribute. - - \sa offlineStoragePath() -*/ - -/*! - \fn QString QWebEngineSettings::offlineStoragePath() - \since 4.5 - - Returns the path of the HTML5 client-side database storage or an empty string if the - feature is disabled. - - \sa setOfflineStoragePath() -*/ - -/*! - \fn void QWebEngineSettings::setOfflineStorageDefaultQuota(qint64 maximumSize) - \since 4.5 - - Sets the value of the default quota for new offline storage databases - to \a maximumSize. -*/ - -/*! - \fn qint64 QWebEngineSettings::offlineStorageDefaultQuota() - \since 4.5 - - Returns the value of the default quota for new offline storage databases. -*/ - -/*! - \fn void QWebEngineSettings::setOfflineWebApplicationCachePath(const QString& path) - \since 4.6 - - Sets the path for HTML5 offline web application cache storage to \a path. - - An application cache acts like an HTTP cache in some sense. For documents - that use the application cache via JavaScript, the loader engine will - first ask the application cache for the contents, before hitting the - network. - - The feature is described in details at: - http://dev.w3.org/html5/spec/Overview.html#appcache - - \a path must point to an existing directory. - - Setting an empty path disables the feature. - - Support for offline web application cache storage can enabled by setting the - \l{QWebEngineSettings::OfflineWebApplicationCacheEnabled}{OfflineWebApplicationCacheEnabled} attribute. - - \sa offlineWebApplicationCachePath() -*/ - -/*! - \fn QString QWebEngineSettings::offlineWebApplicationCachePath() - \since 4.6 - - Returns the path of the HTML5 offline web application cache storage - or an empty string if the feature is disabled. - - \sa setOfflineWebApplicationCachePath() -*/ - -/*! - \fn void QWebEngineSettings::setOfflineWebApplicationCacheQuota(qint64 maximumSize) - \since 4.6 - - Sets the value of the quota for the offline web application cache - to \a maximumSize. -*/ - -/*! - \fn qint64 QWebEngineSettings::offlineWebApplicationCacheQuota() - \since 4.6 - - Returns the value of the quota for the offline web application cache. -*/ - -/*! - \fn void QWebEngineSettings::setLocalStoragePath(const QString& path) - \since 4.6 - - Sets the path for HTML5 local storage to \a path. - - For more information on HTML5 local storage see the - \l{http://www.w3.org/TR/webstorage/#the-localstorage-attribute}{Web Storage standard}. - - Support for local storage can enabled by setting the - \l{QWebEngineSettings::LocalStorageEnabled}{LocalStorageEnabled} attribute. - - \sa localStoragePath() -*/ - -/*! - \fn QString QWebEngineSettings::localStoragePath() const - \since 4.6 - - Returns the path for HTML5 local storage. - - \sa setLocalStoragePath() -*/ - -/*! - \fn void QWebEngineSettings::enablePersistentStorage(const QString& path) - \since 4.6 - - Enables WebKit data persistence and sets the path to \a path. - If \a path is empty, the user-specific data location specified by - \l{QDesktopServices::DataLocation}{DataLocation} will be used instead. - - This method will simultaneously set and enable the iconDatabasePath(), - localStoragePath(), offlineStoragePath() and offlineWebApplicationCachePath(). - - \sa localStoragePath() -*/ diff --git a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc index 4be4fa079..d5bda9bfd 100644 --- a/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc +++ b/src/webenginewidgets/doc/src/qwebengineview_lgpl.qdoc @@ -139,20 +139,6 @@ */ /*! - \fn void QWebEngineView::load(const QNetworkRequest &request, QNetworkAccessManager::Operation operation, const QByteArray &body) - \fn void QWebEngineView::load(const QNetworkRequest &request, QNetworkAccessManager::Operation operation, const QByteArray &body) - - Loads a network request, \a request, using the method specified in \a operation. - - \a body is optional and is only used for POST operations. - - \note The view remains the same until enough data has arrived to display the new url. - - \sa url(), urlChanged() -*/ - - -/*! \fn void QWebEngineView::setHtml(const QString &html, const QUrl &baseUrl) Sets the content of the web view to the specified \a html. @@ -198,17 +184,6 @@ */ /*! - \fn QWebEngineSettings *QWebEngineView::settings() const - Returns a pointer to the view/page specific settings object. - - It is equivalent to - - \snippet snippets/qtwebengine_qwebengineview_snippet.cpp 1 - - \sa QWebEngineSettings::globalSettings() -*/ - -/*! \property QWebEngineView::title \brief the title of the web page currently viewed @@ -228,16 +203,6 @@ \sa load(), urlChanged() */ - -/*! - \property QWebEngineView::icon - \brief the icon associated with the web page currently viewed - - By default, this property contains a null icon. - - \sa iconChanged(), QWebEngineSettings::iconForUrl() -*/ - /*! \property QWebEngineView::hasSelection \brief whether this page contains selected content or not. @@ -253,17 +218,7 @@ By default, this property contains an empty string. - \sa findText(), selectionChanged(), selectedHtml() -*/ - -/*! - \since 4.8 - \property QWebEngineView::selectedHtml - \brief the HTML currently selected - - By default, this property contains an empty string. - - \sa findText(), selectionChanged(), selectedText() + \sa findText(), selectionChanged() */ /*! @@ -284,16 +239,6 @@ \sa pageAction() */ -/*! - \property QWebEngineView::modified - \brief whether the document was modified by the user - - Parts of HTML documents can be editable for example through the - \c{contenteditable} attribute on HTML elements. - - By default, this property is false. -*/ - /* \property QWebEngineView::textInteractionFlags \brief how the view should handle user input @@ -308,32 +253,6 @@ \brief the zoom factor for the view */ - -/*! - \property QWebEngineView::textSizeMultiplier - \brief the scaling factor for all text in the frame - \obsolete - - Use setZoomFactor instead, in combination with the - ZoomTextOnly attribute in QWebEngineSettings. - - \note Setting this property also enables the - ZoomTextOnly attribute in QWebEngineSettings. - - By default, this property contains a value of 1.0. -*/ - -/*! - \fn void QWebEngineView::setTextSizeMultiplier(qreal factor) - Sets the value of the multiplier used to scale the text in a Web page to - the \a factor specified. -*/ - -/*! - \fn qreal QWebEngineView::textSizeMultiplier() const - Returns the value of the multiplier used to scale the text in a Web page. -*/ - /*! \property QWebEngineView::renderHints \since 4.6 @@ -347,31 +266,6 @@ */ /*! - \fn QPainter::RenderHints QWebEngineView::renderHints() const - \since 4.6 - Returns the render hints used by the view to render content. - - \sa QPainter::renderHints() -*/ - -/*! - \fn void QWebEngineView::setRenderHints(QPainter::RenderHints hints) - \since 4.6 - Sets the render hints used by the view to the specified \a hints. - - \sa QPainter::setRenderHints() -*/ - -/*! - \fn void QWebEngineView::setRenderHint(QPainter::RenderHint hint, bool enabled) - \since 4.6 - If \a enabled is true, enables the specified render \a hint; otherwise - disables it. - - \sa renderHints, QPainter::renderHints() -*/ - -/*! \fn bool QWebEngineView::findText(const QString &subString, QWebEnginePage::FindFlags options) Finds the specified string, \a subString, in the page, using the given \a options. @@ -390,13 +284,6 @@ */ /*! - \fn void QWebEngineView::print(QPrinter *printer) const - Prints the main frame to the given \a printer. - - \sa QWebEnginePage::print(), QPrintPreviewDialog -*/ - -/*! \fn void QWebEngineView::stop() Convenience slot that stops loading the document. @@ -451,7 +338,7 @@ reimplementing this method application must also set the JavaScriptCanOpenWindows attribute of QWebEngineSettings to true in order for it to get called. - \sa QWebEnginePage::createWindow(), QWebEnginePage::acceptNavigationRequest() + \sa QWebEnginePage::createWindow() */ /*! @@ -477,17 +364,6 @@ */ /*! - \fn void QWebEngineView::iconChanged() - - This signal is emitted whenever the icon of the page is loaded or changes. - - In order for icons to be loaded, you will need to set an icon database path - using QWebEngineSettings::setIconDatabasePath(). - - \sa icon(), QWebEngineSettings::setIconDatabasePath() -*/ - -/*! \fn void QWebEngineView::loadStarted() This signal is emitted when a new load of the page is started. @@ -495,7 +371,6 @@ \sa loadProgress(), loadFinished() */ - /*! \fn void QWebEngineView::loadFinished(bool ok) @@ -526,12 +401,3 @@ \sa loadStarted(), loadFinished() */ - -/*! - \fn void QWebEngineView::linkClicked(const QUrl &url) - - This signal is emitted whenever the user clicks on a link and the page's linkDelegationPolicy - property is set to delegate the link handling for the specified \a url. - - \sa QWebEnginePage::linkDelegationPolicy() -*/ |