Тип QML WebEngineView

WebEngineView отображает веб-содержимое в приложении QML. Подробнее...

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

Свойства

• ErrorDomain : перечисление
• Feature : перечисление
• FindFlags : перечисление
• JavaScriptConsoleMessageLevel : перечисление
• LifecycleState : перечисление
• LoadStatus : перечисление
• NewViewDestination : перечисление
• PrintedPageOrientation : перечисление
• PrintedPageSizeId : перечисление
• RenderProcessTerminationStatus : перечисление
• WebAction : перечисление
• activeFocusOnPress : bool
• audioMuted : bool
• backgroundColor : bool
• canGoBack : bool
• canGoForward : bool
• contentsSize : размер
• devToolsView : WebEngineView
• icon : url
• inspectedView : WebEngineView
• isFullScreen : bool
• lifecycleState : LifecycleState
• loadProgress : int
• loading : bool
• navigationHistory : WebEngineHistory
• profile : WebEngineProfile
• recentlyAudible : bool
• recommendedState : LifecycleState
• scrollPosition : точка
• settings : WebEngineSettings
• title : строка
• url : url
• userScripts : список<WebEngineScript>
• webChannel : QQmlWebChannel
• webChannelWorld : int
• zoomFactor : вещественное

Сигналы

• activeFocusOnPressChanged(activeFocusOnPress)
• audioMutedChanged(muted)
• authenticationDialogRequested(request)
• backgroundColorChanged()
• certificateError(error)
• colorDialogRequested(request)
• contextMenuRequested(request)
• featurePermissionRequested(securityOrigin, Feature feature)
• fileDialogRequested(request)
• findTextFinished(result)
• fullScreenRequested(request)
• geometryChangeRequested(geometry, прямоугольник frameGeometry)
• javaScriptConsoleMessage(level, строка message, int lineNumber, строка sourceID)
• javaScriptDialogRequested(request)
• linkHovered(hoveredUrl)
• loadingChanged(loadRequest)
• navigationRequested(request)
• newViewRequested(request)
• pdfPrintingFinished(filePath, bool success)
• printRequest()
• quotaRequested(request)
• recentlyAudibleChanged(recentlyAudible)
• registerProtocolHandlerRequested(request)
• renderProcessTerminated(terminationStatus, int exitCode)
• selectClientCertificate(clientCertificateSelection)
• tooltipRequested(request)
• wasRecentlyAudibleChanged(wasRecentlyAudible)
• windowCloseRequested()

Методы

• WebEngineAction action(action)
• void findText(subString, FindFlags options, variant resultCallback)
• void findText(subString, FindFlags options)
• void findText(subString)
• void fullScreenCancelled()
• void goBack()
• void goBackOrForward(offset)
• void goForward()
• void grantFeaturePermission(securityOrigin, Feature feature, bool granted)
• void loadHtml(html, url baseUrl)
• void printToPdf(resultCallback, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
• void printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)
• void reload()
• void reloadAndBypassCache()
• void replaceMisspelledWord(const QString &replacement)
• void runJavaScript(script, variant callback)
• void setActiveFocusOnPress(arg)
• void stop()
• void triggerWebAction(action)

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

Тип WebEngineView позволяет приложениям QML отображать области динамического веб-контента. Он может совместно использовать экран с другими типами QML, такими как TabView, или заполнять весь экран, как указано в приложении QML.

Инициализация Web Engine

Для отображения веб-движка необходимо инициализировать его, используя QtWebEngine::initialize в файле исходного кода приложения, как показано в следующем фрагменте кода:

int main(int argc, char *argv[])
{
    QCoreApplication::setOrganizationName("QtExamples");
    QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling);
    QCoreApplication::setAttribute(Qt::AA_ShareOpenGLContexts);
    QtWebEngine::initialize();
    QGuiApplication app(argc, argv);

    QQmlApplicationEngine engine;
    engine.load(QUrl(QStringLiteral("qrc:/main.qml")));

    return app.exec();
}

Загрузка веб-страниц

Приложение может загружать страницы в WebEngineView, используя свойство url или метод loadHtml, и перемещаться по истории посещений представления. Для загрузки URL всегда используется метод GET.

История представлена моделью данных WebEngineHistory, которая хранится в свойстве navigationHistory.

Следующее примерное приложение QML загружает веб-страницу, используя свойство url:

import QtQuick 2.0
import QtQuick.Window 2.0
import QtWebEngine 1.0

Window {
    width: 1024
    height: 750
    visible: true
    WebEngineView {
        anchors.fill: parent
        url: "https://www.qt.io"
    }
}

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

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

Если при загрузке веб-страницы возникает ошибка сертификата, генерируется сигнал certificateError(). Обработка ошибок сертификатов осуществляется с помощью методов типа WebEngineCertificateError.

Взаимодействие

По умолчанию ссылки на другие страницы загружаются в том же объекте WebEngineView, но веб-сайты могут запросить их открытие в новой вкладке, окне или диалоговом окне. При запросе загрузки страницы в отдельном представлении веб-движка генерируется сигнал newViewRequested(). Свойство NewViewDestination описывает, как должно быть открыто новое представление. Кроме того, для загрузки веб-страниц в отдельных представлениях веб-движка можно использовать утилиту WebEngineNewViewRequest.

Метод findText() можно использовать для поиска строки на веб-странице с использованием параметров, описанных в FindFlags.

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

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

Сигнал linkHovered() генерируется, когда курсор мыши попадает на ссылку, и соответствует событию mouseover DOM.

Действия, такие как выделение и редактирование содержимого, можно выполнять на веб-странице с помощью метода triggerWebAction(). Доступные действия описаны в свойстве WebAction.

Сигнал backgroundColorChanged() генерируется при изменении цвета фона веб-страницы.

Пользовательские скрипты

При загрузке страницы так называемые пользовательские скрипты могут быть внедрены в движок JavaScript в различные моменты. Объекты скриптов, прикрепленные к представлению веб-движка, хранятся в свойстве userScripts и внедряются с помощью типа WebEngineScript. Скрипты также можно запускать с помощью метода runJavaScript() в той же среде, что и другие скрипты, являющиеся частью загруженного сайта.

Свойство webChannel может использоваться для экспорта экземпляра WebChannel в контекст JavaScript страницы, которую он отображает, как qt.webChannelTransport.

Режим полноэкранного отображения

Веб-страница может запросить загрузку в полноэкранном режиме через API JavaScript. Сигнал fullScreenRequested() генерируется при запросе веб-страницей. Для переключения полноэкранных запросов можно использовать утилиту FullScreenRequest. Метод fullScreenCancelled можно использовать для уведомления движка браузера о том, что система оконного интерфейса заставляет приложение выйти из полноэкранного режима.

Профили

Представления веб-движка могут быть изолированы друг от друга с помощью типа WebEngineProfile. Профиль содержит настройки, скрипты и список посещённых ссылок, используемых всеми представлениями, принадлежащими профилю. Например, можно создать отдельный профиль для режима инкогнито. Текущий профиль для представления хранится в свойстве profile, а текущие настройки хранятся в свойстве settings. Настройки задаются с помощью типа WebEngineSettings.

Особенности платформы

Веб-страницы могут запрашивать доступ к функциям платформы, таким как геолокация или устройства захвата аудио и видео. Сигнал featurePermissionRequested() генерируется, когда веб-страница запрашивает использование ресурса. Поддерживаемые функции платформы описаны в свойстве Feature. Если пользователи предоставляют разрешение, метод grantFeaturePermission() используется для установки значения granted.

Вывод на поверхность OpenGL

При использовании QQuickRenderControl для вывода пользовательского интерфейса Qt Quick на поверхность OpenGL тип WebEngineView отображается неправильно. Представление веб-движка пытается использовать глобальный контекст OpenGL, созданный функцией QtWebEngine::initialize, но нет публичного API для доступа к этому контексту для совместного использования с контекстом QQuickRenderControl.

Чтобы корректно отобразить представление веб-движка, можно вручную создать новый контекст, который будет совместно использоваться с контекстом QQuickRenderControl, и вызвать непубличную функцию qt_gl_set_global_share_context() вместо вызова initialize(). Если initialize() вызывается после установки глобального контекста, он ничего не сделает.

Документация по свойствам

ErrorDomain : перечисление

Описывает различные типы ошибок высокого уровня:

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

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

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

FindFlags : перечисление

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

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

JavaScriptConsoleMessageLevel : перечисление

Указывает уровень серьезности сообщения консоли JavaScript:

LifecycleState : перечисление

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

Это свойство было добавлено в QtWebEngine 1.10.

См. также lifecycleState, API жизненного цикла страницы и Пример жизненного цикла WebEngine.

LoadStatus : перечисление

Отражает состояние загрузки страницы:

NewViewDestination : перечисление

Описывает способ открытия нового окна/вкладки:

См. также WebEngineNewViewRequest.destination.

PrintedPageOrientation : перечисление

Описывает ориентацию PDF-документа, создаваемого из содержимого WebEngineView. Значения перечисления сопоставлены и должны соответствовать QPageLayout::Orientation.

Это свойство было добавлено в QtWebEngine 1.3.

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

PrintedPageSizeId : перечисление

Это тип перечисления, перечисляющий доступные размеры страниц, определенные в стандарте Postscript PPD.

Значения перечисления сопоставлены и должны соответствовать QPageSize::PageSizeId. Они также дублируются в QPagedPaintDevice и QPrinter.

Определенные размеры:

Это свойство было введено в QtWebEngine 1.3.

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

RenderProcessTerminationStatus : перечисление

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

Это свойство было введено в QtWebEngine 1.2.

WebAction : перечисление

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

Это свойство было введено в QtWebEngine 1.2.

activeFocusOnPress : bool

Указывает, должно ли отображение получать активный фокус при нажатии. Значение по умолчанию — true.

Это свойство было введено в QtWebEngine 1.2.

audioMuted : bool

Состояние, указывает, заглушён ли звук на текущей странице.

Это свойство было введено в QtWebEngine 1.3.

См. также recentlyAudible.

backgroundColor : bool

Изменяет цвет фона WebEngineView, находящийся за телом документа. Может быть установлен на значение "transparent" или на полупрозрачный цвет, чтобы просматривать документ или согласовывать веб-контент в гибридном приложении, предотвращая вспышки белого цвета, которые могут возникать во время загрузки.

Значение по умолчанию — белый.

Это свойство было введено в QtWebEngine 1.2.

[только для чтения] canGoBack : bool

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

[только для чтения] canGoForward : bool

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

contentsSize : размер

Размер содержимого страницы.

Этот свойство было добавлено в QtWebEngine 1.3.

devToolsView : WebEngineView

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

Это свойство было добавлено в QtWebEngine 1.7.

См. также inspectedView.

[только для чтения] icon : url

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

Следующий фрагмент использует свойство icon для построения компонента Image:

Image {
    id: appIcon
    sourceSize: Qt.size(32, 32)
    source: webView.icon != "" ? webView.icon : "fallbackFavicon.png";
    // ...
}

Указание свойства sourceSize элемента Image информирует поставщика favicon Qt WebEngine о запрошенном размере. Поставщик favicon пытается найти наилучшее соответствие среди предлагаемых значков веб-страницы. Если свойство sourceSize не указано, поставщик предоставляет значок с наибольшим разрешением.

inspectedView : WebEngineView

Представление, которое в настоящее время проверяется этим представлением, если таковое имеется. Установка перенаправит представление на внутренний URL с инструментами разработчика заданного представления.

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

Это свойство было добавлено в QtWebEngine 1.7.

См. также devToolsView.

[только для чтения] isFullScreen : bool

Возвращает true, если веб-представление находится в полноэкранном режиме, false в противном случае.

Это свойство было добавлено в QtWebEngine 1.1.

См. также fullScreenRequested() и fullScreenCancelled().

lifecycleState : LifecycleState

Текущее состояние жизненного цикла страницы.

Следующие ограничения применяются к установщику:

• Видимая страница должна оставаться в состоянии Active.
• Если страница проверяется с помощью devToolsView, то обе страницы должны оставаться в состояниях Active.
• Страница в состоянии Discarded может перейти только в состояние Active. Это приведёт к перезагрузке страницы.

Это — единственные жёсткие ограничения на состояние жизненного цикла, но см. также recommendedState для рекомендуемых мягких ограничений.

Это свойство было добавлено в QtWebEngine 1.10.

См. также recommendedState, Page Lifecycle API и WebEngine Lifecycle Example.

[только для чтения] loadProgress : int

Количество данных страницы, загруженных в процентах в диапазоне от 0 до 100.

[только для чтения] loading : bool

Возвращает true, если страница HTML загружается в данный момент, false в противном случае.

[только для чтения] navigationHistory : WebEngineHistory

История навигации текущего представления.

Это свойство было добавлено в QtWebEngine 1.1.

См. также WebEngineHistory.

profile : WebEngineProfile

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

Это свойство было добавлено в QtWebEngine 1.1.

См. также WebEngineProfile.

[только для чтения] recentlyAudible : bool

Возвращает текущее состояние воспроизводимости страницы (звук был недавно воспроизведён или нет).

Это свойство было добавлено в QtWebEngine 1.3.

См. также audioMuted и recentlyAudibleChanged.

recommendedState : LifecycleState

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

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

Это свойство было добавлено в QtWebEngine 1.10.

См. также lifecycleState, Page Lifecycle API и WebEngine Lifecycle Example.

scrollPosition : точка

Положение прокрутки содержимого страницы.

Это свойство было добавлено в QtWebEngine 1.3.

[только для чтения] settings : WebEngineSettings

Настройки, используемые этим представлением.

Это свойство было добавлено в QtWebEngine 1.1.

См. также WebEngineSettings.

[только для чтения] title : строка

Заголовок текущей отображаемой HTML-страницы. Это значение только для чтения, отражающее содержимое тега <title>.

url : url

Расположение текущей отображаемой HTML-страницы. Это изменяемое свойство предоставляет основной интерфейс для загрузки страницы в веб-представление. Оно работает так же, как свойство window.location DOM.

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

[только для чтения] userScripts : список<WebEngineScript>

Список объектов скриптов, присоединённых к представлению.

Это свойство было добавлено в QtWebEngine 1.1.

См. также WebEngineScript.

webChannel : QQmlWebChannel

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

Примечание: Представление не берёт на себя ответственность за назначенный объект webChannel.

Это свойство было добавлено в QtWebEngine 1.1.

webChannelWorld : int

JavaScript-мир, в котором установлен экземпляр канала web-channel, используемый этим представлением. Мир должен быть числом от 0 до 256.

Это свойство было добавлено в QtWebEngine 1.3.

zoomFactor : вещественный

Коэффициент масштабирования для представления. Допустимые значения находятся в диапазоне от 0.25 до 5.0. Значение по умолчанию — 1.0.

Это свойство было добавлено в QtWebEngine 1.1.

Документация сигналов

activeFocusOnPressChanged(activeFocusOnPress)

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

Этот сигнал был добавлен в QtWebEngine 1.2.

См. также activeFocusOnPress и setActiveFocusOnPress().

audioMutedChanged(muted)

Этот сигнал испускается при изменении значения muted. Значение задаётся с помощью свойства audioMuted.

Примечание: Не следует путать с конкретным HTML5 элементом audio/video, который заглушён.

Этот сигнал был добавлен в QtWebEngine 1.3.

См. также audioMuted и recentlyAudibleChanged.

authenticationDialogRequested(request)

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

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

Примечание: Обработчики сигналов должны вызывать request.accepted = true, чтобы предотвратить отображение диалога по умолчанию. Не забудьте после этого вызвать либо AuthenticationDialogRequest::dialogAccept(), либо AuthenticationDialogRequest::dialogReject().

Этот сигнал был введён в QtWebEngine 1.4.

backgroundColorChanged()

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

Этот сигнал был введён в QtWebEngine 1.2.

certificateError(error)

Этот сигнал излучается при возникновении ошибки недопустимого сертификата error при загрузке заданного запроса.

Обработка ошибки сертификата может выполняться с помощью методов типа WebEngineCertificateError.

Этот сигнал был введён в QtWebEngine 1.1.

colorDialogRequested(request)

Этот сигнал излучается при запросе диалога выбора цвета.

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

Примечание: Обработчики сигналов должны вызывать request.accepted = true, чтобы предотвратить отображение диалога по умолчанию. Не забудьте после этого вызвать либо ColorDialogRequest::dialogAccept(), либо ColorDialogRequest::dialogReject().

Этот сигнал был введён в QtWebEngine 1.4.

contextMenuRequested(request)

Этот сигнал излучается при запросе контекстного меню.

Обработка запроса может выполняться с помощью свойств типа ContextMenuRequest.

Примечание: Обработчики сигналов должны вызывать request.accepted = true, чтобы предотвратить отображение контекстного меню по умолчанию.

Этот сигнал был введён в QtWebEngine 1.4.

featurePermissionRequested(securityOrigin, Feature feature)

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

Этот сигнал был введён в QtWebEngine 1.1.

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

fileDialogRequested(request)

Этот сигнал излучается при запросе диалога выбора файла.

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

Примечание: Обработчики сигналов должны вызывать request.accepted = true, чтобы предотвратить отображение диалога по умолчанию. Не забудьте после этого вызвать либо FileDialogRequest::dialogAccept(), либо FileDialogRequest::dialogReject().

Этот сигнал был введён в QtWebEngine 1.4.

findTextFinished(result)

Этот сигнал излучается по завершении поиска строки на странице. result — результат поиска строки.

Этот сигнал был введён в QtWebEngine 1.10.

См. также findText() и FindTextResult.

fullScreenRequested(request)

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

Этот сигнал был введён в QtWebEngine 1.1.

См. также isFullScreen.

geometryChangeRequested(geometry, rect frameGeometry)

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

В то время как frameGeometry включает размеры рамки, geometry не включает размеры отступов рамки.

Примечание: Свойства QML Window, связанные с геометрией, ожидают размера, исключая элементы оформления окна. Вы должны использовать geometry для корректной обработки этого сигнала.

onGeometryChangeRequested: {
    window.x = geometry.x
    window.y = geometry.y
    window.width = geometry.width
    window.height = geometry.height
}

Этот сигнал был введён в QtWebEngine 1.7.

javaScriptConsoleMessage(level, string message, int lineNumber, string sourceID)

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

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

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

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

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

javaScriptDialogRequested(request)

Этот сигнал излучается при запросе JavaScript-диалога.

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

Примечание: Обработчики сигналов должны вызывать request.accepted = true, чтобы предотвратить отображение диалога по умолчанию. Не забудьте после этого вызвать либо JavaScriptDialogRequest::dialogAccept(), либо JavaScriptDialogRequest::dialogReject().

Этот сигнал был введён в QtWebEngine 1.4.

linkHovered(hoveredUrl)

В интерфейсе, управляемом мышью, этот сигнал излучается при прохождении указателя мыши над ссылкой, что соответствует событию DOM mouseover. Это событие также может произойти в интерфейсах с сенсорным управлением для событий mouseover, которые не отменяются с помощью preventDefault(). hoveredUrl предоставляет расположение ссылки.

loadingChanged(loadRequest)

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

При обработке сигнала с onLoadingChanged доступны различные параметры для чтения в WebEngineLoadRequest, указанном loadRequest.

См. также loading, LoadStatus и ErrorDomain.

navigationRequested(request)

Этот сигнал излучается при вызове запроса на навигацию request.

newViewRequested(request)

Этот сигнал излучается, когда request инициирует загрузку страницы в отдельном представлении веб-движка. Это может произойти, либо потому что текущая страница явно запросила это через вызов JavaScript window.open, либо потому что пользователь щелкнул ссылку, удерживая клавиши Shift, Ctrl или встроенную комбинацию, которая вызывает открытие страницы в новом окне.

Если этот сигнал не обработан, запрошенная загрузка завершится неудачей.

Пример реализации:

QtObject {
    id: windowParent
    // Create the initial browsing windows and open the startup page.
    Component.onCompleted: {
        var firstWindow = windowComponent.createObject(windowParent);
        firstWindow.webView.loadHtml('<input type="button" value="Click!" onclick="window.open(&quot;http://qt.io&quot;)">');
    }

    property Component windowComponent: Window {
        // Destroy on close to release the Window's QML resources.
        // Because it was created with a parent, it won't be garbage-collected.
        onClosing: destroy()
        visible: true

        property WebEngineView webView: webView_
        WebEngineView {
            id: webView_
            anchors.fill: parent

            // Handle the signal. Dynamically create the window and
            // use its WebEngineView as the destination of our request.
            onNewViewRequested: function(request) {
                var newWindow = windowComponent.createObject(windowParent);
                request.openIn(newWindow.webView);
            }
        }
    }
}

Этот сигнал был введён в QtWebEngine 1.1.

См. также NewViewDestination и WebEngine Quick Nano Browser.

pdfPrintingFinished(filePath, bool success)

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

Этот сигнал был введён в QtWebEngine 1.5.

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

printRequest()

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

Этот сигнал был введён в QtWebEngine 1.8.

См. также printToPdf.

quotaRequested(request)

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

Этот сигнал был введён в QtWebEngine 1.7.

См. также QuotaRequest.

recentlyAudibleChanged(recentlyAudible)

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

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

Этот сигнал также излучается для звука Flash-плагина.

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

Могут также возникать ложные срабатывания сигнала. Например, когда звук останавливается, этот сигнал генерируется сначала со значением true, а затем со значением false. Кроме того, при запуске воспроизведения звука сигнал генерируется дважды со значением true.

Этот сигнал был введен в QtWebEngine 1.3.

См. также recentlyAudible.

registerProtocolHandlerRequested(request)

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

Этот сигнал был введен в QtWebEngine 1.7.

См. также RegisterProtocolHandlerRequest.

renderProcessTerminated(terminationStatus, int exitCode)

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

Этот сигнал был введен в QtWebEngine 1.2.

См. также RenderProcessTerminationStatus.

selectClientCertificate(clientCertificateSelection)

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

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

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

Этот сигнал был введен в QtWebEngine 1.9.

См. также WebEngineClientCertificateSelection.

tooltipRequested(request)

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

Примечание: Обработчики сигнала должны вызвать request.accepted = true, чтобы предотвратить отображение всплывающей подсказки по умолчанию.

Этот сигнал был введен в QtWebEngine 1.10.

См. также TooltipRequest.

wasRecentlyAudibleChanged(wasRecentlyAudible)

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

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

Этот сигнал был введен в QtWebEngine 1.3.

windowCloseRequested()

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

Этот сигнал был введен в QtWebEngine 1.2.

Документация по методам

WebEngineAction action(action)

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

var copyAction = webEngineView.action(WebEngineView.Copy);

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

См. также WebEngineAction.

void findText(subString, FindFlags options, variant resultCallback)

Ищет указанную строку subString на странице с использованием заданных options. Сигнал findTextFinished() генерируется при завершении поиска строки.

Чтобы очистить выделение поиска, просто передайте пустую строку.

resultCallback должен принимать целое число в качестве параметра. Он будет вызван с количеством найденных вхождений subString.

findText("Qt", WebEngineView.FindCaseSensitively, function(matchCount) {
    if (matchCount > 0)
        console.log("'Qt' tokens found:", matchCount);
});

Этот метод был введен в QtWebEngine 1.1.

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

void findText(subString, FindFlags options)

Ищет указанную строку subString на странице с использованием заданных options. Сигнал findTextFinished() генерируется при завершении поиска строки.

Чтобы очистить выделение поиска, просто передайте пустую строку.

findText("Qt", WebEngineView.FindBackward | WebEngineView.FindCaseSensitively);

Этот метод был введен в QtWebEngine 1.1.

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

void findText(subString)

Ищет указанную строку subString на странице. Сигнал findTextFinished() генерируется при завершении поиска строки.

Чтобы очистить выделение поиска, просто передайте пустую строку.

Этот метод был введен в QtWebEngine 1.1.

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

void fullScreenCancelled()

Немедленно устанавливает свойство isFullScreen в значение false. Может использоваться для уведомления движка браузера, когда системное окно вынуждает приложение выйти из полноэкранного режима.

ApplicationWindow {
    onVisibilityChanged: {
        if (webEngineView.isFullScreen && visibility != Window.FullScreen)
            webEngineView.fullScreenCancelled()
    }

    WebEngineView {
        id: webEngineView
        // ...
    }
}

Этот метод был введен в QtWebEngine 1.1.

См. также isFullScreen и fullScreenRequested().

void goBack()

Перейти назад в истории сеанса браузера, если это возможно. Эта функция эквивалентна методу DOM window.history.back().

См. также canGoBack.

void goBackOrForward(offset)

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

Этот метод был введен в QtWebEngine 1.1.

См. также goBack() и goForward().

void goForward()

Перейти вперёд в истории сеанса браузера, если это возможно. Эта функция эквивалентна методу DOM window.history.forward().

void grantFeaturePermission(securityOrigin, Feature feature, bool granted)

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

Этот метод был введен в QtWebEngine 1.1.

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

void loadHtml(html, url baseUrl)

Загружает указанный html как содержимое веб-представления.

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

Внешние объекты, такие как таблицы стилей или изображения, на которые ссылается HTML-документ, должны находиться относительно baseUrl. Для загрузки внешних объектов baseUrl не может быть пустым. Например, если html получен из http://www.example.com/documents/overview.html, которое является базовым URL, то изображение, на которое ссылается относительный URL diagram.png, должно быть по адресу http://www.example.com/documents/diagram.png.

См. также url.

void printToPdf(resultCallback, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)

Печатает текущее содержимое WebEngineView в PDF-документ и возвращает его в виде массива байтов. Размер документа будет определяться значением pageSizeId, а его ориентация — значением orientation.

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

Если вы опустите pageSizeId, он будет по умолчанию A4. Если вы опустите orientation, он будет по умолчанию Portrait.

Этот метод был введен в QtWebEngine 1.3.

void printToPdf(const string filePath, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)

Печатает текущее содержимое WebEngineView в документ PDF и сохраняет его по пути filePath. Размер документа определяется значением pageSizeId, а ориентация — значением orientation.

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

Если pageSizeId не указан, используется значение по умолчанию A4. Если orientation не указан, используется значение по умолчанию Portrait.

Этот метод был введён в QtWebEngine 1.3.

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

void reload()

Перезагружает текущую страницу. Эта функция эквивалентна методу window.location.reload() DOM.

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

void reloadAndBypassCache()

Перезагружает текущую страницу, игнорируя кэшированное содержимое.

Этот метод был введён в QtWebEngine 1.1.

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

void replaceMisspelledWord(const QString &replacement)

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

Этот метод был введён в QtWebEngine 1.3.

void runJavaScript(script, variant callback)

Выполняет указанный script в содержимом веб-представления.

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

runJavaScript("document.title", function(result) { console.log(result); });

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

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

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

Дополнительную информацию об инъекции скриптов см. в Инъекция скриптов. Альтернативный способ инъекции скриптов см. в WebEngineView::userScripts.

void setActiveFocusOnPress(arg)

Устанавливает активный фокус на нажатие в веб-представлении, если arg равно true. Установив его в значение false, веб-представление можно использовать для создания элемента пользовательского интерфейса, который не должен получать фокус. Это может быть полезно в гибридном пользовательском интерфейсе.

Этот метод был введён в QtWebEngine 1.2.

См. также activeFocusOnPress, activeFocusOnPressChanged и WebEngineSettings::focusOnNavigationEnabled.

void stop()

Останавливает загрузку текущей страницы.

void triggerWebAction(action)

Вызывает веб-действие action.

Этот метод был введён в QtWebEngine 1.2.

См. также WebAction.