Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| С тех пор: | Qt 5.6 |
| Инициализируется: | WebEngineProfile |
| Наследуется от: | QObject |
Типы публичного доступа
| Перечисление | HttpCacheType { MemoryHttpCache, DiskHttpCache } |
| Перечисление | PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Открытые функции
| QQuickWebEngineProfile(QObject *parent = Q_NULLPTR) | |
| QString | cachePath() const |
| QWebEngineCookieStore * | cookieStore() const |
| QString | httpAcceptLanguage() const |
| int | httpCacheMaximumSize() const |
| HttpCacheType | httpCacheType() const |
| QString | httpUserAgent() const |
| void | installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler) |
| bool | isOffTheRecord() const |
| PersistentCookiesPolicy | persistentCookiesPolicy() const |
| QString | persistentStoragePath() const |
| void | removeAllUrlSchemeHandlers() |
| void | removeUrlScheme(const QByteArray &scheme) |
| void | removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler) |
| void | setCachePath(const QString &path) |
| void | setHttpAcceptLanguage(const QString &httpAcceptLanguage) |
| void | setHttpCacheMaximumSize(int maxSize) |
| void | setHttpCacheType(QQuickWebEngineProfile::HttpCacheType) |
| void | setHttpUserAgent(const QString &userAgent) |
| void | setOffTheRecord(bool offTheRecord) |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
| void | setPersistentStoragePath(const QString &path) |
| void | setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor) |
| void | setStorageName(const QString &name) |
| QString | storageName() const |
| const QWebEngineUrlSchemeHandler * | urlSchemeHandler(const QByteArray &scheme) const |
- 31 открытая функция унаследована от QObject
Сигналы
| void | cachePathChanged() |
| void | downloadFinished(QQuickWebEngineDownloadItem *download) |
| void | downloadRequested(QQuickWebEngineDownloadItem *download) |
| void | httpAcceptLanguageChanged() |
| void | httpCacheMaximumSizeChanged() |
| void | httpCacheTypeChanged() |
| void | httpUserAgentChanged() |
| void | offTheRecordChanged() |
| void | persistentCookiesPolicyChanged() |
| void | persistentStoragePathChanged() |
| void | storageNameChanged() |
- 2 сигнала унаследованы от QObject
Статические открытые члены
| QQuickWebEngineProfile * | defaultProfile() |
- 11 статических открытых членов унаследовано от QObject
Дополнительные унаследованные члены
Подробное описание
Класс QQuickWebEngineProfile предоставляет профиль движка веб-страниц, используемый несколькими страницами.
Профиль движка веб-страниц содержит свойства и функциональность, общие для группы страниц веб-движка.
Информация о посещённых ссылках хранится вместе с постоянными cookie и другими постоянными данными в хранилище, описанном свойством persistentStoragePath.
Профили могут использоваться для изоляции страниц друг от друга. Типичный случай использования — выделенный профиль «вне записи» для режима «приватного просмотра». Профиль «вне записи» принудительно сохраняет cookie, кэш HTTP и другие обычно постоянные данные только в памяти. Свойство offTheRecord определяет, является ли профиль профилем «вне записи».
К стандартному профилю можно получить доступ с помощью defaultProfile(). Это встроенный профиль, к которому принадлежат все веб-страницы, не созданные специально с другим профилем.
Экземпляр WebEngineProfile может быть создан и доступен из C++ через класс QQuickWebEngineProfile, который предоставляет дополнительную функциональность в C++. Это позволяет приложениям Qt Quick перехватывать запросы URL (QQuickWebEngineProfile::setRequestInterceptor) или регистрировать пользовательские схемы URL (QQuickWebEngineProfile::installUrlSchemeHandler).
Документация типов членов
перечисление QQuickWebEngineProfile::HttpCacheType
Это перечисление описывает тип кэша HTTP:
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineProfile::MemoryHttpCache |
0 |
Использовать кэш в памяти. Это единственное возможное значение, если off-the-record установлено или путь к кэшу недоступен. |
QQuickWebEngineProfile::DiskHttpCache |
1 |
Использовать кэш на диске. Это значение по умолчанию. |
перечисление QQuickWebEngineProfile::PersistentCookiesPolicy
Это перечисление описывает политику сохранения cookie:
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineProfile::NoPersistentCookies |
0 |
Сеансовые и постоянные cookie хранятся в памяти. Это единственное возможное значение, если off-the-record установлено или путь к постоянным данным недоступен. |
QQuickWebEngineProfile::AllowPersistentCookies |
1 |
Постоянные cookie сохраняются и восстанавливаются с диска, а сеансовые cookie сохраняются на диске только для восстановления после сбоя. Это значение по умолчанию. |
QQuickWebEngineProfile::ForcePersistentCookies |
2 |
Сеансовые и постоянные cookie сохраняются и восстанавливаются с диска. |
Документация свойств
cachePath : QString
Путь к расположению, где хранятся кэши профиля, в частности кэш HTTP.
По умолчанию, кэши хранятся в каталоге, расположенном ниже QStandardPaths::writableLocation(QStandardPaths::CacheLocation), в каталоге с именем, заданным с помощью storageName.
Функции доступа:
| QString | cachePath() const |
| void | setCachePath(const QString &path) |
Сигнал уведомления:
| void | cachePathChanged() |
httpAcceptLanguage : QString
Значение поля заголовка HTTP запроса Accept-Language.
Функции доступа:
| QString | httpAcceptLanguage() const |
| void | setHttpAcceptLanguage(const QString &httpAcceptLanguage) |
Сигнал уведомления:
| void | httpAcceptLanguageChanged() |
httpCacheMaximumSize : int
Максимальный размер кэша HTTP. Если 0, размер будет управляться автоматически QtWebEngine. Значение по умолчанию 0.
Функции доступа:
| int | httpCacheMaximumSize() const |
| void | setHttpCacheMaximumSize(int maxSize) |
Сигнал уведомления:
| void | httpCacheMaximumSizeChanged() |
См. также httpCacheType.
httpCacheType : HttpCacheType
Это перечисление описывает тип кэша HTTP.
Если профиль в режиме "без сохранения истории", возвращается MemoryHttpCache.
Функции доступа:
| HttpCacheType | httpCacheType() const |
| void | setHttpCacheType(QQuickWebEngineProfile::HttpCacheType) |
Сигнал уведомления:
| void | httpCacheTypeChanged() |
httpUserAgent : QString
Строка user-agent, отправляемая с HTTP для идентификации браузера.
Функции доступа:
| QString | httpUserAgent() const |
| void | setHttpUserAgent(const QString &userAgent) |
Сигнал уведомления:
| void | httpUserAgentChanged() |
offTheRecord : bool
Определяет, является ли профиль веб-движка режимом "без сохранения истории". Профиль в режиме "без сохранения истории" заставляет хранить куки, кэш HTTP и другие обычно сохраняемые данные только в оперативной памяти.
Функции доступа:
| bool | isOffTheRecord() const |
| void | setOffTheRecord(bool offTheRecord) |
Сигнал уведомления:
| void | offTheRecordChanged() |
persistentCookiesPolicy : PersistentCookiesPolicy
Это перечисление описывает политику сохранения куки. Если профиль в режиме "без сохранения истории", возвращается NoPersistentCookies.
Функции доступа:
| PersistentCookiesPolicy | persistentCookiesPolicy() const |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
Сигнал уведомления:
| void | persistentCookiesPolicyChanged() |
persistentStoragePath : QString
Путь к расположению, где хранятся постоянные данные браузера и веб-контента. Постоянные данные включают постоянные куки, локальное хранилище HTML5 и посещённые ссылки.
По умолчанию, хранилище расположено ниже QStandardPaths::writableLocation(QStandardPaths::DataLocation) в каталоге с именем, заданным с помощью storageName.
Функции доступа:
| QString | persistentStoragePath() const |
| void | setPersistentStoragePath(const QString &path) |
Сигнал уведомления:
| void | persistentStoragePathChanged() |
storageName : QString
Имя хранилища, используемое для создания отдельных подкаталогов для каждого профиля, использующего диск для хранения постоянных данных и кэша.
Функции доступа:
| QString | storageName() const |
| void | setStorageName(const QString &name) |
Сигнал уведомления:
| void | storageNameChanged() |
См. также QQuickWebEngineProfile::persistentStoragePath и QQuickWebEngineProfile::cachePath.
Документация функций-членов
QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = Q_NULLPTR)
Создаёт новый профиль с родителем parent.
QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const
Возвращает хранилище куки для этого профиля.
[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()
Возвращает профиль по умолчанию.
Профиль по умолчанию использует имя хранилища "Default".
См. также storageName().
[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadItem *download)
Этот сигнал генерируется всякий раз, когда завершается загрузка, так как она завершилась успешно, была отменена или прервана (например, из-за потери соединения). Аргумент download содержит состояние завершённого экземпляра загрузки.
[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadItem *download)
Этот сигнал генерируется всякий раз, когда инициируется загрузка. Аргумент download содержит состояние загрузки. Загрузку необходимо явно принять с помощью QQuickWebEngineDownloadItem::accept() или она будет отменена по умолчанию. Элемент загрузки является дочерним элементом профиля. Если он не принят, он будет удалён сразу после генерации сигнала. Этот сигнал нельзя использовать с очередью подключений.
void QQuickWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)
Регистрирует обработчик handler для пользовательской схемы URL scheme в профиле.
void QQuickWebEngineProfile::removeAllUrlSchemeHandlers()
Удаляет все обработчики пользовательских схем URL, установленные в профиле.
void QQuickWebEngineProfile::removeUrlScheme(const QByteArray &scheme)
Удаляет пользовательскую схему URL scheme из профиля.
См. также removeUrlSchemeHandler().
void QQuickWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)
Удаляет обработчик пользовательской схемы URL handler из профиля.
См. также removeUrlScheme().
void QQuickWebEngineProfile::setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
Регистрирует обработчик запросов interceptor для перехвата запросов URL.
Профиль не принимает владения указателем.
См. также QWebEngineUrlRequestInterceptor.
const QWebEngineUrlSchemeHandler *QQuickWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const
Возвращает обработчик пользовательской схемы URL, зарегистрированный для схемы URL scheme.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/archives/qt-5.6/qquickwebengineprofile.html
