Cleanup the QtWebEngineWidgets public headers and API

Headers were left intact to leave a trace of the evolution compared
to the QtWebKit API and to make it easier to work until we had a
basic subset of the API implemented.

With the upcoming release, this patch removes this convenience in the
aim of starting polishing the headers and the documentation for the
upcoming release.

Change-Id: Iae436b4ec041d771a7002575e122835802bc9f3e
Reviewed-by: Michael Bruning <michael.bruning@digia.com>

1 files changed, 0 insertions, 395 deletions

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 &paramNames, const QStringList &paramValues) { 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