Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль движка веб-страниц, используемый несколькими страницами. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| CMake: | find_package(Qt6 COMPONENTS WebEngineQuick REQUIRED) target_link_libraries(mytarget PRIVATE Qt6::WebEngineQuick) |
| qmake: | QT += webenginequick |
| С версии: | Qt 5.6 |
| Создается из: | WebEngineProfile |
| Наследует: | QObject |
Типы
| перечисление | HttpCacheType { КэшHttpВПамяти, КэшHttpНаДиске, БезКэша } |
| перечисление | PersistentCookiesPolicy { БезПостоянныхКуки, РазрешитьПостоянныеКуки, ВынужденныеПостоянныеКуки } |
Свойства
|
|
Открытые функции
| QQuickWebEngineProfile(QObject *parent = 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 |
| QQuickWebEngineProfile::PersistentCookiesPolicy | persistentCookiesPolicy() const |
| QString | persistentStoragePath() const |
| void | removeAllUrlSchemeHandlers() |
| void | removeUrlScheme(const QByteArray &scheme) |
| void | removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler) |
| void | setCachePath(const QString &path) |
| void | setDownloadPath(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 | setSpellCheckEnabled(bool enabled) |
| void | setSpellCheckLanguages(const QStringList &languages) |
| void | setStorageName(const QString &name) |
| void | setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor) |
| QStringList | spellCheckLanguages() const |
| QString | storageName() const |
| const QWebEngineUrlSchemeHandler * | urlSchemeHandler(const QByteArray &scheme) const |
| QQuickWebEngineScriptCollection * | userScripts() const |
Сигналы
| void | cachePathChanged() |
| void | downloadFinished(QQuickWebEngineDownloadRequest *download) |
| void | downloadPathChanged() |
| void | downloadRequested(QQuickWebEngineDownloadRequest *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() |
Статические публичные члены
| 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.
Документация по типу членов
Перечисление 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) |
Перечисление QQuickWebEngineProfile::PersistentCookiesPolicy
Это перечисление описывает политику сохранения файлов cookie:
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineProfile::NoPersistentCookies |
0 |
Файлы cookie сеанса и постоянные файлы cookie хранятся в оперативной памяти. Это единственное возможное значение, если off-the-record установлено или путь к постоянным данным недоступен. |
QQuickWebEngineProfile::AllowPersistentCookies |
1 |
Файлы cookie, помеченные как постоянные, сохраняются и восстанавливаются с диска, а файлы cookie сеанса сохраняются на диске только для восстановления после сбоя. Это значение по умолчанию. |
QQuickWebEngineProfile::ForcePersistentCookies |
2 |
И файлы cookie сеанса, и постоянные файлы cookie сохраняются и восстанавливаются с диска. |
Документация свойств
cachePath : QString
Путь к расположению, где хранятся кэши профиля, в частности кэш HTTP.
По умолчанию, кэши хранятся ниже QStandardPaths::writableLocation(QStandardPaths::CacheLocation) в каталоге, имя которого задаётся с помощью storageName.
Функции доступа:
| QString | cachePath() const |
| void | setCachePath(const QString &path) |
Сигнал оповещения:
| void | cachePathChanged() |
[since QtWebEngine 1.9] 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
Указывает, является ли профиль веб-движка "без сохранения данных". Профиль "без сохранения данных" требует, чтобы куки, кэш HTTP и другие обычно постоянные данные хранились только в памяти.
Функции доступа:
| bool | isOffTheRecord() const |
| void | setOffTheRecord(bool offTheRecord) |
Сигнал оповещения:
| void | offTheRecordChanged() |
persistentCookiesPolicy : PersistentCookiesPolicy
Это перечисление описывает политику постоянства куки. Если профиль в режиме "без сохранения данных", возвращается NoPersistentCookies.
Функции доступа:
| QQuickWebEngineProfile::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() |
[since QtWebEngine 1.4] spellCheckEnabled : bool
Это свойство содержит значение, указывающее, включён ли модуль проверки орфографии веб-движка.
Это свойство было добавлено в QtWebEngine 1.4.
Функции доступа:
| bool | isSpellCheckEnabled() const |
| void | setSpellCheckEnabled(bool enabled) |
Сигнал оповещения:
| void | spellCheckEnabledChanged() |
[since QtWebEngine 1.4] 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.
Документация по членам-функциям
QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = nullptr)
Создаёт новый профиль с родителем parent.
[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadRequest *download)
Этот сигнал испускается всякий раз, когда загрузка завершается успешно, отменяется или прерывается (например, из-за потери подключения). Аргумент download содержит состояние завершённого экземпляра загрузки.
[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadRequest *download)
Этот сигнал испускается всякий раз, когда инициируется загрузка. Аргумент download содержит состояние загрузки. Загрузку необходимо явно принять с помощью QWebEngineDownloadRequest::accept(), иначе она будет отменена по умолчанию. Элемент загрузки является потомком профиля. Если она не принята, она будет удалена сразу после выдачи сигнала. Этот сигнал нельзя использовать с очередизованной связью.
[signal] void QQuickWebEngineProfile::presentNotification(QWebEngineNotification *notification)
Этот сигнал испускается всякий раз, когда появляется новое пользовательское уведомление. Аргумент notification содержит экземпляр QWebEngineNotification для запроса данных и взаимодействия.
См. также WebEngineProfile::presentNotification.
[invokable, since 5.7] void QQuickWebEngineProfile::clearHttpCache()
Удаляет записи кэша профиля.
Примечание: Эта функция может быть вызвана через систему метаобъектов и из QML. См. Q_INVOKABLE.
Эта функция была добавлена в Qt 5.7.
См. также WebEngineProfile::clearHttpCache.
[since 5.13] 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.
[since 5.8] 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-6.2/qquickwebengineprofile.html
