就业培训     下载中心     Wiki     联络 登录   注册
  1. 首页
  2. Qt 5.15.17
  3. Qt WebEngine
  4. C++ 类
  5. QWebEngineView

QWebEngineView 类

QWebEngineView 类提供用于查看和编辑 Web 文档的 Widget。 更多...

头： #include <QWebEngineView>
qmake: QT += webenginewidgets
Since: Qt 5.4
继承： QWidget

该类在 Qt 5.4 引入。

特性

公共函数

QWebEngineView (QWidget * parent = Q_NULLPTR)
virtual ~QWebEngineView ()
void findText (const QString & subString , QWebEnginePage::FindFlags options = QWebEnginePage::FindFlags(), const QWebEngineCallback<bool> & resultCallback = QWebEngineCallback<bool>())
bool hasSelection () const
QWebEngineHistory * history () const
QIcon icon () const
QUrl iconUrl () const
void load (const QUrl & url )
void load (const QWebEngineHttpRequest & request )
QWebEnginePage * page () const
QAction * pageAction (QWebEnginePage::WebAction action ) const
QString selectedText () const
void setContent (const QByteArray & data , const QString & mimeType = QString(), const QUrl & baseUrl = QUrl())
void setHtml (const QString & html , const QUrl & baseUrl = QUrl())
void setPage (QWebEnginePage * page )
void setUrl (const QUrl & url )
void setZoomFactor (qreal factor )
QWebEngineSettings * settings () const
QString title () const
void triggerPageAction (QWebEnginePage::WebAction action , bool checked = false)
QUrl url () const
qreal zoomFactor () const

重实现公共函数

virtual QSize sizeHint () const override

公共槽

void back ()
void forward ()
void reload ()
void stop ()

信号

void iconChanged (const QIcon & icon )
void iconUrlChanged (const QUrl & url )
void loadFinished (bool ok )
void loadProgress (int progress )
void loadStarted ()
void renderProcessTerminated (QWebEnginePage::RenderProcessTerminationStatus terminationStatus , int exitCode )
void selectionChanged ()
void titleChanged (const QString & title )
void urlChanged (const QUrl & url )

保护函数

virtual QWebEngineView * createWindow (QWebEnginePage::WebWindowType type )

重实现保护函数

virtual void closeEvent (QCloseEvent * event ) override
virtual void contextMenuEvent (QContextMenuEvent * event ) override
virtual void dragEnterEvent (QDragEnterEvent * e ) override
virtual void dragLeaveEvent (QDragLeaveEvent * e ) override
virtual void dragMoveEvent (QDragMoveEvent * e ) override
virtual void dropEvent (QDropEvent * e ) override
virtual bool event (QEvent * ev ) override
virtual void hideEvent (QHideEvent * event ) override
virtual void showEvent (QShowEvent * event ) override

详细描述

A Web 视图 是 Qt WebEngine Web 浏览模块的主要 Widget 组件。可以把它用于各种应用程序以实时显示来自 Internet 的 Web 内容。

A 网站 可以被加载到 Web 视图采用 load () 函数。GET 方法始终被用于加载 URL。

像所有 Qt Widget， show () 函数必须被援引以显示 Web 视图。以下代码片段阐明了这： 

    QWebEngineView *view = new QWebEngineView(parent);
    view->load(QUrl("http://qt-project.org/"));
    view->show();

另外， setUrl () 可以用于加载网站。若有随时可用的 HTML 内容，可以使用 setHtml () 代替。

The loadStarted () 信号被发射当视图开始加载和 loadProgress () 信号被发射每当 Web 视图元素完成加载时，如：嵌入式图像或脚本。 loadFinished () 信号被发射当视图已完全加载。其自变量为 true or false ，指示加载是成功或失败。

The page () 函数返回指针指向 web page 对象。QWebEngineView 包含 QWebEnginePage ，进而允许访问 QWebEngineHistory 在页面的上下文中。

可以访问 HTML 文档的标题采用 title () 特性。另外，网站可以指定图标，可以访问该图标使用 icon () 或其 URL 使用 iconUrl () 特性。若标题或图标改变，相应 titleChanged (), iconChanged () 和 iconUrlChanged () 信号会被发射。 zoomFactor () 特性使能够按比例因子缩放网页内容。

Widget 提供订制手边元素，并包括有用浏览器动作的上下文菜单。对于自定义上下文菜单，或把动作嵌入菜单或工具栏，单个动作是可用的通过 pageAction ()。Web 视图维护返回动作的状态，但允许修改动作特性，如 text or icon 。动作语义也可以被直接触发，透过 triggerPageAction ().

若希望为允许用户打开新窗口 (譬如：弹出窗口) 的网站提供支持，可以子类 QWebEngineView 并重实现 createWindow () 函数。

另请参阅 WebEngine Widgets 简单浏览器范例 , WebEngine 内容操纵范例 ，和 WebEngine Markdown 编辑器范例 .

特性文档编制

hasSelection : const bool

此特性保持此页面是否包含选定内容。

默认情况下，此特性为 false .

访问函数：

bool hasSelection () const

另请参阅 selectionChanged ().

icon : const QIcon

此特性保持关联目前查看页面的图标。

默认情况下，此特性包含 null 图标。

该特性在 Qt 5.7 引入。

访问函数：

QIcon icon () const

通知程序信号：

void iconChanged (const QIcon & icon )

另请参阅 iconChanged (), iconUrl ()，和 iconUrlChanged ().

iconUrl : const QUrl

此特性保持关联目前查看页面的图标 URL。

默认情况下，此特性包含空 URL。

访问函数：

QUrl iconUrl () const

通知程序信号：

void iconUrlChanged (const QUrl & url )

另请参阅 iconUrlChanged (), icon ()，和 iconChanged ().

selectedText : const QString

此特性保持当前选中的文本。

默认情况下，此特性包含空字符串。

访问函数：

QString selectedText () const

另请参阅 findText () 和 selectionChanged ().

title : const QString

此特性保持页面的标题，作为定义通过 HTML <title> 元素。

相当于 QWebEnginePage::title ().

访问函数：

QString title () const

另请参阅 titleChanged ().

url : QUrl

此特性保持目前查看网页的 URL。

设置此特性清零视图并加载 URL。

默认情况下，此特性包含空的无效 URL。

访问函数：

QUrl url () const
void setUrl (const QUrl & url )

另请参阅 load () 和 urlChanged ().

zoomFactor : qreal

此特性保持视图缩放因子。

有效值范围从 0.25 to 5.0 。默认因子为 1.0 .

访问函数：

qreal zoomFactor () const
void setZoomFactor (qreal factor )

成员函数文档编制

QWebEngineView:: QWebEngineView ( QWidget * parent = Q_NULLPTR)

构造空 Web 视图采用父级 parent .

另请参阅 load ().

[slot] void QWebEngineView:: back ()

方便槽，用于把先前文档加载进由导航链接构建的文档列表。什么都不做，若没有先前文档。

相当于： 

    view->page()->triggerAction(QWebEnginePage::Back);

另请参阅 forward () 和 pageAction ().

[slot] void QWebEngineView:: forward ()

方便槽，用于把下一文档加载进由导航链接构建的文档列表。什么都不做，若没有下一文档。

相当于： 

    view->page()->triggerAction(QWebEnginePage::Forward);

另请参阅 back () 和 pageAction ().

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

此信号被发射当视图关联的 favicon 图标改变时。新图标的指定通过否则否则 icon .

注意： 通知程序信号对于特性 icon .

该函数在 Qt 5.7 引入。

另请参阅 icon (), iconUrl ()，和 iconUrlChanged ().

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

此信号被发射当视图关联的 favicon 图标 URL 改变时。新 URL 的指定通过 url .

注意： 通知程序信号对于特性 iconUrl .

另请参阅 iconUrl (), icon ()，和 iconChanged ().

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

此信号被发射当页面的加载已完成时。 ok 将指示加载成功 (或发生错误)。

另请参阅 loadStarted ().

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

此信号被发射每当 Web 视图中的某个元素加载完成 (如：嵌入式图像或脚本) 时。因此，它跟踪加载 Web 视图的集体进度。

当前值被提供由 progress 并缩放到 0 - 100，其是默认范围为 QProgressBar .

另请参阅 loadStarted () 和 loadFinished ().

[signal] void QWebEngineView:: loadStarted ()

此信号被发射当页面的新加载开始时。

另请参阅 loadProgress () 和 loadFinished ().

[slot] void QWebEngineView:: reload ()

重新加载当前文档。

另请参阅 stop (), pageAction ()，和 loadStarted ().

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

此信号被发射当渲染进程采用非零退出状态被终止时。 terminationStatus 是进程的终止状态，且 exitCode 是进程终止的状态码。

该函数在 Qt 5.6 引入。

[signal] void QWebEngineView:: selectionChanged ()

此信号被发射每当选定改变时。

注意： 当使用鼠标通过左键点击并拖拽以选择文本时，会为每个新选中字符发射信号，而不是在释放鼠标左键时。

另请参阅 selectedText ().

[slot] void QWebEngineView:: stop ()

停止加载文档的方便槽。

相当于： 

    view->page()->triggerAction(QWebEnginePage::Stop);

另请参阅 reload (), pageAction ()，和 loadFinished ().

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

此信号发射每当 title 对于视图改变。

另请参阅 title ().

[signal] void QWebEngineView:: urlChanged (const QUrl & url )

此信号发射当 url 对于视图改变。

另请参阅 url () 和 load ().

[虚拟] QWebEngineView:: ~QWebEngineView ()

销毁 Web 视图。

[override virtual protected] void QWebEngineView:: closeEvent ( QCloseEvent * event )

重实现： QWidget::closeEvent (QCloseEvent *event).

[override virtual protected] void QWebEngineView:: contextMenuEvent ( QContextMenuEvent * event )

重实现： QWidget::contextMenuEvent (QContextMenuEvent *event).

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

此函数被调用从 createWindow() 方法的关联 QWebEnginePage 每次页面想要创建新窗口按给定 type 。例如，当发出 JavaScript 请求在新窗口中打开文档时。

注意： 若 createWindow() 方法的关联页面被重实现，此方法不被调用，除非在重实现中明确这样做。

另请参阅 QWebEnginePage::createWindow ().

[override virtual protected] void QWebEngineView:: dragEnterEvent ( QDragEnterEvent * e )

重实现： QWidget::dragEnterEvent (QDragEnterEvent *event).

[override virtual protected] void QWebEngineView:: dragLeaveEvent ( QDragLeaveEvent * e )

重实现： QWidget::dragLeaveEvent (QDragLeaveEvent *event).

[override virtual protected] void QWebEngineView:: dragMoveEvent ( QDragMoveEvent * e )

重实现： QWidget::dragMoveEvent (QDragMoveEvent *event).

[override virtual protected] void QWebEngineView:: dropEvent ( QDropEvent * e )

重实现： QWidget::dropEvent (QDropEvent *event).

[override virtual protected] bool QWebEngineView:: event ( QEvent * ev )

重实现： QWidget::event (QEvent *event).

void QWebEngineView:: findText (const QString & subString , QWebEnginePage::FindFlags options = QWebEnginePage::FindFlags(), const QWebEngineCallback < bool > & resultCallback = QWebEngineCallback<bool>())

查找指定字符串， subString ，在页面使用给定 options .

要清除选定，只需传递空字符串。

resultCallback 必须接受布尔参数。它会被调用采用值 true if subString 被找到；否则，回调值将为 false .

警告： 我们保证回调 ( resultCallback ) 始终被调用，但可能在页面销毁期间完成。当 QWebEnginePage 被删除，将采用无效值触发回调，因此是不安全的使用相应 QWebEnginePage or QWebEngineView 实例在其中。

另请参阅 selectedText () 和 selectionChanged ().

[override virtual protected] void QWebEngineView:: hideEvent ( QHideEvent * event )

重实现： QWidget::hideEvent (QHideEvent *event).

QWebEngineHistory *QWebEngineView:: history () const

返回指向导航网页的视图历史的指针。

相当于： 

    view->page()->history();

void QWebEngineView:: load (const QUrl & url )

加载指定 url 并显示它。

注意： 视图仍然相同，直到达成足够数据才显示新 URL。

另请参阅 load(), setUrl (), url (), urlChanged ()，和 QUrl::fromUserInput ().

void QWebEngineView:: load (const QWebEngineHttpRequest & request )

发出指定 request 并加载响应。

该函数在 Qt 5.9 引入。

另请参阅 load (), setUrl (), url (), urlChanged ()，和 QUrl::fromUserInput ().

QWebEnginePage *QWebEngineView:: page () const

返回指向底层 Web 页面的指针。

另请参阅 setPage ().

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

返回指针指向 QAction 封装指定的 Web 动作 action .

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

把 Web 视图内容设为 data 。若 mimeType 自变量为空，假定内容为 text/plain,charset=US-ASCII .

内容中引用的外部对象的定位相对于 baseUrl 。对于要加载外部对象， baseUrl 不可以为空。

数据被立即加载；外部对象被异步加载。

另请参阅 load (), setHtml ()，和 QWebEnginePage::toHtml ().

void QWebEngineView:: setHtml (const QString & html , const QUrl & baseUrl = QUrl())

将 Web 视图内容设为指定 html 内容。

外部对象 (譬如：HTML 文档引用的样式表或图像) 的定位相对于 baseUrl 。对于要加载外部对象， baseUrl 不可以为空。例如，若 html 检索自 http://www.example.com/documents/overview.html ，其是基 URL，然后相对 URL 引用图像， diagram.png ，应该在 http://www.example.com/documents/diagram.png .

HTML 文档立即加载，而外部对象异步加载。

当使用此方法时，Qt WebEngine 假定外部资源 (譬如 JavaScript 程序或样式表) 以 UTF-8 编码，除非另有指定。例如，可以指定外部脚本的编码透过 charset 属性在 HTML 脚本标签。另外，可以通过 Web 服务器指定编码。

此方便函数相当于 setContent(html, "text/html;charset=UTF-8", baseUrl) .

警告： 此函数仅工作于 HTML。对于其它 MIME 类型 (譬如 XHTML 或 SVG)， setContent () 应该被使用以取而代之。

注意： 大于 2 MB 的内容无法显示，因为 setHtml() 将转换提供的 HTML 为百分比编码并放置 data ：在它之前创建导航 URL。由此，提供的代码变为超过 Chromium 设置的 2 MB 限制的 URL。若内容太大， loadFinished () 信号被触发采用 success=false .

另请参阅 load (), setContent (), QWebEnginePage::toHtml ()，和 QWebEnginePage::setContent ().

void QWebEngineView:: setPage ( QWebEnginePage * page )

使 page 成为 Web 视图的新网页。

父级 QObject 为提供页面仍然是对象所有者。若当前页面是 Web 视图子页面，则删除它。

另请参阅 page ().

QWebEngineSettings *QWebEngineView:: settings () const

返回指向视图 (或页面) 特定设置对象的指针。

相当于： 

    view->page()->settings();

另请参阅 QWebEngineSettings::defaultSettings ().

[override virtual protected] void QWebEngineView:: showEvent ( QShowEvent * event )

重实现： QWidget::showEvent (QShowEvent *event).

[override virtual] QSize QWebEngineView:: sizeHint () const

重实现访问函数为特性： QWidget::sizeHint .

void QWebEngineView:: triggerPageAction ( QWebEnginePage::WebAction action , bool checked = false)

触发指定 action 。若是可复选动作，指定 checked 假定状态。

以下范例触发拷贝动作，因此把任何选中文本拷贝到剪贴板。 

    view->triggerPageAction(QWebEnginePage::Copy);

另请参阅 pageAction ().

内容