Класс QWebEnginePage

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

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

Общие типы

Свойства

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

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

Реализованные публичные функции

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

Сигналы

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

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

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

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

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

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

• 1 публичный слот унаследован от 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(). Кроме того, страница может также содержать значок, который можно получить с помощью свойства icon() или его URL с помощью свойства iconUrl(). Если заголовок или значок изменяются, будут выпущены соответствующие сигналы titleChanged(), iconChanged() и 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.

Скрипты могут быть выполнены на веб-странице с помощью runJavaScript(), либо в основном мире JavaScript, вместе со всем остальным JavaScript, полученным из веб-содержимого, либо в собственном изолированном мире. Хотя DOM страницы можно получить доступ из любого мира, переменные JavaScript функции, определённые в одном мире, недоступны из другого. QWebEngineScript::ScriptWorldId предоставляет некоторые предопределённые идентификаторы для этой цели. Использование runJavaScript() версии без идентификатора мира эквивалентно выполнению скрипта в MainWorld.

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

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

enum QWebEnginePage::Feature

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

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

enum QWebEnginePage::FileSelectionMode

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

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

enum QWebEnginePage::FindFlagflags QWebEnginePage::FindFlags

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

Тип FindFlags — это псевдоним для QFlags<FindFlag>. Он хранит комбинированное значение FindFlag с помощью операции ИЛИ.

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(). Контекстно-зависимые действия всегда доступны.

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

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

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

Выполняет JavaScript-код, содержащийся в scriptSource, в мире, указанном worldId. Значения идентификаторов миров совпадают с теми, что предоставляет QWebEngineScript::ScriptWorldId, и находятся в диапазоне от 0 до 256. Использование версий runJavaScript() без идентификатора мира эквивалентно выполнению скрипта в MainWorld.

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

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

Из JavaScript в качестве результата может быть возвращено только «простое» значение данных. Поддерживаемые типы данных включают все типы данных JSON, а также, например, Date и ArrayBuffer. Неподдерживаемые типы данных включают, например, Function и Promise.

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

Предупреждение: Гарантируется, что обратный вызов (resultCallback) всегда будет выполнен, но он может быть вызван во время уничтожения страницы. Когда QWebEnginePage удаляется, обратный вызов срабатывает с недействительным значением, и использовать соответствующий экземпляр QWebEnginePage или QWebEngineView внутри него небезопасно.

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

Данная документация была добавлена в Qt 5.7.

См. такжеQWebEngineScript::ScriptWorldId.

QWebEnginePage::QWebEnginePage(QObject *parent = Q_NULLPTR)

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

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

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

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

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

[virtual] QWebEnginePage::~QWebEnginePage()

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

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

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

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

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

Примечание: Процесс загрузки запускается и сигнал loadStarted() генерируется до принятия или отклонения запроса. Поэтому ожидается сигнал loadFinished(), возвращающий false, даже после делегирования запроса.

Класс QWebEngineUrlRequestInterceptor предоставляет дополнительные возможности для перехвата и изменения запросов.

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

QAction *QWebEnginePage::action(QWebEnginePage::WebAction action) const

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

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

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

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

[signal] void QWebEnginePage::audioMutedChanged(bool muted)

Этот сигнал генерируется при изменении состояния muted страницы.

Примечание: Не следует путать с отключением звука конкретного элемента HTML5 аудио или видео.

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

Примечание: Сигнал уведомления для свойства audioMuted.

[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(QWebEnginePage::FileSelectionMode mode, const QStringList &oldFiles, const QStringList &acceptedMimeTypes)

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

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

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

const QWebEngineContextMenuData &QWebEnginePage::contextMenuData() const

Возвращает дополнительные данные о текущем контекстном меню. Гарантируется, что данные валидны только во время вызова обработчика QWebEngineView::contextMenuEvent() связанного QWebEngineView.

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

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

QMenu *QWebEnginePage::createStandardContextMenu()

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

Возвращает nullptr в случае, если данные контекстного меню не инициализированы, например, когда вызов происходит без запроса контекстного меню.

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

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

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

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

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

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

QWebEnginePage *QWebEnginePage::devToolsPage() const

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

Возвращает nullptr, если страница инструментов разработчика не задана.

Функция была введена в Qt 5.11.

См. также setDevToolsPage() и inspectedPage().

void QWebEnginePage::download(const QUrl &url, const QString &filename = QString())

Загружает ресурс из указанного местоположения url в локальный файл.

Если задано filename, оно используется в качестве предполагаемого имени файла. Если оно относительное, файл сохраняется в стандартном расположении для загрузок с указанным именем. Если это null или пустая строка QString, используется имя файла по умолчанию.

Этот метод вызовет QWebEngineProfile::downloadRequested() после начала загрузки.

Функция была введена в Qt 5.10.

[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, QWebEnginePage::FindFlags options = ..., const QWebEngineCallback<bool> &resultCallback = ...)

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

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

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

Предупреждение: Мы гарантируем, что обратный вызов (resultCallback) всегда вызывается, но это может произойти во время уничтожения страницы. Когда QWebEnginePage удаляется, обратный вызов срабатывает с недействительным значением, и использование соответствующего экземпляра QWebEnginePage или QWebEngineView внутри него небезопасно.

Например:

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

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

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

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

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

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

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

Примечание: setGeometry() ожидает размер без учета украшения окна, а geom включает его. Необходимо удалить размер полей рамки из geom, чтобы обработать этот сигнал правильно.

window->setGeometry(geom.marginsRemoved(window->frameMargins()));

QWebEngineHistory *QWebEnginePage::history() const

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

[signal] void QWebEnginePage::iconChanged(const QIcon &icon)

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

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

Примечание: Сигнал уведомления для свойства icon.

См. также icon(), iconUrl() и iconUrlChanged().

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

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

Примечание: Сигнал уведомления для свойства iconUrl.

См. также iconUrl(), icon() и iconChanged().

QWebEnginePage *QWebEnginePage::inspectedPage() const

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

Возвращает nullptr, если эта страница не является страницей инструментов разработчика.

Функция была введена в Qt 5.11.

См. также setInspectedPage() и devToolsPage().

[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.

Также вызывается, когда обработчик onbeforeunload запрашивает подтверждение перед покиданием страницы.

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

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

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

Например, в случае ошибок вычисления в sourceID может быть предоставлен URL-адрес источника, а также 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, и строка результата не должна быть равна null.

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

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

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

void QWebEnginePage::load(const QUrl &url)

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

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

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

void QWebEnginePage::load(const QWebEngineHttpRequest &request)

Выполняет указанный request и загружает ответ.

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

См. также load(), setUrl(), url(), urlChanged() и QUrl::fromUserInput().

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

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

Примечание: Запросы на навигацию могут быть делегированы приложению Qt вместо обработки их обработчиком HTML-движка путём перегрузки функции acceptNavigationRequest(). Поскольку процесс загрузки запускается и сигнал loadStarted() подаётся *до* принятия или отклонения запроса, ожидается сигнал loadFinished(), возвращающий false, даже после делегирования запроса.

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

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

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

[signal] void QWebEnginePage::loadStarted()

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

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

[signal] void QWebEnginePage::pdfPrintingFinished(const QString &filePath, bool success)

Этот сигнал подаётся, когда завершилась печать веб-страницы в файл PDF. filePath содержит путь, по которому было запрошено создание файла, а success будет true, если файл был успешно создан, и false, в противном случае.

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

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

void QWebEnginePage::print(QPrinter *printer, const QWebEngineCallback<bool> &resultCallback)

Рендерит текущее содержимое страницы в временный PDF-документ, а затем печатает его с помощью printer.

Настройки для создания и печати PDF-документа будут взяты из объекта printer. Пользователь несёт ответственность за обеспечение того, чтобы printer оставался допустимым до тех пор, пока не будет вызвано resultCallback.

Примечание: Рендеринг текущего содержимого в временный PDF-документ является асинхронным и не блокирует главный поток. Однако последующий рендеринг PDF в printer выполняется в главном потоке и, следовательно, заблокирует цикл событий. Кроме того, печать выполняется в процессе браузера, который по умолчанию не защищён.

resultCallback должен принимать булево значение в качестве параметра. Если печать прошла успешно, это булево значение будет true, в противном случае его значение будет false.

Предупреждение: Мы гарантируем, что обратный вызов (resultCallback) всегда будет вызван, но он может быть выполнен во время уничтожения страницы. При удалении QWebEnginePage обратный вызов вызывается с недопустимым значением, и использование соответствующего экземпляра QWebEnginePage или QWebEngineView внутри него небезопасно.

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

[signal] void QWebEnginePage::printRequested()

Этот сигнал подаётся, когда вызывается JavaScript-метод window.print(). Обычно обработчик сигнала может просто вызвать printToPdf().

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

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

void QWebEnginePage::printToPdf(const QString &filePath, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))

Рендерит текущее содержимое страницы в PDF-документ и сохраняет его в указанном в filePath месте. Размер страницы и ориентация создаваемого PDF-документа берутся из значений, указанных в pageLayout.

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

Если файл уже существует по указанному пути, он будет перезаписан.

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

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

void QWebEnginePage::printToPdf(const QWebEngineCallback<const QByteArray &> &resultCallback, const QPageLayout &pageLayout = QPageLayout(QPageSize(QPageSize::A4), QPageLayout::Portrait, QMarginsF()))

Рендерит текущего содержимого страницы в PDF-документ и возвращает массив байтов, содержащий данные PDF, в качестве параметра для resultCallback. Размер страницы и ориентация создаваемого PDF-документа берутся из значений, указанных в pageLayout.

resultCallback должен принимать константную ссылку на QByteArray в качестве параметра. Если печать прошла успешно, этот массив байтов будет содержать данные PDF, в противном случае массив байтов будет пустым.

Предупреждение: Мы гарантируем, что обратный вызов (resultCallback) всегда будет вызван, но он может быть выполнен во время уничтожения страницы. При удалении QWebEnginePage обратный вызов вызывается с недопустимым значением, и использование соответствующего экземпляра QWebEnginePage или QWebEngineView внутри него небезопасно.

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

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::quotaRequested(QWebEngineQuotaRequest quotaRequest)

Этот сигнал подаётся, когда веб-страница запрашивает больше постоянного хранилища, чем текущий объём выделенный приложением в File System API. Значение по умолчанию для квоты 0 байтов.

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

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

[signal] void QWebEnginePage::recentlyAudibleChanged(bool recentlyAudible)

Этот сигнал подаётся, когда состояние воспроизведения звука на странице, recentlyAudible, изменяется, потому что воспроизведение аудио началось или завершилось.

Примечание: Сигнал также излучается при вызове метода setAudioMuted(). Кроме того, если аудио приостановлено, этот сигнал излучается с приблизительной задержкой в две секунды с момента приостановки аудио.

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

Примечание: Сигнал уведомления для свойства recentlyAudible.

[signal] void QWebEnginePage::registerProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request)

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

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

void WebPage::handleRegisterProtocolHandlerRequested(QWebEngineRegisterProtocolHandlerRequest request)
{
    auto answer = QMessageBox::question(
        view()->window(),
        tr("Permission Request"),
        tr("Allow %1 to open all %2 links?")
        .arg(request.origin().host())
        .arg(request.scheme()));
    if (answer == QMessageBox::Yes)
        request.accept();
    else
        request.reject();
}

Данная функция была введена в Qt 5.11.

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

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

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

void QWebEnginePage::replaceMisspelledWord(const QString &replacement)

Заменить текущее неверное слово на replacement.

Текущее неверное слово можно найти в QWebEngineContextMenuData::misspelledWord(), а предложенные замены — в QWebEngineContextMenuData::spellCheckerSuggestions().

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

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

void QWebEnginePage::save(const QString &filePath, QWebEngineDownloadItem::SavePageFormat format = QWebEngineDownloadItem::MimeHtmlSaveFormat) const

Сохранить текущую загруженную веб-страницу на диск.

Веб-страница сохраняется в filePath в указанном формате format.

Это сокращение для следующих действий:

• Вызвать действие Сохранить веб-страницу.
• Принять следующий элемент загрузки и установить указанный путь к файлу и формат сохранения.

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

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

См. также QWebEngineDownloadItem::SavePageFormat.

QWebEngineScriptCollection &QWebEnginePage::scripts()

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

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

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

[signal] void QWebEnginePage::selectClientCertificate(QWebEngineClientCertificateSelection clientCertificateSelection)

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

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

Если сигнал не обрабатывается, clientCertificateSelection автоматически уничтожается, и загрузка продолжится без сертификата клиента.

Данная функция была введена в Qt 5.12.

См. также QWebEngineClientCertificateSelection.

[signal] void QWebEnginePage::selectionChanged()

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

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

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

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

Устанавливает содержимое веб-страницы на data. Если аргумент mimeType пустой, предполагается, что содержимое text/plain,charset=US-ASCII.

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

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

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

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

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

void QWebEnginePage::setDevToolsPage(QWebEnginePage *devToolsPage)

Привязывает devToolsPage к инструментам разработчика этой страницы. Заставляет devToolsPage перейти к внутренней URL-адресу с инструментами разработчика.

Это эквивалентно вызову setInspectedPage() на devToolsPage с this в качестве аргумента.

Данная функция была введена в Qt 5.11.

См. также devToolsPage() и setInspectedPage().

void QWebEnginePage::setFeaturePermission(const QUrl &securityOrigin, QWebEnginePage::Feature feature, QWebEnginePage::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::setInspectedPage(QWebEnginePage *page)

Перенаправляет эту страницу на внутренний URL-адрес, который является инструментами разработчика page.

Это эквивалентно вызову setDevToolsPage() на page с this в качестве аргумента.

Данная функция была введена в Qt 5.11.

См. также inspectedPage() и setDevToolsPage().

void QWebEnginePage::setView(QWidget *view)

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

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

void QWebEnginePage::setWebChannel(QWebChannel *channel, uint worldId)

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

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

Примечание: На странице может быть установлен только один канал веб-общения, установка даже в другом JavaScript-мире отменяет установку любого уже установленного канала веб-общения.

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

См. также webChannel() и QWebEngineScript::ScriptWorldId.

void QWebEnginePage::setWebChannel(QWebChannel *channel)

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

Устанавливает экземпляр канала веб-общения, используемый данной страницей, в channel и устанавливает его в главном JavaScript-мире.

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

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

См. также QWebEngineScript::MainWorld.

QWebEngineSettings *QWebEnginePage::settings() const

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

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

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

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

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

void QWebEnginePage::toHtml(const QWebEngineCallback<const QString &> &resultCallback) const

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

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

Предупреждение: Мы гарантируем, что обратный вызов (resultCallback) всегда будет вызван, но это может произойти во время уничтожения страницы. При удалении QWebEnginePage обратный вызов вызывается с недействительным значением, и использование соответствующего экземпляра QWebEnginePage или QWebEngineView внутри него небезопасно.

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

void QWebEnginePage::toPlainText(const QWebEngineCallback<const QString &> &resultCallback) const

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

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

Предупреждение: Мы гарантируем, что обратный вызов (resultCallback) всегда будет вызван, но это может произойти во время уничтожения страницы. При удалении QWebEnginePage обратный вызов вызывается с недействительным значением, и использование соответствующего экземпляра QWebEnginePage или QWebEngineView внутри него небезопасно.

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

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

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

Если action является действием с флажком, то 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().

См. также RequestClose.