WebViewItem
Представляет экземпляр WebView, который отображает веб-страницы. Подробнее…
Подключение: | #include <webviewitem.h> |
Диаграмма наследования для Aurora::WebView::WebViewItem:
Сигналы
void | urlChanged (QString url) Сигнал о смене URL-адреса. Подробнее... |
void | titleChanged (QString title) Сигнал о смене заголовка. Подробнее... |
void | loadingChanged (bool status) Сигнал об изменении состояния загрузки. Подробнее... |
void | loadingProgressChanged (double progress) Испускается при изменении хода загрузки. Подробнее... |
void | loadStart () Сигнал о начале загрузки основного кадра. |
void | documentAvailable () Сигнал о доступности основного фрейма документа. |
void | loadFinished (int httpStatusCode) Сигнал о завершении загрузки. Подробнее... |
void | loadError (QString url, int errorCode) Сигнал об ошибке загрузки. Подробнее... |
void | recvAsyncMessage (const QString name, const QVariant data) Сигнал о получении асинхронного сообщения от кода JavaScript. Подробнее... |
void | userAgentChanged () Сигнал об изменении User-Agent. |
void | formFactorChanged () Сигнал об изменении форм-фактора устройства. |
void | userAgentOverrideChanged () Сигнал об изменении режима переопределения User-Agent. |
void | findResultAvailable (int identifier, int count, QRect selectionRect, int activeMatchOrdinal, bool finalUpdate) Посылает сигнал, сообщающий о результатах поиска. Подробнее... |
void | scrollOffsetXChanged () Испускается при изменении смещения прокрутки по оси X. |
void | scrollOffsetYChanged () Испускается при изменении смещения прокрутки по оси Y. |
void | fullscreenModeChanged (bool fullscreen) Испускается при активации или деактивации полноэкранного режима. Подробнее… |
Публичные функции-члены
WebViewItem (QQuickItem *parent=Q_NULLPTR, bool isPrivate=false) Экземпляр будет функционален только после инициализации WebEngineContext. |
|
Q_INVOKABLE void | reload () Перезагружает открытый URL. |
Q_INVOKABLE void | stopLoad () Останавливает загрузку URL, если загрузка идёт. |
Q_INVOKABLE void | startRender () Продолжает рендеринг. |
Q_INVOKABLE void | stopRender () Приостаналивает рендеринг (изображение станет неподвижным, использование ресурсов устройства уменьшится). |
Q_INVOKABLE void | find (const QString &text, bool forward, bool matchCase, bool findNext) Ищет текст на веб-странице. Подробнее... |
Q_INVOKABLE void | stopFinding (bool clearSelection) Отменяет все активные в данный момент поиски. Подробнее... |
int | id () const Уникальный идентификатор. |
QString | url () const URL-адрес загруженного в данный момент. |
void | setUrl (const QString &url) Сеттер свойств URL. |
QString | title () const Текущий заголовок загруженной веб-страницы. |
bool | loading () const Проверяет, загружает ли экземпляр WebView веб-страницу. |
double | loadingProgress () const Текущий прогресс загрузки, диапазон от 0,0 до 1,0. |
QString | userAgent () const Пользовательский агент. |
void | setUserAgent (const QString &userAgent) |
qreal | DPR () const Коэффициент пикселей устройства. |
void | setDPR (qreal DRP) Устанавливает DPR. Нужно перезагрузить, чтобы применить новое значение. |
QRect | renderRect () const Область для отображения контента. |
void | setRenderRect (QRect renderRect) Область для отображения контента. |
double | scrollOffsetX () const Текущее смещение прокрутки по оси X. |
double | scrollOffsetY () const Текущее смещение прокрутки по оси Y. |
int | formFactor () const Форм-фактор устройства. |
void | setFormFactor (int mode) Устанавливает форм-фактор устройства. |
bool | userAgentOverride () const Режим переопределения User-Agent. |
Q_INVOKABLE void | setInsets (int top, int right, int bottom, int left) |
Q_INVOKABLE void | loadHtml (const QString &html) Загружает необработанный HTML-текст. |
Q_INVOKABLE void | clearTextSelection () Очищает выделение текста. |
Q_INVOKABLE void | runJavaScript (const QString &script, const QJSValue &callback, const QJSValue &errorCallback) |
Q_INVOKABLE void | sendAsyncMessage (const QString &name, const QVariant &data) |
Q_INVOKABLE void | addMessageListener (const QString &name) Регистрирует прослушиватель асинхронных сообщений с указанным name. |
Q_INVOKABLE void | exitFullscreenMode () Выходит из полноэкранного режима. |
Свойства
int | id Уникальный идентификатор текущего устройства. |
QString | url |
QString | title Заголовок загруженного URL (веб-страницы). Может быть пустым. |
bool | loading Возвращает true, когда экземпляр WebViewItem загружает URL. |
double | loadingProgress Текущий прогресс загрузки, диапазон от 0,0 до 1,0. |
QString | userAgent |
qreal | dpr Коэффициент пикселей устройства. |
QRect | renderRect Область для отображения контента. |
double | scrollOffsetX Текущее значение смещения прокрутки только для чтения по оси x. |
double | scrollOffsetY Текущее значение смещения прокрутки только для чтения по оси y. |
int | formFactor |
bool | userAgentOverride |
Подробное описание
Представляет экземпляр WebView, который отображает веб-страницы.
WebViewItem — это основной класс библиотеки WebView. Он отображает веб-страницы и предоставляет для них механизмы взаимодействия.
Можно создать несколько WebViewItem для одновременной визуализации различных веб-страниц.
Например, вкладки веб-браузера могут быть реализованы как отдельные экземпляры WebViewItem.
Описание функций-членов
find()
Q_INVOKABLE void Aurora::WebView::WebViewItem::find (const QString &text, bool forward, bool matchCase, bool findNext) |
Поиск текста на веб-странице.
Параметры
text | Текст для поиска. |
forward | Указывает, следует ли выполнять поиск вперёд или назад на странице. |
matchCase | Указывает, следует ли учитывать регистр при поиске. |
findNext | Указывает, следует ли переходить к следующему найденному элементу и выделять его или нет. |
findResultAvailable
void Aurora::WebView::WebViewItem::findResultAvailable (int identifier, int count, QRect selectionRect, int activeMatchOrdinal, bool finalUpdate) | signal |
Отправляется сигнал для сообщения результатов поиска.
Для каждого вызова функции CEF Find функция FindHandler вызывается один или несколько раз. Если элемент не найден, будет выполнен только один вызов FindHandler с параметром finalUpdate, установленным как true. Если найдено несколько элементов, FindHandler вызывается несколько раз. Последний вызов FindHandler имеет параметр finalUpdate, установленный как true.
Параметры
identifier | Идентификатор текущего уведомления о поиске. |
count | Количество совпадений, определённых в данный момент. |
selectionRect | Местоположение, где было найдено совпадение (в координатах окна). |
activeMatchOrdinal | Порядковый номер этой позиции в результатах поиска. |
finalUpdate | Истинно, если это последний вызов FindHandler для данного запроса Find. |
fullscreenModeChanged
void Aurora::WebView::WebViewItem::fullscreenModeChanged (bool fullscreen) | signal |
Испускается при активации или деактивации полноэкранного режима.
Параметры
fullscreen | True, если был активирован полноэкранный режим. |
loadError
void Aurora::WebView::WebViewItem::loadError (QString url, int errorCode) | signal |
Сигнал об ошибке загрузки.
Параметры
url | URL, который привёл к ошибке. |
errorCode | Код ошибки. См. NetError. |
loadFinished
void Aurora::WebView::WebViewItem::loadFinished (int httpStatusCode) | signal |
Сигнал об окончании нагрузки.
Параметры
httpStatusCode | Код состояния, возвращаемый сервером. |
loadingChanged
void Aurora::WebView::WebViewItem::loadingChanged (bool status) | signal |
Испускается при изменении статуса загрузки.
Параметры
status | Статус загрузки. True, если загружается URL. |
loadingProgressChanged
void Aurora::WebView::WebViewItem::loadingProgressChanged (double progress) | signal |
Испускается при изменении хода загрузки.
Параметры
progress | Определяет прогресс загрузки страницы, диапазон от 0,0 до 1,0. |
recvAsyncMessage
void Aurora::WebView::WebViewItem::recvAsyncMessage (const QString name, const QVariant data) | signal |
Сигнал о получении асинхронного сообщения из кода JavaScript.
Параметры
name | Название сообщения. |
data | Данные сообщения. |
runJavaScript()
Q_INVOKABLE void Aurora::WebView::WebViewItem::runJavaScript (const QString &script, const QJSValue &callback, const QJSValue &errorCallback) |
Запускает фрагмент JavaScript в контексте загруженного документа.
sendAsyncMessage()
Q_INVOKABLE void Aurora::WebView::WebViewItem::sendAsyncMessage (const QString &name, const QVariant &data) |
Отправляет асинхронное сообщение с указанными name и data.
setInsets()
Q_INVOKABLE void Aurora::WebView::WebViewItem::setInsets (int top, int right, int bottom, int left) |
Устанавливает значения отступов.
Значения определяют прямоугольник по его верхнему, правому, нижнему и левому отступам от края области просмотра, в который можно безопасно помещать содержимое, не рискуя, что оно будет обрезано формой непрямоугольного дисплея. Глобальные переменные CSS (safe-area-inset-*) принимают соответственно эти значения. Значения вступают в силу только в полноэкранном режиме. Чтобы сбросить отступы, следует передать обнулённые параметры отступа.
setUserAgent()
void Aurora::WebView::WebViewItem::setUserAgent (const QString &userAgent) |
Устанавливает User-Agent. Для применения нового значения требуется перезагрузка страницы.
Пустая строка отключает режим переопределения и устанавливает значение по умолчанию.
stopFinding()
Q_INVOKABLE void Aurora::WebView::WebViewItem::stopFinding (bool clearSelection) |
Отменяет все активные в данный момент поиски.
Параметры
clearSelection | Очистить текущий выбор. |
titleChanged
void Aurora::WebView::WebViewItem::titleChanged (QString title) | signal |
Сигнал об изменении названия.
Параметры
title | Заголовок веб-страницы. |
urlChanged
void Aurora::WebView::WebViewItem::urlChanged (QString url) | signal |
Сигнал об изменении URL.
Параметры
url | Загруженный URL. |
Описание свойств
formFactor
int Aurora::WebView::WebViewItem::formFactor | read write |
Подсказка по форм-фактору устройства. Используются значения из DeviceMode::FormFactor.
Имеет эффект только когда userAgent — значение по умолчанию.
url
QString Aurora::WebView::WebViewItem::url | read write |
URL загруженной веб-страницы.
Установка этого свойства приводит к загрузке новой веб-страницы.
При успешной загрузке испускается сигнал loadFinished(), при неудаче испускается сигнал loadError().
userAgent
QString Aurora::WebView::WebViewItem::userAgent | read write |
User-Agent.
При установке значения userAgentOverride становится true.
formFactor действует только когда userAgent имеет значение по умолчанию.
Следует установить пустое значение, чтобы сбросить userAgent до значения по умолчанию.
userAgentOverride
bool Aurora::WebView::WebViewItem::userAgentOverride | read |
True, если свойству userAgent присвоено некоторое пользовательское значение, в противном случае false.