Класс QWebEnginePage

Класс QWebEnginePage предоставляет объект для просмотра и редактирования веб-документов. Подробнее...

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

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

Свойства

• 1 свойство унаследовано от QObject

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

Переопределенные открытые функции

• 31 общедоступные функции унаследованы от QObject

Сигналы

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

Защищённые функции

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

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

• 1 общедоступный слот унаследован от QObject
• 11 статические общедоступные члены унаследованы от QObject

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

Класс QWebEnginePage предоставляет объект для просмотра и редактирования веб-документов.

Страница веб-движка содержит содержимое HTML-документа, историю посещенных ссылок и действия.

API QWebEnginePage очень похож на QWebEngineView, поскольку вам по-прежнему предоставляются общие функции, такие как action() (известная как pageAction() в QWebEngineView), triggerAction() и findText().

Страница может быть загружена с помощью load() или setUrl(). В качестве альтернативы, если у вас есть доступное содержимое HTML, вы можете использовать setHtml(). Метод GET всегда используется для загрузки URL-адресов.

Класс QWebEnginePage также предлагает методы для извлечения как текущего URL-адреса, загруженного на странице (см. url()), так и исходного URL-адреса, который должен быть загружен (см. requestedUrl()). Эти методы позволяют получить URL-адрес до и после разрешения DNS или перенаправления во время процесса загрузки. requestedUrl() также соответствует URL-адресу, добавленному в историю страницы (QWebEngineHistory), если загрузка выполнена успешно.

Заголовок HTML-страницы можно получить с помощью свойства title(). Кроме того, страница может также указать значок, который можно получить с помощью свойства iconUrl(). Если заголовок или значок изменяются, будут отправлены соответствующие сигналы titleChanged() и iconUrlChanged(). Свойство zoomFactor() позволяет изменять масштаб содержимого веб-страницы с помощью коэффициента масштабирования.

Сигнал loadStarted() отправляется, когда страница начинает загружаться, а сигнал loadProgress() отправляется всякий раз, когда элемент веб-страницы завершает загрузку, например, встроенное изображение или сценарий. Сигнал loadFinished() отправляется, когда содержимое страницы загружено полностью, независимо от выполнения сценария или отображения страницы. Его аргумент, либо true или false, указывает, удалось ли операция загрузки.

HTML-документ загружается в главную область на веб-странице. Если он ссылается на вложенные фреймы (как определено элементами <frame> или <iframe>), они считаются частью содержимого. К вложенным фреймам можно получить доступ только через JavaScript.

Веб-сайты определяют безопасное происхождение для безопасного доступа друг к другу к ресурсам для клиентских сценариев или баз данных. Происхождение состоит из имени хоста, схемы и номера порта. Например, сайты http://www.example.com/my/page.html и http://www.example.com/my/overview.html могут использовать одну и ту же базу данных или получать доступ к документам друг друга при использовании в наборах HTML-фреймов и JavaScript. В то же время http://www.malicious.com/evil.html не может получать доступ к ресурсам http://www.example.com/, потому что они имеют разное безопасное происхождение. По умолчанию локальные схемы, такие как file:// и qrc://, считаются имеющими одинаковое безопасное происхождение и могут получать доступ к ресурсам друг друга. Локальные ресурсы по умолчанию ограничены в доступе к удаленному контенту, что означает, что file:// не сможет получить доступ к http://domain.com/foo.html.

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

перечисление QWebEnginePage::Feature

Это перечисление описывает категории доступа к платформным функциям, доступ к которым пользователь может быть попрошен предоставить или запретить:

См. также featurePermissionRequested(), featurePermissionRequestCanceled(), setFeaturePermission() и PermissionPolicy.

enum QWebEnginePage::FileSelectionMode

Этот перечисление указывает, должно ли реализация функции chooseFiles() возвращать только один файл или несколько файлов:

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

enum QWebEnginePage::FindFlagflags QWebEnginePage::FindFlags

Этот перечисление описывает параметры, доступные для функции findText(). Параметры могут быть объединены с помощью операции OR из следующего списка:

Тип FindFlags — это псевдоним для QFlags<FindFlag>. Он хранит комбинацию значений FindFlag, объединённых операцией OR.

enum QWebEnginePage::JavaScriptConsoleMessageLevel

Это перечисление описывает различные уровни серьезности сообщений консоли JavaScript:

enum QWebEnginePage::NavigationType

Это перечисление описывает тип запроса на навигацию:

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

enum QWebEnginePage::PermissionPolicy

Это перечисление описывает политики разрешения, которые пользователь может установить для доступа к данным или устройствам:

См. также featurePermissionRequested(), featurePermissionRequestCanceled(), setFeaturePermission() и Feature.

enum QWebEnginePage::RenderProcessTerminationStatus

Это перечисление описывает состояние, при котором завершился процесс рендеринга:

Это перечисление было введено или изменено в Qt 5.6.

enum QWebEnginePage::WebAction

Это перечисление описывает типы действий, которые могут быть выполнены над веб-страницей.

Действия имеют эффект только тогда, когда они применимы. Доступность действий может быть определена путем проверки isEnabled() на действии, возвращаемом action().

enum QWebEnginePage::WebWindowType

Этот перечисление описывает типы окон, которые может создать функция createWindow() :

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

QWebEnginePage::QWebEnginePage(QObject *parent = Q_NULLPTR)

Создаёт пустую страницу QWebEnginePage с родителем parent.

QWebEnginePage::QWebEnginePage(QWebEngineProfile *profile, QObject *parent = Q_NULLPTR)

Создаёт пустую страницу веб-движка в профиле веб-движка profile с родителем parent.

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

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

QWebEnginePage::~QWebEnginePage()

Уничтожает страницу веб-сайта.

[virtual protected] bool QWebEnginePage::acceptNavigationRequest(const QUrl &url, NavigationType type, bool isMainFrame)

Эта функция вызывается при получении запроса на перенаправление на указанный url с помощью указанного типа перенаправления type. isMainFrame указывает, соответствует ли запрос главному фрейму или фрейму дочернему. Если функция возвращает true, запрос на перенаправление принимается и url загружается. По умолчанию все запросы на перенаправление принимаются.

Эта функция вызывается для абсолютных URL-адресов, которые начинаются с http:// или https://, и для неизвестных схем, таких как mailto:, которые будут обработаны QDesktopServices, если приняты. Чтобы эта функция вызывалась также при получении запросов на перенаправление на локальные URL-адреса, добавьте префикс к URL-адресам http://.

Запросы на перенаправление могут быть делегированы приложению Qt вместо обработки их движком HTML-обработчика путём перегрузки этой функции. Это необходимо, когда документ HTML используется как часть пользовательского интерфейса, а не для отображения внешних данных, например, при отображении списка результатов.

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

QAction *QWebEnginePage::action(WebAction action) const

Возвращает QAction для указанного WebAction action.

Действие принадлежит QWebEnginePage, но вы можете настроить его вид, изменив его свойства.

QWebEnginePage также отвечает за выполнение действия, поэтому при срабатывании соответствующего действия выполняется действие на странице.

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

[signal] void QWebEnginePage::authenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator)

Этот сигнал генерируется, когда доступ к requestUrl требует аутентификации. authenticator должен использоваться для передачи имени пользователя и пароля для соединения.

[virtual protected] bool QWebEnginePage::certificateError(const QWebEngineCertificateError &certificateError)

Эта функция вызывается, когда возникает ошибка недопустимого сертификата при загрузке данного запроса.

Параметр certificateError содержит информацию о сертификате и подробности ошибки.

Возвращение true игнорирует ошибку и завершает запрос. Возвращение false останавливает загрузку запроса.

См. также QWebEngineCertificateError.

[virtual protected] QStringList QWebEnginePage::chooseFiles(FileSelectionMode mode, const QStringList &oldFiles, const QStringList &acceptedMimeTypes)

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

mode указывает, ожидается ли возвращение только одного файла или нескольких файлов.

Предлагаемое имя файла может быть предоставлено как первая запись в oldFiles. acceptedMimeTypes игнорируется реализацией по умолчанию, но может использоваться переопределениями.

QMenu *QWebEnginePage::createStandardContextMenu()

Создаёт стандартное контекстное меню, которое отображается при щелчке правой кнопкой мыши на веб-странице. Вызывается из обработчика событий контекстного меню contextMenuEvent() по умолчанию. Владение всплывающим меню передаётся вызывающему.

[virtual protected] QWebEnginePage *QWebEnginePage::createWindow(WebWindowType type)

Эта функция вызывается для создания нового окна указанного типа type. Например, когда JavaScript-программа запрашивает открыть документ в новом окне.

Если новое окно может быть создано, то возвращается QWebEnginePage нового окна; в противном случае возвращается нулевой указатель.

Если представление, связанное с веб-страницей, является объектом QWebEngineView, то реализация по умолчанию перенаправляет запрос в QWebEngineView::createWindow; в противном случае возвращается нулевой указатель.

Примечание: В случаях, когда создание окна инициируется JavaScript, помимо переопределения этого метода приложение также должно установить QWebEngineSettings::JavascriptCanOpenWindows в значение true для того, чтобы метод был вызван.

См. также QWebEngineView::createWindow().

[virtual] bool QWebEnginePage::event(QEvent *e)

Переопределено из QObject::event().

[signal] void QWebEnginePage::featurePermissionRequestCanceled(const QUrl &securityOrigin, QWebEnginePage::Feature feature)

Этот сигнал испускается, когда веб-сайт, идентифицированный по securityOrigin, отменяет ранее выданный запрос на использование feature.

См. также featurePermissionRequested() и setFeaturePermission().

[signal] void QWebEnginePage::featurePermissionRequested(const QUrl &securityOrigin, QWebEnginePage::Feature feature)

Этот сигнал испускается, когда веб-сайт, идентифицированный по securityOrigin, запрашивает использование ресурса или устройства, идентифицированного по feature.

См. также featurePermissionRequestCanceled() и setFeaturePermission().

void QWebEnginePage::findText(const QString &subString, FindFlags options = FindFlags())

Ищет указанную строку subString на странице с использованием заданных options.

Для очистки выделения поиска просто передайте пустую строку.

void QWebEnginePage::findText(const QString &subString, FindFlags options, FunctorOrLambda resultCallback)

Ищет указанную строку subString на странице с использованием заданных options.

Для очистки выделения поиска просто передайте пустую строку.

Функция обратного вызова resultCallback должна принимать булевый параметр. Она будет вызвана со значением true, если subString была найдена; в противном случае значение обратной функции будет false.

Например:

    m_view->page()->findText(QStringLiteral("Qt"), QWebEnginePage::FindFlags(), [this](bool found) {
        if (!found) QMessageBox::information(m_view, QString(), QStringLiteral("No occurrences found"));
    });

[signal] void QWebEnginePage::fullScreenRequested(QWebEngineFullScreenRequest request)

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

Объект запроса request может использоваться для принятия или отклонения запроса.

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

См. также QWebEngineSettings::FullScreenSupportEnabled.

[signal] void QWebEnginePage::geometryChangeRequested(const QRect &geom)

Этот сигнал испускается всякий раз, когда документ хочет изменить положение и размер страницы на geom. Это может произойти, например, через JavaScript.

QWebEngineHistory *QWebEnginePage::history() const

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

[signal] void QWebEnginePage::iconUrlChanged(const QUrl &url)

Этот сигнал испускается, когда иконка ("favicon") страницы найдена или изменена. Новая URL-адрес указана в url.

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

[virtual protected] void QWebEnginePage::javaScriptAlert(const QUrl &securityOrigin, const QString &msg)

Эта функция вызывается всякий раз, когда JavaScript-программа, выполняемая в кадре, связанном с securityOrigin, вызывает функцию alert() с сообщением msg.

Реализация по умолчанию отображает сообщение msg с помощью QMessageBox::information.

[virtual protected] bool QWebEnginePage::javaScriptConfirm(const QUrl &securityOrigin, const QString &msg)

Эта функция вызывается всякий раз, когда JavaScript-программа, выполняемая в кадре, связанном с securityOrigin, вызывает функцию confirm() с сообщением msg. Возвращает true, если пользователь подтверждает сообщение; в противном случае возвращает false.

Реализация по умолчанию выполняет запрос с помощью QMessageBox::information с кнопками QMessageBox::Ok и QMessageBox::Cancel.

[virtual protected] void QWebEnginePage::javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, const QString &message, int lineNumber, const QString &sourceID)

Эта функция вызывается, когда JavaScript-программа пытается вывести message в консоль веб-браузера.

Например, в случае ошибок вычисления исходный URL-адрес может быть указан в sourceID, а также lineNumber.

level указывает степень события, вызвавшего сообщение. То есть, было ли это вызвано ошибкой или менее серьезным событием.

С Qt 5.6 реализация по умолчанию записывает сообщения в js категорию регистрации.

См. также Ведение журналов консоли.

[virtual protected] bool QWebEnginePage::javaScriptPrompt(const QUrl &securityOrigin, const QString &msg, const QString &defaultValue, QString *result)

Эта функция вызывается всякий раз, когда JavaScript-программа, выполняемая в кадре, связанном с securityOrigin, пытается запросить ввод у пользователя. Программа может предоставить необязательное сообщение msg, а также значение по умолчанию для ввода в defaultValue.

Если пользователь отменил запрос, реализация должна вернуть false; в противном случае результат должен быть записан в result и возвращено значение true. Если запрос не был отменён пользователем, реализация должна вернуть true, а строка результата не должна быть нулевой.

Реализация по умолчанию использует QInputDialog::getText().

[signal] void QWebEnginePage::linkHovered(const QString &url)

Этот сигнал испускается, когда курсор мыши наведён на ссылку. url содержит целевой URL ссылки.

void QWebEnginePage::load(const QUrl &url)

Загружает url на эту страницу.

Примечание: Представление остаётся прежним, пока не прибудут достаточные данные для отображения нового URL.

См. также setUrl(), setHtml() и setContent().

[signal] void QWebEnginePage::loadFinished(bool ok)

Этот сигнал испускается, когда завершается загрузка контента страницы. Этот сигнал не зависит от выполнения сценариев или отрисовки страницы. ok укажет, была ли загрузка успешной или произошла ошибка.

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

[signal] void QWebEnginePage::loadProgress(int progress)

Этот сигнал испускается при изменении общего состояния прогресса. Текущее значение предоставлено progress и масштабируется от 0 до 100, что является стандартным диапазоном QProgressBar. Он накапливает изменения от всех дочерних кадров.

[signal] void QWebEnginePage::loadStarted()

Этот сигнал излучается, когда страница начинает загружать содержимое.

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

QWebEngineProfile *QWebEnginePage::profile() const

Возвращает профиль движка веб-браузера, к которому принадлежит страница.

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

[signal] void QWebEnginePage::proxyAuthenticationRequired(const QUrl &requestUrl, QAuthenticator *authenticator, const QString &proxyHost)

Этот сигнал излучается, когда доступ к requestUrl через proxyHost требует аутентификации для прокси. authenticator должен использоваться для передачи имени пользователя и пароля для подключения.

[signal] void QWebEnginePage::renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode)

Этот сигнал излучается, когда процесс рендеринга завершается с ненулевым кодом выхода. terminationStatus — это код завершения процесса, а exitCode — код состояния, с которым процесс завершился.

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

void QWebEnginePage::runJavaScript(const QString &scriptSource, FunctorOrLambda resultCallback)

Выполняет JavaScript-код, содержащийся в scriptSource.

Скрипт будет выполняться в той же области, что и другие скрипты, являющиеся частью загруженного сайта.

После выполнения скрипта вызывается resultCallback с результатом последнего выполненного оператора. resultCallback может быть указателем на функцию, функтором или лямбда-функцией и должен принимать параметр типа QVariant. Например:

page.runJavaScript("document.title", [](const QVariant &v) { qDebug() << v.toString(); });

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

См. scripts() для альтернативного API вставки скриптов.

void QWebEnginePage::runJavaScript(const QString &scriptSource)

Эта функция перегружает runJavaScript().

Эта вспомогательная функция выполняет JavaScript-код, содержащийся в scriptSource.

QWebEngineScriptCollection &QWebEnginePage::scripts()

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

Кроме того, страница может также выполнять скрипты, добавленные с помощью QWebEngineProfile::scripts().

См. также QWebEngineScriptCollection и QWebEngineScript.

[signal] void QWebEnginePage::selectionChanged()

Этот сигнал излучается всякий раз, когда выделение изменяется, как интерактивно, так и программно. Например, вызвав triggerAction() с действием выделения.

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

void QWebEnginePage::setContent(const QByteArray &data, const QString &mimeType = QString(), const QUrl &baseUrl = QUrl())

Устанавливает содержимое этой страницы на data. Если аргумент mimeType пустой, в настоящее время предполагается, что содержимое является HTML, но в будущих версиях мы можем добавить автоматическое определение.

Внешние объекты, упомянутые в содержимом, находятся относительно baseUrl.

data загружается немедленно; внешние объекты загружаются асинхронно.

Примечание: Этот метод не повлияет на сеансовую или глобальную историю для страницы.

Предупреждение: Содержимое будет закодировано по процентам перед отправкой в рендерер через IPC. Это может увеличить его размер. Максимальный размер закодированного по процентам содержимого составляет 2 мегабайта минус 6 байтов плюс длина строки типа MIME.

См. также toHtml() и setHtml().

void QWebEnginePage::setFeaturePermission(const QUrl &securityOrigin, Feature feature, PermissionPolicy policy)

Устанавливает разрешение для веб-сайта, идентифицированного по securityOrigin, на использование feature в соответствии с policy.

Примечание: Вызовите этот метод в сигнале featurePermissionRequested(), так как он предназначен только для обслуживания ожидающих запросов на предоставление функций. Установка разрешений на функции до запроса не имеет эффекта.

См. также featurePermissionRequested() и featurePermissionRequestCanceled().

void QWebEnginePage::setHtml(const QString &html, const QUrl &baseUrl = QUrl())

Устанавливает содержимое этой страницы на html. baseUrl — необязательный параметр, используемый для разрешения относительных URL-адресов в документе, таких как ссылки на изображения или таблицы стилей.

html загружается немедленно; внешние объекты загружаются асинхронно.

Если скрипт в html выполняется дольше, чем значение по умолчанию для таймаута выполнения скрипта (в настоящее время 10 секунд), например, из-за блокировки модальным JavaScript-диалоговым окном, этот метод возвращает как можно быстрее после таймаута, и любые последующие html будут загружены асинхронно.

При использовании этого метода движок веб-браузера предполагает, что внешние ресурсы, такие как JavaScript-программы или таблицы стилей, закодированы в UTF-8, если не указано иное. Например, кодировка внешнего скрипта может быть указана через атрибут charset тега HTML script. Кодировка также может быть указана веб-сервером.

Это вспомогательная функция, эквивалентная setContent(html, "text/html", baseUrl).

Примечание: Этот метод не повлияет на сеансовую или глобальную историю для страницы.

Предупреждение: Эта функция работает только для HTML. Для других типов MIME (например, XHTML и SVG) необходимо использовать setContent().

Предупреждение: Содержимое будет закодировано по процентам перед отправкой в рендерер через IPC. Это может увеличить его размер. Максимальный размер закодированного по процентам содержимого составляет 2 мегабайта минус 30 байтов.

См. также toHtml(), setContent() и load().

void QWebEnginePage::setView(QWidget *view)

Устанавливает view, который связан с веб-страницей.

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

void QWebEnginePage::setWebChannel(QWebChannel *channel)

Устанавливает экземпляр веб-канала, который будет использоваться этой страницей, на channel и подключает его к транспорту веб-движка с помощью сообщений IPC Chromium. Транспорт доступен в контексте JavaScript этой страницы как qt.webChannelTransport, который следует использовать при использовании Qt WebChannel JavaScript API.

Примечание: Страница не принимает владения объектом канала.

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

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

QWebEngineSettings *QWebEnginePage::settings() const

Возвращает указатель на объект настроек страницы.

См. также QWebEngineSettings::globalSettings().

[signal] void QWebEnginePage::titleChanged(const QString &title)

Этот сигнал излучается всякий раз, когда заголовок страницы изменяется. Строка title указывает новый заголовок.

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

void QWebEnginePage::toHtml(FunctorOrLambda resultCallback) const

Асинхронный метод для получения содержимого страницы в формате HTML, заключенного в теги HTML и BODY. При успешном завершении, resultCallback вызывается с содержимым страницы.

Примечание: resultCallback может быть указателем на функцию, функтором или лямбда-функцией и должен принимать параметр типа QString.

См. также setHtml() и toPlainText().

void QWebEnginePage::toPlainText(FunctorOrLambda resultCallback) const

Асинхронный метод для получения содержимого страницы, преобразованного в обычный текст, полностью очищенного от HTML-форматирования. При успешном завершении, resultCallback вызывается с содержимым страницы.

Примечание: resultCallback может быть указателем на функцию, функтором или лямбда-функцией и должен принимать параметр типа QString.

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

[virtual] void QWebEnginePage::triggerAction(WebAction action, bool checked = false)

Этот метод можно вызвать, чтобы запустить указанное действие. Он также вызывается Qt WebEngine, если пользователь запускает действие, например, через элемент контекстного меню.

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

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

[signal] void QWebEnginePage::urlChanged(const QUrl &url)

Этот сигнал излучается с URL-адресом страницы при получении заголовка страницы. Новый URL-адрес указан в url.

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

QWidget *QWebEnginePage::view() const

Возвращает виджет представления, связанный со веб-страницей.

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

QWebChannel *QWebEnginePage::webChannel() const

Возвращает указатель на экземпляр канала веб-связи, используемый этой страницей, или нулевой указатель, если он не был задан. Этот канал автоматически использует внутренний механизм транспорта веб-движка через Chromium IPC, который экспонируется в контексте JavaScript этой страницы как qt.webChannelTransport.

Этот метод был введен в Qt 5.5.

См. также setWebChannel.

[signal] void QWebEnginePage::windowCloseRequested()

Этот сигнал излучается всякий раз, когда страница запрашивает закрытие окна веб-браузера, например, через JavaScript вызов window.close().

См. также QWebEnginePage::RequestClose.