Класс QQuickWebEngineScript
Позволяет встраивать скрипты в движок JavaScript. Подробнее...
| Заголовок: | #include <QQuickWebEngineScript> |
| С момента: | Qt 5.9 |
| Инициализируется: | WebEngineScript |
| Наследует: | QObject |
Публичные типы
| перечисление | InjectionPoint { Создание документа, Документ готов, Отложенно } |
| перечисление | ScriptWorldId { Основной мир, Прикладной мир, Пользовательский мир } |
Свойства
|
|
- 1 свойство унаследовано от QObject
Публичные функции
| QQuickWebEngineScript(QObject *parent = Q_NULLPTR) | |
| InjectionPoint | injectionPoint() const |
| QString | name() const |
| bool | runOnSubframes() const |
| void | setInjectionPoint(InjectionPoint injectionPoint) |
| void | setName(const QString &name) |
| void | setRunOnSubframes(bool on) |
| void | setSourceCode(const QString &code) |
| void | setSourceUrl(const QUrl &url) |
| void | setWorldId(ScriptWorldId scriptWorldId) |
| QString | sourceCode() const |
| QUrl | sourceUrl() const |
| QString | toString() const |
| ScriptWorldId | worldId() const |
- 32 публичных функции унаследованы от QObject
Сигналы
| void | injectionPointChanged(InjectionPoint injectionPoint) |
| void | nameChanged(const QString &name) |
| void | runOnSubframesChanged(bool on) |
| void | sourceCodeChanged(const QString &code) |
| void | sourceUrlChanged(const QUrl &url) |
| void | worldIdChanged(ScriptWorldId scriptWorldId) |
- 2 сигнала унаследованы от QObject
Дополнительные унаследованные члены
- 1 публичный слот унаследован от QObject
- 11 статических публичных членов унаследованы от QObject
- 9 защищенных функций унаследованы от QObject
Подробное описание
Позволяет встраивать скрипты в движок JavaScript.
Тип QQuickWebEngineScript позволяет программно встраивать так называемые пользовательские скрипты в движок JavaScript в разные моменты, определяемые свойством injectionPoint, во время загрузки веб-контента.
Скрипты могут выполняться либо в основном мире JavaScript, вместе со всем JavaScript, поступающим из веб-контента, либо в своём изолированном мире. Хотя к DOM страницы можно получить доступ из любого мира, переменные JavaScript функции, определённой в одном мире, недоступны из другого. Свойство worldId предоставляет некоторые предопределённые идентификаторы для этой цели.
Документация по типам членов
перечисление QQuickWebEngineScript::InjectionPoint
Точка в процессе загрузки, в которой выполняется скрипт.
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineScript::DocumentCreation |
2 |
Скрипт будет выполнен сразу после создания документа. Это не подходит для любых операций с DOM. |
QQuickWebEngineScript::DocumentReady |
1 |
Скрипт выполнится, как только DOM будет готов. Это эквивалентно срабатыванию события DOMContentLoaded в JavaScript. |
QQuickWebEngineScript::Deferred |
0 |
Скрипт выполнится по завершении загрузки страницы или через 500 мс после готовности документа, что произойдёт раньше. |
перечисление QQuickWebEngineScript::ScriptWorldId
Идентификатор мира, определяющий, в каком изолированном мире выполняется скрипт.
| Константа | Значение | Описание |
|---|---|---|
QQuickWebEngineScript::MainWorld |
0 |
Мир, используемый веб-контентом страницы. Он может быть полезен для того, чтобы предоставить пользовательскую функциональность веб-контенту в определенных сценариях. |
QQuickWebEngineScript::ApplicationWorld |
1 |
Умолчательный изолированный мир, используемый для функциональности приложения, реализованной в JavaScript. |
QQuickWebEngineScript::UserWorld |
2 |
Первый изолированный мир, используемый скриптами, заданными пользователями, если приложение не использует больше миров. Как правило, если эта функциональность предоставляется пользователям приложения, каждый отдельный скрипт, вероятно, должен иметь свой собственный изолированный мир. |
Документация свойств
injectionPoint : InjectionPoint
Это свойство хранит точку в процессе загрузки, в которой будет выполняться скрипт.
Значение по умолчанию — Deferred.
Функции доступа:
| InjectionPoint | injectionPoint() const |
| void | setInjectionPoint(InjectionPoint injectionPoint) |
Сигнал уведомления:
| void | injectionPointChanged(InjectionPoint injectionPoint) |
name : QString
Это свойство содержит имя скрипта.
Может быть полезно для получения определённого скрипта из QQuickWebEngineProfile::userScripts.
Функции доступа:
| QString | name() const |
| void | setName(const QString &name) |
Сигнал уведомления:
| void | nameChanged(const QString &name) |
runOnSubframes : bool
Это свойство указывает, выполняется ли скрипт на каждом фрейме или только на главном фрейме.
Установите это свойство в true если скрипт выполняется на каждом фрейме страницы или в false если он выполняется только для главного фрейма. Значение по умолчанию — false.
Функции доступа:
| bool | runOnSubframes() const |
| void | setRunOnSubframes(bool on) |
Сигнал уведомления:
| void | runOnSubframesChanged(bool on) |
sourceCode : QString
Это свойство хранит исходный JavaScript-код пользовательского скрипта.
Функции доступа:
| QString | sourceCode() const |
| void | setSourceCode(const QString &code) |
Сигнал уведомления:
| void | sourceCodeChanged(const QString &code) |
См. также QQuickWebEngineScript::sourceUrl.
sourceUrl : QUrl
Это свойство хранит удалённое местоположение исходного кода пользовательского скрипта (если таковое имеется).
В отличие от sourceCode, это свойство позволяет ссылаться на пользовательские скрипты, которые ещё не загружены в память, например, хранящиеся на диске.
Установка этого свойства изменит sourceCode скрипта.
Примечание: В настоящее время поддерживаются только источники на основе файлов.
Функции доступа:
| QUrl | sourceUrl() const |
| void | setSourceUrl(const QUrl &url) |
Сигнал уведомления:
| void | sourceUrlChanged(const QUrl &url) |
См. также QQuickWebEngineScript::sourceCode.
worldId : ScriptWorldId
Это свойство хранит идентификатор мира, определяющий, в каком изолированном мире выполняется скрипт.
Функции доступа:
| ScriptWorldId | worldId() const |
| void | setWorldId(ScriptWorldId scriptWorldId) |
Сигнал уведомления:
| void | worldIdChanged(ScriptWorldId scriptWorldId) |
Документация функций-членов
QQuickWebEngineScript::QQuickWebEngineScript(QObject *parent = Q_NULLPTR)
Создаёт новый QQuickWebEngineScript с родителем parent.
QString QQuickWebEngineScript::toString() const
Возвращает объект скрипта в виде строки.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.9/qquickwebenginescript.html
