Класс QWebEngineProfile

Класс QWebEngineProfile предоставляет профиль веб-движка, используемый несколькими страницами. Подробнее...

Этот класс был введён в Qt 5.5.

• Список всех членов, включая унаследованные
• Устаревшие члены

Типы public

Public Functions

Сигналы

Статические публичные члены

Подробное описание

Профиль движка веб-страниц содержит настройки, скрипты, политику постоянных куки и список посещённых ссылок, общих для всех страниц движка, принадлежащих профилю.

Все страницы, принадлежащие профилю, используют общий экземпляр QWebEngineSettings, к которому можно получить доступ с помощью метода настройки(). Аналогично, метод сценарии() предоставляет доступ к общему экземпляру QWebEngineScriptCollection.

Информация о посещённых ссылках хранится вместе с постоянными куки и другими постоянными данными в хранилище, возвращаемом функцией storageName(). Постоянные данные хранятся в подкаталоге, заданном вызовом setPersistentStoragePath(), а кеш расположен в подкаталоге, заданном вызовом setCachePath(). Тип кеша может быть установлен на в оперативной памяти или на диске с помощью вызова setHttpCacheType(). Если задано только имя хранилища, подкаталоги создаются и автоматически именуются. Если вы задаёте какие-либо значения вручную, сделайте это до создания любых страниц, принадлежащих профилю.

Кеш можно очистить от ссылок, вызвав clearVisitedLinks() или clearAllVisitedLinks(). PersistentCookiesPolicy описывает, сохраняются ли сеансовые и постоянные куки в памяти или на диске и восстанавливаются из них.

Профили могут использоваться для изоляции страниц друг от друга. Типичный пример — выделенный профиль для работы "вне записи" для режима приватного просмотра. Использование QWebEngineProfile() без определения имени хранилища создаёт новый профиль "вне записи", который не оставляет следов на локальном компьютере и не содержит постоянных данных или кеша. Метод isOffTheRecord() можно использовать для проверки, является ли профиль профилем "вне записи".

К стандартному профилю можно получить доступ с помощью defaultProfile(). Это встроенный профиль, к которому принадлежат все веб-страницы, не созданные специально с другим профилем.

Реализация интерфейса QWebEngineUrlRequestInterceptor и регистрация перехватчика в профиле с помощью setRequestInterceptor() позволяют перехватывать, блокировать и изменять запросы URL (QWebEngineUrlRequestInfo) перед их поступлением в сетевой стек Chromium.

Обработчик схемы URL QWebEngineUrlSchemeHandler может быть зарегистрирован для профиля с помощью installUrlSchemeHandler(), чтобы добавить поддержку пользовательских схем URL. Запросы для схемы затем передаются в QWebEngineUrlSchemeHandler::requestStarted() в виде объектов QWebEngineUrlRequestJob.

Проверку орфографии для полей HTML-форм можно включить в отдельном профиле, используя метод setSpellCheckEnabled(), а текущие языки, используемые для проверки орфографии, можно установить, используя метод setSpellCheckLanguages().

Документация по типам членов

enum QWebEngineProfile::HttpCacheType

Этот перечисление описывает тип кеша HTTP:

enum QWebEngineProfile::PersistentCookiesPolicy

Это перечисление описывает политику сохранения куки:

Документация по функциям-членам

QWebEngineProfile::QWebEngineProfile(const QString &storageName, QObject *parent = Q_NULLPTR)

Создаёт новый профиль с именем хранилища storageName и родителем parent.

Имя хранилища должно быть уникальным.

QWebEngineProfile на диске следует уничтожить перед завершением приложения, иначе кеш и постоянные данные могут не быть полностью сохранены на диске.

См. также storageName().

QWebEngineProfile::QWebEngineProfile(QObject *parent = Q_NULLPTR)

Создаёт новый профиль "вне записи" с родителем parent.

Профиль "вне записи" не оставляет следов на локальном компьютере и не содержит постоянных данных или кеша. Таким образом, кеш HTTP может быть только в оперативной памяти, а куки — только непостоянными. Попытки изменить эти настройки не дадут никакого результата.

См. также isOffTheRecord().

[signal] void QWebEngineProfile::downloadRequested(QWebEngineDownloadItem *download)

Этот сигнал излучается всякий раз, когда инициируется загрузка. Аргумент download содержит состояние загрузки. Загрузка должна быть явно принята с помощью QWebEngineDownloadItem::accept(), иначе она будет отменена по умолчанию. Элемент загрузки является дочерним элементом профиля. Если он не принят, он будет удалён сразу после излучения сигнала. Этот сигнал не может быть использован с очередью подключений.

Эта функция была введена в Qt 5.5.

См. также QWebEngineDownloadItem и QWebEnginePage::download().

QString QWebEngineProfile::cachePath() const

Возвращает путь, используемый для кешей.

По умолчанию, это расположено ниже QStandardPaths::CacheLocation в подкаталоге QtWebengine/StorageName.

Примечание: Используйте QStandardPaths::writableLocation(QStandardPaths::CacheLocation) для получения пути QStandardPaths::CacheLocation.

См. также setCachePath(), storageName(), и QStandardPaths::writableLocation().

void QWebEngineProfile::clearAllVisitedLinks()

Очищает все ссылки из базы данных посещённых ссылок.

См. также clearVisitedLinks().

void QWebEngineProfile::clearHttpCache()

Удаляет записи кеша профиля.

Эта функция была введена в Qt 5.7.

void QWebEngineProfile::clearVisitedLinks(const QList<QUrl> &urls)

Очищает ссылки в urls из базы данных посещённых ссылок.

См. также clearAllVisitedLinks().

QWebEngineClientCertificateStore *QWebEngineProfile::clientCertificateStore()

Возвращает хранилище сертификатов клиента профиля.

Эта функция была введена в Qt 5.13.

QWebEngineCookieStore *QWebEngineProfile::cookieStore()

Возвращает хранилище куки для данного профиля.

Эта функция была введена в Qt 5.6.

[static] QWebEngineProfile *QWebEngineProfile::defaultProfile()

Возвращает стандартный профиль.

Стандартный профиль использует имя хранилища "Default".

См. также storageName().

QString QWebEngineProfile::downloadPath() const

Путь к расположению, где хранятся загруженные файлы.

Примечание: По умолчанию, путь к загрузкам — QStandardPaths::DownloadLocation.

Эта функция была введена в Qt 5.13.

См. также setDownloadPath() и QStandardPaths::writableLocation().

QString QWebEngineProfile::httpAcceptLanguage() const

Возвращает значение поля Accept-Language HTTP-заголовка запроса.

Эта функция была введена в Qt 5.6.

См. также setHttpAcceptLanguage().

int QWebEngineProfile::httpCacheMaximumSize() const

Возвращает максимальный размер кеша HTTP в байтах.

Возвращает 0 если размер автоматически управляется QtWebEngine.

См. также setHttpCacheMaximumSize() и httpCacheType().

QWebEngineProfile::HttpCacheType QWebEngineProfile::httpCacheType() const

Возвращает тип используемого кэша HTTP.

Если профиль в режиме «только для чтения», возвращается MemoryHttpCache.

См. также setHttpCacheType() и cachePath().

QString QWebEngineProfile::httpUserAgent() const

Возвращает строку user-agent, отправляемую с HTTP для идентификации браузера.

Примечание: В Windows 8.1 и новее значение по умолчанию для user-agent будет всегда «Windows NT 6.2» (Windows 8), если приложение не содержит манифест, в котором указаны поддерживаемые версии Windows более поздние.

См. также setHttpUserAgent().

void QWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)

Регистрирует обработчик handler для пользовательской схемы URL scheme в профиле.

Необходимо сначала зарегистрировать схему с помощью QWebEngineUrlScheme::registerScheme при запуске приложения.

Эта функция была добавлена в Qt 5.6.

bool QWebEngineProfile::isOffTheRecord() const

Возвращает true, если это профиль «только для чтения», не оставляющий записи на компьютере.

Это заставит куки и кэш HTTP храниться в памяти, а также заставит все остальные обычно сохраняемые данные храниться в памяти.

bool QWebEngineProfile::isSpellCheckEnabled() const

Возвращает true, если проверка орфографии включена; в противном случае возвращает false.

Эта функция была добавлена в Qt 5.8.

См. также setSpellCheckEnabled().

bool QWebEngineProfile::isUsedForGlobalCertificateVerification() const

Возвращает true, если этот профиль используется для глобальной проверки сертификатов.

Эта функция была добавлена в Qt 5.13.

QWebEngineProfile::PersistentCookiesPolicy QWebEngineProfile::persistentCookiesPolicy() const

Возвращает текущую политику для постоянных файлов cookie.

Если профиль в режиме «только для чтения», возвращается NoPersistentCookies.

См. также setPersistentCookiesPolicy().

QString QWebEngineProfile::persistentStoragePath() const

Возвращает путь, используемый для хранения постоянных данных браузера и веб-контента.

Постоянные данные включают постоянные файлы cookie, локальное хранилище HTML5 и посещенные ссылки.

По умолчанию, это путь ниже QStandardPaths::DataLocation в подкаталоге, специфичном для QtWebengine/StorageName.

Примечание: Используйте QStandardPaths::writableLocation(QStandardPaths::DataLocation) для получения пути QStandardPaths::DataLocation.

См. также setPersistentStoragePath(), storageName() и QStandardPaths::writableLocation().

void QWebEngineProfile::removeAllUrlSchemeHandlers()

Удаляет все установленные пользовательские обработчики схем URL в профиле.

Эта функция была добавлена в Qt 5.6.

void QWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

Удаляет пользовательскую схему URL scheme из профиля.

Эта функция была добавлена в Qt 5.6.

См. также removeUrlSchemeHandler().

void QWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

Удаляет пользовательский обработчик схемы URL handler из профиля.

Эта функция была добавлена в Qt 5.6.

См. также removeUrlScheme().

QWebEngineScriptCollection *QWebEngineProfile::scripts() const

Возвращает коллекцию скриптов, которые встроены во все страницы, использующие этот профиль.

См. также QWebEngineScriptCollection, QWebEngineScript и QWebEnginePage::scripts().

void QWebEngineProfile::setCachePath(const QString &path)

Переопределяет путь по умолчанию для кэша на диске, устанавливая его в path.

Если задано пустая строка, восстанавливается путь по умолчанию.

См. также cachePath().

void QWebEngineProfile::setDownloadPath(const QString &path)

Переопределяет путь по умолчанию для сохранения загружаемых файлов, устанавливая его в path.

Если задано пустая строка, восстанавливается путь по умолчанию.

Эта функция была добавлена в Qt 5.13.

См. также downloadPath().

void QWebEngineProfile::setHttpAcceptLanguage(const QString &httpAcceptLanguage)

Устанавливает значение поля Accept-Language заголовка HTTP запроса в httpAcceptLanguage.

Эта функция была добавлена в Qt 5.6.

См. также httpAcceptLanguage().

void QWebEngineProfile::setHttpCacheMaximumSize(int maxSize)

Устанавливает максимальный размер кэша HTTP в maxSize байт.

Установка значения 0 означает, что размер будет автоматически управляться QtWebEngine.

См. также httpCacheMaximumSize() и setHttpCacheType().

void QWebEngineProfile::setHttpCacheType(QWebEngineProfile::HttpCacheType httpCacheType)

Устанавливает тип кэша HTTP в httpCacheType.

См. также httpCacheType() и setCachePath().

void QWebEngineProfile::setHttpUserAgent(const QString &userAgent)

Переопределяет строку user-agent по умолчанию, устанавливая её в userAgent.

См. также httpUserAgent().

void QWebEngineProfile::setNotificationPresenter(std::function<void (std::unique_ptr<QWebEngineNotification>)> notificationPresenter)

Устанавливает функцию notificationPresenter как ответственного за представление отправленных уведомлений.

Эта функция была добавлена в Qt 5.13.

См. также QWebEngineNotification.

void QWebEngineProfile::setPersistentCookiesPolicy(QWebEngineProfile::PersistentCookiesPolicy newPersistentCookiesPolicy)

Устанавливает политику для постоянных файлов cookie в newPersistentCookiesPolicy.

См. также persistentCookiesPolicy().

void QWebEngineProfile::setPersistentStoragePath(const QString &path)

Переопределяет путь по умолчанию для хранения постоянных данных веб-движка.

Если path установлено в пустую строку, восстанавливается путь по умолчанию.

См. также persistentStoragePath().

void QWebEngineProfile::setSpellCheckEnabled(bool enable)

Включает проверку орфографии, если enable имеет значение true, в противном случае отключает её.

Эта функция была добавлена в Qt 5.8.

См. также isSpellCheckEnabled().

void QWebEngineProfile::setSpellCheckLanguages(const QStringList &languages)

Устанавливает текущий список languages для проверки орфографии. Каждое язык должно соответствовать имени .bdic словаря. Например, язык en-US загрузит файл словаря en-US.bdic.

См. документацию функции проверки орфографии для получения информации о поиске файлов словарей.

Дополнительную информацию о том, как скомпилировать словари .bdic, см. в примере Spellchecker Example.

Данная функция была представлена в Qt 5.8.

См. также spellCheckLanguages().

void QWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

Регистрирует одиночный обработчик запросов interceptor для перехвата запросов на URL.

Профиль не принимает владение указателем.

Данная функция была представлена в Qt 5.13.

См. также QWebEngineUrlRequestInfo и QWebEngineUrlRequestInterceptor.

void QWebEngineProfile::setUseForGlobalCertificateVerification(bool enabled = true)

Устанавливает, должен ли этот профиль использоваться для скачивания и кэширования при необходимости во время проверки сертификатов, например, для OCSP, CRL и AIA.

Только один QWebEngineProfile может это делать одновременно, и рекомендуется, чтобы профиль, выполняющий эту роль, имел кэш HTTP на диске, чтобы избежать ненужного повторного скачивания. Если вы установите этот параметр для второго профиля, он будет отключён для профиля, для которого он был установлен ранее.

В настоящее время влияет только на установки Linux/NSS, где это включает OCSP.

Пока у одного профиля параметр enabled установлен в true, все остальные профили смогут использовать его для проверки своих сертификатов.

Данная функция была представлена в Qt 5.13.

См. также isUsedForGlobalCertificateVerification() и httpCacheType().

QWebEngineSettings *QWebEngineProfile::settings() const

Возвращает параметры по умолчанию для всех страниц в этом профиле.

QStringList QWebEngineProfile::spellCheckLanguages() const

Возвращает список языков, используемых орфографической проверкой.

Данная функция была представлена в Qt 5.8.

См. также setSpellCheckLanguages().

QString QWebEngineProfile::storageName() const

Возвращает имя хранилища для профиля.

Имя хранилища используется для предоставления каждому профилю, использующему диск, отдельных подкаталогов для постоянных данных и кэша.

const QWebEngineUrlSchemeHandler *QWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const

Возвращает зарегистрированного обработчика схемы URL для схемы URL scheme.

Данная функция была представлена в Qt 5.6.

bool QWebEngineProfile::visitedLinksContainsUrl(const QUrl &url) const

Возвращает true если url считается посещённой ссылкой этим профилем.