Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| С момента: | Qt 5.6 |
| Инициализируется: | WebEngineProfile |
| Наследует: | QObject |
Открытые типы
| перечисление | HttpCacheType { MemoryHttpCache, DiskHttpCache, NoCache } |
| перечисление | PersistentCookiesPolicy { NoPersistentCookies, AllowPersistentCookies, ForcePersistentCookies } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Открытые функции
| QQuickWebEngineProfile(QObject *parent = Q_NULLPTR) | |
| QString | путь к кешу() const |
| void | очиститьHTTP-кеш() |
| QWebEngineCookieStore * | хранилище файлов cookie() const |
| QString | язык HTTP-принятия() const |
| int | максимальный размер кеша HTTP() const |
| QQuickWebEngineProfile::HttpCacheType | тип кеша HTTP() const |
| QString | HTTP-агент пользователя() const |
| void | установить обработчик схемы URL(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler) |
| bool | в автономном режиме() const |
| bool | проверка правописания включена() const |
| QQuickWebEngineProfile::PersistentCookiesPolicy | политика постоянных файлов cookie() const |
| QString | путь к хранилищу постоянных данных() const |
| void | удалить все обработчики схемы URL() |
| void | удалить схему URL(const QByteArray &scheme) |
| void | удалить обработчик схемы URL(QWebEngineUrlSchemeHandler *handler) |
| void | установить путь к кешу(const QString &path) |
| void | установить язык HTTP-принятия(const QString &httpAcceptLanguage) |
| void | установить максимальный размер кеша HTTP(int maxSize) |
| void | установить тип кеша HTTP(QQuickWebEngineProfile::HttpCacheType) |
| void | установить HTTP-агента пользователя(const QString &userAgent) |
| void | установить автономный режим(bool offTheRecord) |
| void | установить политику постоянных файлов cookie(QQuickWebEngineProfile::PersistentCookiesPolicy) |
| void | установить путь к хранилищу постоянных данных(const QString &path) |
| void | установить обработчик запросов(QWebEngineUrlRequestInterceptor *interceptor) |
| void | включить проверку правописания(bool enabled) |
| void | установить языки проверки правописания(const QStringList &languages) |
| void | установить имя хранилища(const QString &name) |
| QStringList | языки проверки правописания() const |
| QString | имя хранилища() const |
| const QWebEngineUrlSchemeHandler * | обработчик схемы URL(const QByteArray &scheme) const |
| QQmlListProperty<QQuickWebEngineScript> | пользовательские скрипты() |
- 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 | spellCheckEnabledChanged() |
| void | spellCheckLanguagesChanged() |
| void | storageNameChanged() |
- 2 сигнала, унаследованные от QObject
Статические публичные члены
| QQuickWebEngineProfile * | defaultProfile() |
| const QMetaObject | staticMetaObject |
- 9 статических публичных членов, унаследованных от QObject
Дополнительные унаследованные члены
Подробное описание
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами.
Профиль веб-движка содержит настройки, скрипты, политику постоянных файлов 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 сеанса и постоянные файлы 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() |
httpAcceptLanguage : QString
Значение поля Accept-Language HTTP-заголовка запроса.
Функции доступа:
| 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() |
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.
userScripts : const QQmlListProperty<QQuickWebEngineScript>
Это свойство содержит коллекцию скриптов, которые встроены во все страницы, использующие этот профиль.
Это свойство было добавлено в Qt 5.9.
Функции доступа:
| QQmlListProperty<QQuickWebEngineScript> | userScripts() |
См. также QQuickWebEngineScript и QQmlListReference.
Документация по членам-функциям
QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = Q_NULLPTR)
Создает новый профиль с родителем parent.
void QQuickWebEngineProfile::clearHttpCache()
Удаляет записи кэша профиля.
Эта функция была добавлена в Qt 5.7.
Примечание: Эту функцию можно вызывать через систему метаобъектов и из QML. См. Q_INVOKABLE.
См. также WebEngineProfile::clearHttpCache.
QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const
Возвращает хранилище cookie для этого профиля.
[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 в профиле.
Необходимо предварительно зарегистрировать схему с помощью 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::setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)
Регистрирует одиночный обработчик запросов interceptor для перехвата запросов URL.
Профиль не берет на себя ответственность за указатель.
См. также QWebEngineUrlRequestInterceptor.
QStringList QQuickWebEngineProfile::spellCheckLanguages() const
Возвращает список языков, используемых орфографической проверкой.
Эта функция была добавлена в Qt 5.8.
Примечание: Функция-получатель для свойства spellCheckLanguages.
См. также 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.12/qquickwebengineprofile.html
