qwebengineprofile.h 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. /****************************************************************************
  2. **
  3. ** Copyright (C) 2016 The Qt Company Ltd.
  4. ** Contact: https://www.qt.io/licensing/
  5. **
  6. ** This file is part of the QtWebEngine module of the Qt Toolkit.
  7. **
  8. ** $QT_BEGIN_LICENSE:LGPL$
  9. ** Commercial License Usage
  10. ** Licensees holding valid commercial Qt licenses may use this file in
  11. ** accordance with the commercial license agreement provided with the
  12. ** Software or, alternatively, in accordance with the terms contained in
  13. ** a written agreement between you and The Qt Company. For licensing terms
  14. ** and conditions see https://www.qt.io/terms-conditions. For further
  15. ** information use the contact form at https://www.qt.io/contact-us.
  16. **
  17. ** GNU Lesser General Public License Usage
  18. ** Alternatively, this file may be used under the terms of the GNU Lesser
  19. ** General Public License version 3 as published by the Free Software
  20. ** Foundation and appearing in the file LICENSE.LGPL3 included in the
  21. ** packaging of this file. Please review the following information to
  22. ** ensure the GNU Lesser General Public License version 3 requirements
  23. ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
  24. **
  25. ** GNU General Public License Usage
  26. ** Alternatively, this file may be used under the terms of the GNU
  27. ** General Public License version 2.0 or (at your option) the GNU General
  28. ** Public license version 3 or any later version approved by the KDE Free
  29. ** Qt Foundation. The licenses are as published by the Free Software
  30. ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
  31. ** included in the packaging of this file. Please review the following
  32. ** information to ensure the GNU General Public License requirements will
  33. ** be met: https://www.gnu.org/licenses/gpl-2.0.html and
  34. ** https://www.gnu.org/licenses/gpl-3.0.html.
  35. **
  36. ** $QT_END_LICENSE$
  37. **
  38. ****************************************************************************/
  39. #ifndef QWEBENGINEPROFILE_H
  40. #define QWEBENGINEPROFILE_H
  41. #include <QtWebEngineWidgets/qtwebenginewidgetsglobal.h>
  42. #include <QtCore/qobject.h>
  43. #include <QtCore/qscopedpointer.h>
  44. #include <QtCore/qstring.h>
  45. QT_BEGIN_NAMESPACE
  46. class QObject;
  47. class QUrl;
  48. class QWebEngineCookieStore;
  49. class QWebEngineDownloadItem;
  50. class QWebEnginePage;
  51. class QWebEnginePagePrivate;
  52. class QWebEngineProfilePrivate;
  53. class QWebEngineSettings;
  54. class QWebEngineScriptCollection;
  55. class QWebEngineUrlRequestInterceptor;
  56. class QWebEngineUrlSchemeHandler;
  57. class QWEBENGINEWIDGETS_EXPORT QWebEngineProfile : public QObject {
  58. Q_OBJECT
  59. public:
  60. explicit QWebEngineProfile(QObject *parent = Q_NULLPTR);
  61. explicit QWebEngineProfile(const QString &name, QObject *parent = Q_NULLPTR);
  62. virtual ~QWebEngineProfile();
  63. enum HttpCacheType {
  64. MemoryHttpCache,
  65. DiskHttpCache,
  66. NoCache
  67. };
  68. enum PersistentCookiesPolicy {
  69. NoPersistentCookies,
  70. AllowPersistentCookies,
  71. ForcePersistentCookies
  72. };
  73. QString storageName() const;
  74. bool isOffTheRecord() const;
  75. QString persistentStoragePath() const;
  76. void setPersistentStoragePath(const QString &path);
  77. QString cachePath() const;
  78. void setCachePath(const QString &path);
  79. QString httpUserAgent() const;
  80. void setHttpUserAgent(const QString &userAgent);
  81. HttpCacheType httpCacheType() const;
  82. void setHttpCacheType(QWebEngineProfile::HttpCacheType);
  83. void setHttpAcceptLanguage(const QString &httpAcceptLanguage);
  84. QString httpAcceptLanguage() const;
  85. PersistentCookiesPolicy persistentCookiesPolicy() const;
  86. void setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy);
  87. int httpCacheMaximumSize() const;
  88. void setHttpCacheMaximumSize(int maxSize);
  89. QWebEngineCookieStore* cookieStore();
  90. void setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor);
  91. void clearAllVisitedLinks();
  92. void clearVisitedLinks(const QList<QUrl> &urls);
  93. bool visitedLinksContainsUrl(const QUrl &url) const;
  94. QWebEngineSettings *settings() const;
  95. QWebEngineScriptCollection *scripts() const;
  96. const QWebEngineUrlSchemeHandler *urlSchemeHandler(const QByteArray &) const;
  97. void installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *);
  98. void removeUrlScheme(const QByteArray &scheme);
  99. void removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *);
  100. void removeAllUrlSchemeHandlers();
  101. void clearHttpCache();
  102. static QWebEngineProfile *defaultProfile();
  103. Q_SIGNALS:
  104. void downloadRequested(QWebEngineDownloadItem *download);
  105. private Q_SLOTS:
  106. void destroyedUrlSchemeHandler(QWebEngineUrlSchemeHandler *obj);
  107. private:
  108. Q_DISABLE_COPY(QWebEngineProfile)
  109. Q_DECLARE_PRIVATE(QWebEngineProfile)
  110. QWebEngineProfile(QWebEngineProfilePrivate *, QObject *parent = Q_NULLPTR);
  111. friend class QWebEnginePagePrivate;
  112. friend class QWebEngineUrlSchemeHandler;
  113. QScopedPointer<QWebEngineProfilePrivate> d_ptr;
  114. };
  115. QT_END_NAMESPACE
  116. #endif // QWEBENGINEPROFILE_H