Тип QML WebEngineView

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

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

Свойства

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

Сигналы

• activeFocusOnPressChanged(bool activeFocusOnPress)
• audioMutedChanged(bool muted)
• authenticationDialogRequested(AuthenticationDialogRequest request)
• backgroundColorChanged()
• certificateError(WebEngineCertificateError error)
• colorDialogRequested(ColorDialogRequest request)
• contextMenuRequested(ContextMenuRequest request)
• featurePermissionRequested(url securityOrigin, Feature feature)
• fileDialogRequested(FileDialogRequest request)
• findTextFinished(FindTextResult result)
• fullScreenRequested(FullScreenRequest request)
• geometryChangeRequested(rect geometry, rect frameGeometry)
• javaScriptConsoleMessage(JavaScriptConsoleMessageLevel level, string message, int lineNumber, string sourceID)
• javaScriptDialogRequested(JavaScriptDialogRequest request)
• linkHovered(url hoveredUrl)
• loadingChanged(WebEngineLoadingInfo loadingInfo)
• navigationRequested(WebEngineNavigationRequest request)
• newWindowRequested(WebEngineNewWindowRequest request)
• pdfPrintingFinished(string filePath, bool success)
• printRequest()
• quotaRequested(QuotaRequest request)
• recentlyAudibleChanged(bool recentlyAudible)
• registerProtocolHandlerRequested(RegisterProtocolHandlerRequest request)
• renderProcessPidChanged(qint64 pid)
• renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode)
• selectClientCertificate(WebEngineClientCertificateSelection clientCertificateSelection)
• tooltipRequested(TooltipRequest request)
• wasRecentlyAudibleChanged(bool wasRecentlyAudible)
• windowCloseRequested()

Методы

• void acceptAsNewWindow(QWebEngineNewWindowRequest *request)
• WebEngineAction action(WebAction action)
• void findText(string subString, FindFlags options, variant resultCallback)
• void findText(string subString, FindFlags options)
• void findText(string subString)
• void fullScreenCancelled()
• void goBack()
• void goBackOrForward(int offset)
• void goForward()
• void grantFeaturePermission(url securityOrigin, Feature feature, bool granted)
• void loadHtml(string html, url baseUrl)
• void printToPdf(variant 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(string script, variant callback)
• void setActiveFocusOnPress(bool arg)
• void stop()
• void triggerWebAction(WebAction action)

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

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

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

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

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

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

    return app.exec();
}

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

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

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

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

import QtQuick
import QtQuick.Window
import QtWebEngine

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, но веб-сайты могут запросить их открытие в новой вкладке, окне или диалоговом окне. Сигнал newWindowRequested() генерируется при запросе загрузки страницы в отдельном представлении веб-движка. Свойство NewViewDestination описывает, как должно быть открыто новое представление. Кроме того, можно использовать утилиту WebEngineNewWindowRequest для загрузки веб-страниц в отдельные представления веб-движка.

Метод 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. Если пользователи предоставят разрешение, для установки значения granted используется метод grantFeaturePermission().

Отображение на поверхности OpenGL

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

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

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

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

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

Функция : перечисление

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

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

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

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

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

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

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

[since QtWebEngine 1.10] СостояниеЖизненногоЦикла : перечисление

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

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

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

СостояниеЗагрузки : перечисление

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

[since QtWebEngine 1.3] ОриентацияПечатнойСтраницы : перечисление

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

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

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

[since QtWebEngine 1.3] ИдентификаторРазмераПечатнойСтраницы : перечисление

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

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

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

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

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

[с QtWebEngine 1.2] RenderProcessTerminationStatus : перечисление

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

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

[с QtWebEngine 1.2] WebAction : перечисление

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

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

[с QtWebEngine 1.2] activeFocusOnPress : bool

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

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

[с QtWebEngine 1.3] audioMuted : bool

Состояние, в котором звук текущей страницы выключен.

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

См. также recentlyAudible.

[с QtWebEngine 1.2] backgroundColor : цвет

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

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

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

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

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

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

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

[с QtWebEngine 1.3] contentsSize : size

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

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

[с QtWebEngine 1.7] devToolsView : WebEngineView

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

Этот параметр был введен в QtWebEngine 1.7.

См. также inspectedView.

[только чтение, с QtWebEngine 1.1] history : WebEngineHistory

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

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

См. также WebEngineHistory.

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

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

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

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

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

[с QtWebEngine 1.7] inspectedView : WebEngineView

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

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

Этот параметр был введен в QtWebEngine 1.7.

См. также devToolsView.

[только чтение, с QtWebEngine 1.1] isFullScreen : bool

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

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

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

[с QtWebEngine 1.10] 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.

[с QtWebEngine 1.1] profile : WebEngineProfile

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

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

См. также WebEngineProfile.

[только чтение, с QtWebEngine 1.3] recentlyAudible : bool

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

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

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

[с QtWebEngine 1.10] recommendedState : LifecycleState

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

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

Этот параметр был введен в QtWebEngine 1.10.

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

[только чтение, с QtWebEngine 1.11] renderProcessPid : qint64

Возвращает идентификатор процесса (PID) процесса отрисовки, назначенного главному фрейму текущей страницы.

Если процесс отрисовки еще не доступен, возвращается 0.

Этот параметр был введен в QtWebEngine 1.11.

См. также renderProcessPidChanged.

[с QtWebEngine 1.3] scrollPosition : point

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

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

[только чтение, с QtWebEngine 1.1] settings : WebEngineSettings

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

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

См. также WebEngineSettings.

[только чтение] title : string

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

url : url

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

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

[только чтение, с QtWebEngine 1.1] userScripts : list<WebEngineScript>

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

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

[с QtWebEngine 1.1] webChannel : QQmlWebChannel

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

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

[с QtWebEngine 1.3] webChannelWorld : int

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

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

[с QtWebEngine 1.1] zoomFactor : real

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

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

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

[since QtWebEngine 1.2] activeFocusOnPressChanged(bool activeFocusOnPress)

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

Примечание: Соответствующий обработчик — onActiveFocusOnPressChanged.

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

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

[since QtWebEngine 1.3] audioMutedChanged(bool muted)

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

Примечание: Соответствующий обработчик — onAudioMutedChanged.

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

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

[since QtWebEngine 1.4] authenticationDialogRequested(AuthenticationDialogRequest request)

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

request можно обработать, используя методы типа AuthenticationDialogRequest.

Примечание: Соответствующий обработчик — onAuthenticationDialogRequested.

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

[since QtWebEngine 1.2] backgroundColorChanged()

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

Примечание: Соответствующий обработчик — onBackgroundColorChanged.

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

[since QtWebEngine 1.1] certificateError(WebEngineCertificateError error)

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

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

Примечание: Соответствующий обработчик — onCertificateError.

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

[since QtWebEngine 1.4] colorDialogRequested(ColorDialogRequest request)

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

request можно обработать, используя методы типа ColorDialogRequest.

Примечание: Соответствующий обработчик — onColorDialogRequested.

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

[since QtWebEngine 1.4] contextMenuRequested(ContextMenuRequest request)

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

request можно обработать, используя свойства типа ContextMenuRequest.

Примечание: Соответствующий обработчик — onContextMenuRequested.

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

[since QtWebEngine 1.1] featurePermissionRequested(url securityOrigin, Feature feature)

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

Примечание: Соответствующий обработчик — onFeaturePermissionRequested.

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

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

[since QtWebEngine 1.4] fileDialogRequested(FileDialogRequest request)

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

request можно обработать, используя методы типа FileDialogRequest.

Примечание: Соответствующий обработчик — onFileDialogRequested.

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

[since QtWebEngine 1.10] findTextFinished(FindTextResult result)

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

Примечание: Соответствующий обработчик — onFindTextFinished.

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

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

[since QtWebEngine 1.1] fullScreenRequested(FullScreenRequest request)

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

Примечание: Соответствующий обработчик — onFullScreenRequested.

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

См. также isFullScreen.

[since QtWebEngine 1.7] geometryChangeRequested(rect geometry, rect frameGeometry)

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

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

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

Примечание: Соответствующий обработчик — onGeometryChangeRequested.

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

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

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

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

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

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

Примечание: Соответствующий обработчик — onJavaScriptConsoleMessage.

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

[since QtWebEngine 1.4] javaScriptDialogRequested(JavaScriptDialogRequest request)

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

request можно обработать, используя методы типа JavaScriptDialogRequest.

Примечание: Соответствующий обработчик — onJavaScriptDialogRequested.

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

linkHovered(url hoveredUrl)

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

Примечание: Соответствующий обработчик — onLinkHovered.

loadingChanged(WebEngineLoadingInfo loadingInfo)

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

При обработке сигнала с помощью onLoadingChanged, доступны различные параметры только для чтения в WebEngineLoadingInfo, указанном в loadingInfo.

Примечание: Соответствующий обработчик — onLoadingChanged.

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

navigationRequested(WebEngineNavigationRequest request)

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

Примечание: Соответствующий обработчик — onNavigationRequested.

[since QtWebEngine 2.0] newWindowRequested(WebEngineNewWindowRequest request)

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

Обработчик сигнала вызывает acceptAsNewWindow() в целевом представлении. Если этот сигнал не обрабатывается, запрошенная загрузка завершится ошибкой.

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

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.
            onNewWindowRequested: function(request) {
                var newWindow = windowComponent.createObject(windowParent);
                newWindow.webView.acceptAsNewWindow(request);
            }
        }
    }
}

Примечание: Соответствующий обработчик — onNewWindowRequested.

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

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

[since QtWebEngine 1.5] pdfPrintingFinished(string filePath, bool success)

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

Примечание: Соответствующий обработчик — onPdfPrintingFinished.

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

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

[since QtWebEngine 1.8] printRequest()

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

Примечание: Соответствующий обработчик — onPrintRequest.

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

См. также printToPdf.

[since QtWebEngine 1.7] quotaRequested(QuotaRequest request)

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

Примечание: Соответствующий обработчик — onQuotaRequested.

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

См. также QuotaRequest.

[since QtWebEngine 1.3] recentlyAudibleChanged(bool recentlyAudible)

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

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

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

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

Примечание: Соответствующий обработчик — onRecentlyAudibleChanged.

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

См. также recentlyAudible.

[since QtWebEngine 1.7] registerProtocolHandlerRequested(RegisterProtocolHandlerRequest request)

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

Примечание: Соответствующий обработчик — onRegisterProtocolHandlerRequested.

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

См. также RegisterProtocolHandlerRequest.

[since QtWebEngine 1.11] renderProcessPidChanged(qint64 pid)

Если процесс отрисовки ещё недоступен, возвращается 0. Этот сигнал испускается, когда идентификатор процесса (pid) подлежащего процессу отрисовки страницы изменился.

Примечание: Соответствующий обработчик — onRenderProcessPidChanged.

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

См. также renderProcessPid.

[since QtWebEngine 1.2] renderProcessTerminated(RenderProcessTerminationStatus terminationStatus, int exitCode)

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

Примечание: Соответствующий обработчик — onRenderProcessTerminated.

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

См. также RenderProcessTerminationStatus.

[since QtWebEngine 1.9] selectClientCertificate(WebEngineClientCertificateSelection clientCertificateSelection)

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

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

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

Примечание: Соответствующий обработчик — onSelectClientCertificate.

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

См. также WebEngineClientCertificateSelection.

[since QtWebEngine 1.10] tooltipRequested(TooltipRequest request)

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

Примечание: Соответствующий обработчик — onTooltipRequested.

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

См. также TooltipRequest.

[since QtWebEngine 1.3] wasRecentlyAudibleChanged(bool wasRecentlyAudible)

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

Примечание: Соответствующий обработчик — onWasRecentlyAudibleChanged.

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

[since QtWebEngine 1.2] windowCloseRequested()

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

Примечание: Соответствующий обработчик — onWindowCloseRequested.

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

Методы

[since QtWebEngine 2.0] void acceptAsNewWindow(QWebEngineNewWindowRequest *request)

Обрабатывает сигнал newWindowRequested, открывая request в этом представлении.

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

См. также newWindowRequested.

[since 5.12] WebEngineAction action(WebAction action)

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

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

Этот метод был представлен в Qt 5.12.

См. также WebEngineAction.

[since QtWebEngine 1.1] void findText(string 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().

[since QtWebEngine 1.1] void findText(string subString, FindFlags options)

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

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

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

Этот метод был представлен в QtWebEngine 1.1.

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

[since QtWebEngine 1.1] void findText(string subString)

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

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

Этот метод был представлен в QtWebEngine 1.1.

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

[since QtWebEngine 1.1] void fullScreenCancelled()

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

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

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

Этот метод был представлен в QtWebEngine 1.1.

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

void goBack()

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

См. также canGoBack.

[since QtWebEngine 1.1] void goBackOrForward(int offset)

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

Этот метод был представлен в QtWebEngine 1.1.

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

void goForward()

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

[since QtWebEngine 1.1] void grantFeaturePermission(url securityOrigin, Feature feature, bool granted)

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

Этот метод был представлен в QtWebEngine 1.1.

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

void loadHtml(string 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.

[since QtWebEngine 1.3] void printToPdf(variant resultCallback, PrintedPageSizeId pageSizeId, PrintedPageOrientation orientation)

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

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

Если pageSizeId опущен, он по умолчанию равен A4. Если orientation опущен, он по умолчанию равен Portrait.

Этот метод был представлен в QtWebEngine 1.3.

[since 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().

[since QtWebEngine 1.1] void reloadAndBypassCache()

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

Этот метод был представлен в QtWebEngine 1.1.

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

[since QtWebEngine 1.3] void replaceMisspelledWord(const QString &replacement)

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

Этот метод был представлен в QtWebEngine 1.3.

void runJavaScript(string script, variant callback)

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

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

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

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

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

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

[since QtWebEngine 1.2] void setActiveFocusOnPress(bool arg)

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

Этот метод был представлен в QtWebEngine 1.2.

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

void stop()

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

[since QtWebEngine 1.2] void triggerWebAction(WebAction action)

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

Этот метод был представлен в QtWebEngine 1.2.

См. также WebAction.