Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, общий для нескольких страниц. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| С момента: | Qt 5.6 |
| Инициализируется: | WebEngineProfile |
| Наследует: | QObject |
Этот класс был представлен в Qt 5.6.
Публичные типы
| перечисление | HttpCacheType { MemoryHttpCache, DiskHttpCache, NoCache } |
| перечисление | PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies } |
Свойства
|
|
Общедоступные функции
| QQuickWebEngineProfile(QObject *parent = Q_NULLPTR) | |
| QString | cachePath() const |
| void | clearHttpCache() |
| QWebEngineClientCertificateStore * | clientCertificateStore() |
| QWebEngineCookieStore * | cookieStore() const |
| QString | downloadPath() const |
| QString | httpAcceptLanguage() const |
| int | httpCacheMaximumSize() const |
| QQuickWebEngineProfile::HttpCacheType | httpCacheType() const |
| QString | httpUserAgent() const |
| void | installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler) |
| bool | isOffTheRecord() const |
| bool | isSpellCheckEnabled() const |
| bool | isUsedForGlobalCertificateVerification() const |
| QQuickWebEngineProfile::PersistentCookiesPolicy | persistentCookiesPolicy() const |
| QString | persistentStoragePath() const |
| void | removeAllUrlSchemeHandlers() |
| void | removeUrlScheme(const QByteArray &scheme) |
| void | removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler) |
| void | setCachePath(const QString &path) |
| QStringList | spellCheckLanguages() const |
| QString | storageName() const |
| const QWebEngineUrlSchemeHandler * | urlSchemeHandler(const QByteArray &scheme) const |
| QQmlListProperty<QQuickWebEngineScript> | userScripts() |
Сигналы
| void | cachePathChanged() |
| void | downloadFinished(QQuickWebEngineDownloadItem *download) |
| void | downloadPathChanged() |
| void | downloadRequested(QQuickWebEngineDownloadItem *download) |
| void | httpAcceptLanguageChanged() |
| void | httpCacheMaximumSizeChanged() |
| void | httpCacheTypeChanged() |
| void | httpUserAgentChanged() |
| void | offTheRecordChanged() |
| void | persistentCookiesPolicyChanged() |
| void | persistentStoragePathChanged() |
| void | presentNotification(QWebEngineNotification *notification) |
| void | spellCheckEnabledChanged() |
| void | spellCheckLanguagesChanged() |
| void | storageNameChanged() |
| void | useForGlobalCertificateVerificationChanged() |
Статические публичные члены
| QQuickWebEngineProfile * | defaultProfile() |
Подробное описание
Профиль веб-движка содержит настройки, скрипты, политику постоянных файлов cookie и список посещенных ссылок, общие для всех страниц веб-движка, принадлежащих профилю.
Информация о посещенных ссылках хранится вместе с постоянными файлами cookie и другими постоянными данными в хранилище, определяемом свойством storageName. Постоянные данные хранятся в подкаталоге, определяемом свойством persistentStoragePath, а кеш — в подкаталоге, определяемом свойством cachePath. Свойство httpCacheType описывает тип кеша: в оперативной памяти или на диске. Если задано только свойство storageName, другие значения генерируются автоматически на его основе. Если вы задаёте какие-либо значения вручную, вы должны сделать это до создания каких-либо страниц, принадлежащих профилю.
Профили могут использоваться для изоляции страниц друг от друга. Типичный случай использования — отдельный профиль "без записи" для режима приватного просмотра. Профиль "без записи" принудительно хранит файлы cookie, кеш HTTP и другие обычно постоянные данные только в оперативной памяти. Свойство offTheRecord указывает, является ли профиль профилем "без записи".
К стандартному профилю можно обратиться с помощью defaultProfile(). Это встроенный профиль, к которому принадлежат все веб-страницы, не созданные явно с другим профилем.
Объект WebEngineProfile может быть создан и доступен из C++ через класс QQuickWebEngineProfile, который предоставляет дополнительные возможности в C++. Это позволяет приложениям Qt Quick перехватывать запросы URL (QQuickWebEngineProfile::setRequestInterceptor) или регистрировать пользовательские схемы URL (QQuickWebEngineProfile::installUrlSchemeHandler).
Проверку орфографии HTML-полей формы можно включить в профиле, установив свойство spellCheckEnabled, а текущие языки, используемые для проверки орфографии, можно установить, используя свойство spellCheckLanguages.
Документация по типам членов
enum QQuickWebEngineProfile::HttpCacheType
Этот перечисление описывает тип кэша HTTP:
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineProfile::MemoryHttpCache |
0 |
Использовать кэш в оперативной памяти. Это значение по умолчанию, если off-the-record задано. |
QQuickWebEngineProfile::DiskHttpCache |
1 |
Использовать кэш на диске. Это значение по умолчанию, если off-the-record не задано. Возвращается к MemoryHttpCache, если off-the-record задано. |
QQuickWebEngineProfile::NoCache |
2 |
Отключить кэширование как в оперативной памяти, так и на диске. (Добавлен в Qt 5.7) |
enum 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() |
downloadPath : QString
Путь к расположению, где хранятся загруженные файлы.
Переопределяет путь по умолчанию для местоположения загрузки, устанавливая его в path.
Если значение установлено в пустую строку, восстанавливается путь по умолчанию.
Примечание: По умолчанию путь к загрузкам — QStandardPaths::DownloadLocation.
Это свойство было добавлено в QtWebEngine 1.9.
Функции доступа:
| QString | downloadPath() const |
| void | setDownloadPath(const QString &path) |
Сигнал уведомления:
| void | downloadPathChanged() |
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.
Функции доступа:
| QQuickWebEngineProfile::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
Указывает, находится ли профиль веб-движка в режиме «только для чтения». Профиль в режиме «только для чтения» заставляет cookies, кэш HTTP и другие обычно постоянные данные храниться только в памяти.
Функции доступа:
| bool | isOffTheRecord() const |
| void | setOffTheRecord(bool offTheRecord) |
Сигнал уведомления:
| void | offTheRecordChanged() |
persistentCookiesPolicy : PersistentCookiesPolicy
Это перечисление описывает политику сохранения cookies. Если профиль в режиме «только для чтения», возвращается NoPersistentCookies.
Функции доступа:
| QQuickWebEngineProfile::PersistentCookiesPolicy | persistentCookiesPolicy() const |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
Сигнал уведомления:
| void | persistentCookiesPolicyChanged() |
persistentStoragePath : QString
Путь к расположению, где хранятся постоянные данные браузера и веб-контента. Постоянные данные включают постоянные cookies, локальное хранилище HTML5 и посещенные ссылки.
По умолчанию хранилище находится в каталоге ниже QStandardPaths::writableLocation(QStandardPaths::DataLocation) с именем, сгенерированным с помощью storageName.
Функции доступа:
| QString | persistentStoragePath() const |
| void | setPersistentStoragePath(const QString &path) |
Сигнал уведомления:
| void | persistentStoragePathChanged() |
spellCheckEnabled : bool
Это свойство определяет, включен ли модуль проверки правописания веб-движка.
Это свойство было добавлено в QtWebEngine 1.4.
Функции доступа:
| bool | isSpellCheckEnabled() const |
| void | setSpellCheckEnabled(bool enabled) |
Сигнал уведомления:
| void | spellCheckEnabledChanged() |
spellCheckLanguages : QStringList
Это свойство содержит языки, используемые модулем проверки правописания.
Это свойство было добавлено в QtWebEngine 1.4.
Функции доступа:
| QStringList | spellCheckLanguages() const |
| void | setSpellCheckLanguages(const QStringList &languages) |
Сигнал уведомления:
| void | spellCheckLanguagesChanged() |
storageName : QString
Имя хранилища, используемое для создания отдельных подкаталогов для каждого профиля, использующего диск для хранения постоянных данных и кеша.
Функции доступа:
| QString | storageName() const |
| void | setStorageName(const QString &name) |
Сигналы уведомления:
| void | storageNameChanged() |
См. также persistentStoragePath и cachePath.
useForGlobalCertificateVerification : bool
Это свойство определяет, используется ли этот профиль для загрузки и кэширования во время глобальной проверки сертификатов при использовании протокола состояния онлайн-сертификатов (OCSP), списков отзыва сертификатов (CRL) и доступа к информации об авторитете (AIA), например.
Пока один профиль имеет этот параметр включённым, все остальные профили смогут использовать его для проверки сертификатов. Одновременно только один профиль может иметь этот параметр включённым. Рекомендуется, чтобы профиль имел кэш HTTP-диска, чтобы избежать ненужной повторной загрузки.
По умолчанию ни один профиль не имеет это свойство включённым.
В настоящее время влияет только на установки Linux/NSS, где наличие профиля с этой ролью включает OCSP.
Это свойство было добавлено в Qt 5.13.
Функции доступа:
| bool | isUsedForGlobalCertificateVerification() const |
| void | setUseForGlobalCertificateVerification(bool b) |
Сигналы уведомления:
| void | useForGlobalCertificateVerificationChanged() |
userScripts : const QQmlListProperty<QQuickWebEngineScript>
Это свойство хранит коллекцию скриптов, которые встраиваются во все страницы, использующие этот профиль.
Это свойство было добавлено в Qt 5.9.
Функции доступа:
| QQmlListProperty<QQuickWebEngineScript> | userScripts() |
См. также QQuickWebEngineScript и QQmlListReference.
Документация по членам функций
QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = Q_NULLPTR)
Создаёт новый профиль с родительским объектом parent.
[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadItem *download)
Этот сигнал излучается всякий раз, когда загрузка останавливается, потому что она завершилась успешно, была отменена или прервана (например, из-за потери соединения). Аргумент download содержит состояние завершенного элемента загрузки.
[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadItem *download)
Этот сигнал излучается всякий раз, когда запущена загрузка. Аргумент download содержит состояние загрузки. Загрузку необходимо явно принять с помощью QQuickWebEngineDownloadItem::accept() , иначе она будет отменена по умолчанию. Элемент загрузки является потомком профиля. Если он не принят, он будет удалён сразу после излучения сигнала. Этот сигнал не может быть использован с очередью соединений.
[signal] void QQuickWebEngineProfile::presentNotification(QWebEngineNotification *notification)
Этот сигнал излучается всякий раз, когда появляется новое пользовательское уведомление. Аргумент notification содержит экземпляр QWebEngineNotification для запроса данных и взаимодействия.
См. также WebEngineProfile::presentNotification.
void QQuickWebEngineProfile::clearHttpCache()
Удаляет записи кеша профиля.
Примечание: Эту функцию можно вызвать через систему метаобъектов и из QML. См. Q_INVOKABLE.
Эта функция была добавлена в Qt 5.7.
См. также WebEngineProfile::clearHttpCache.
QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore()
Возвращает хранилище клиентских сертификатов профиля.
Эта функция была добавлена в Qt 5.13.
QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const
Возвращает хранилище cookie для этого профиля.
[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()
Возвращает стандартный профиль.
Стандартный профиль использует имя хранилища "Default".
См. также storageName().
void QQuickWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)
Регистрирует обработчик handler для пользовательской схемы URL scheme в профиле.
Необходимо предварительно зарегистрировать схему с помощью QWebEngineUrlScheme::registerScheme при запуске приложения.
void QQuickWebEngineProfile::removeAllUrlSchemeHandlers()
Удаляет все пользовательские обработчики схем URL, установленные в профиле.
void QQuickWebEngineProfile::removeUrlScheme(const QByteArray &scheme)
Удаляет пользовательскую схему URL scheme из профиля.
См. также removeUrlSchemeHandler().
void QQuickWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)
Удаляет пользовательский обработчик схемы URL handler из профиля.
См. также removeUrlScheme().
void QQuickWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
Регистрирует обработчик запросов interceptor для перехвата запросов URL.
Профиль не принимает владения указателем.
См. также QWebEngineUrlRequestInfo и QWebEngineUrlRequestInterceptor.
QStringList QQuickWebEngineProfile::spellCheckLanguages() const
Возвращает список языков, используемых орфографической проверкой.
Примечание: Функция-получатель для свойства spellCheckLanguages.
Эта функция была добавлена в Qt 5.8.
См. также setSpellCheckLanguages().
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/qt-5.15/qquickwebengineprofile.html
