Класс QQuickWebEngineProfile
Класс QQuickWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами. Подробнее...
| Заголовок: | #include <QQuickWebEngineProfile> |
| С момента: | Qt 5.6 |
| Инициализируется: | WebEngineProfile |
| Наследует: | QObject |
Публичные типы
| Перечисление | HttpCacheType { КэшВпамяти, КэшНаДиске, БезКэша } |
| Перечисление | PersistentCookiesPolicy { БезПостоянныхКуки, РазрешитьПостоянныеКуки, ПринудительноПостоянныеКуки } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Публичные функции
| QQuickWebEngineProfile(QObject *parent = Q_NULLPTR) | |
| QString | путьКэш() const |
| void | очиститьКэшHttp() |
| QWebEngineCookieStore * | cookieStore() const |
| QString | httpAcceptLanguage() const |
| int | максимальныйРазмерКэшаHttp() const |
| QQuickWebEngineProfile::HttpCacheType | типКэшаHttp() const |
| QString | httpUserAgent() const |
| void | установитьОбработчикСхемыUrl(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler) |
| bool | являетсяБезРегистрацией() const |
| bool | являетсяПроверкаПравописанияВключена() const |
| QQuickWebEngineProfile::PersistentCookiesPolicy | политикаПостоянныхКуки() const |
| QString | путьПостоянногоХранилища() const |
| void | удалитьВсеОбработчикиСхемыUrl() |
| void | удалитьСхемуUrl(const QByteArray &scheme) |
| void | удалитьОбработчикСхемыUrl(QWebEngineUrlSchemeHandler *handler) |
| void | установитьПутьКэш(const QString &path) |
| void | установитьHttpAcceptLanguage(const QString &httpAcceptLanguage) |
| void | установитьМаксимальныйРазмерКэшаHttp(int maxSize) |
| void | установитьТипКэшаHttp(QQuickWebEngineProfile::HttpCacheType) |
| void | установитьHttpUserAgent(const QString &userAgent) |
| void | установитьБезРегистрации(bool offTheRecord) |
| void | установитьПолитикуПостоянныхКуки(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> | скриптыПользователя() |
- 34 public functions inherited from 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() |
- 10 статических публичных членов, унаследованных от QObject
Дополнительные унаследованные члены
- 1 публичный слот, унаследованный от QObject
- 1 публичная переменная, унаследованная от QObject
- 9 защищённых функций, унаследованных от QObject
- 2 защищённых переменных, унаследованных от QObject
Подробное описание
Класс QQuickWebEngineProfile предоставляет профиль движка веб-страниц, используемый несколькими страницами.
Профиль движка веб-страниц содержит свойства и функциональность, общие для группы страниц веб-движка.
Информация о посещённых ссылках хранится вместе с постоянными cookie-файлами и другими постоянными данными в хранилище, описанном свойством persistentStoragePath.
Профили могут использоваться для изоляции страниц друг от друга. Типичный случай использования — это отдельный профиль «без записи» для режима «частного просмотра». Профиль «без записи» принудительно сохраняет 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() |
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() |
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
Возвращает хранилище куки для этого профиля.
[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/archives/qt-5.11/qquickwebengineprofile.html
