Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| С момента: | Qt 5.6 |
| Инициализируется: | WebEngineProfile |
| Наследует от: | QObject |
Типы
| перечисление | HttpCacheType { КэшHttpВПамяти, КэшHttpНаДиске, БезКэша } |
| перечисление | PersistentCookiesPolicy { НетПостоянныхКуки, РазрешитьПостоянныеКуки, ПринудительноПостоянныеКуки } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Открытые функции
| QQuickWebEngineProfile(QObject *parent = Q_NULLPTR) | |
| QString | cachePath() const |
| void | clearHttpCache() |
| 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 |
| bool | isSpellCheckEnabled() 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 | setSpellCheckEnabled(bool enabled) |
| void | setSpellCheckLanguages(const QStringList &languages) |
| void | setStorageName(const QString &name) |
| QStringList | spellCheckLanguages() const |
| QString | storageName() const |
| const QWebEngineUrlSchemeHandler * | urlSchemeHandler(const QByteArray &scheme) const |
| QQmlListProperty<QQuickWebEngineScript> | userScripts() |
- 32 открытых функции унаследованы от 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() |
- 11 статических публичных членов унаследованы от QObject
Дополнительные унаследованные члены
Подробное описание
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами.
Профиль веб-движка содержит свойства и функциональность, общие для группы страниц веб-движка.
Информация о посещенных ссылках хранится вместе с постоянными cookie и другими постоянными данными в хранилище, описанном свойством persistentStoragePath.
Профили могут использоваться для изоляции страниц друг от друга. Типичный случай использования — выделенный профиль «в режиме инкогнито» для режима «приватного просмотра». Профиль «в режиме инкогнито» заставляет 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 |
Используйте кэш на диске. Это значение по умолчанию. |
QQuickWebEngineProfile::NoCache |
2 |
Отключите кэширование как в оперативной памяти, так и на диске. (Добавлено в Qt 5.7) |
перечисление 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
Указывает, является ли профиль веб-движка режимом «только для чтения». Профиль «только для чтения» заставляет файлы cookie, кэш HTTP и другие обычно сохраняемые данные храниться только в памяти.
Функции доступа:
| bool | isOffTheRecord() const |
| void | setOffTheRecord(bool offTheRecord) |
Сигнал уведомления:
| void | offTheRecordChanged() |
persistentCookiesPolicy : PersistentCookiesPolicy
Это перечисление описывает политику сохранения файлов cookie. Если профиль находится в режиме «только для чтения», возвращается NoPersistentCookies.
Функции доступа:
| PersistentCookiesPolicy | persistentCookiesPolicy() const |
| void | setPersistentCookiesPolicy(QQuickWebEngineProfile::PersistentCookiesPolicy) |
Сигнал уведомления:
| void | persistentCookiesPolicyChanged() |
persistentStoragePath : QString
Путь к расположению, где хранятся постоянные данные браузера и веб-контента. Постоянные данные включают постоянные файлы cookie, локальное хранилище 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.
См. также WebEngineProfile::clearHttpCache.
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.
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.9/qquickwebengineprofile.html
