Класс QWebEngineProfile

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

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

Открытые типы

Открытые функции

• 31 открытая функция унаследованная от QObject

Сигналы

• 2 сигнала, унаследованных от QObject

Статические открытые члены

• 9 статических открытых членов, унаследованных от QObject

Дополнительные унаследованные члены

• 1 свойство, унаследованное от QObject
• 1 открытый слот, унаследованный от QObject
• 9 защищённых функций, унаследованных от QObject

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

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

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

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

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

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

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

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

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

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

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

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

перечисление QWebEngineProfile::HttpCacheType

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

перечисление QWebEngineProfile::PersistentCookiesPolicy

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

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

QWebEngineProfile::QWebEngineProfile(QObject *parent = Q_NULLPTR)

Создаёт новый профиль «без учета истории» с родительским объектом parent.

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

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

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

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

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

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

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

QString QWebEngineProfile::cachePath() const

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

По умолчанию это путь ниже StandardPaths::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().

QWebEngineCookieStore *QWebEngineProfile::cookieStore()

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

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

QWebEngineProfile *QWebEngineProfile::defaultProfile()

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

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

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

void QWebEngineProfile::downloadRequested(QWebEngineDownloadItem *download)

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

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

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

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 и новее, по умолчанию пользовательский агент всегда будет сообщать «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, если это профиль «без следа», не оставляющий записей на компьютере.

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

bool QWebEngineProfile::isSpellCheckEnabled() const

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

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

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

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::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)

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

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

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

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

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

void QWebEngineProfile::setPersistentStoragePath(const QString &path)

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

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

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

void QWebEngineProfile::setRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

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

Профиль не берет на себя ответственность за указатель.

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

См. также QWebEngineUrlRequestInfo.

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, см. в примере Проверка правописания.

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

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

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 считается посещенной ссылкой в этом профиле.