内容

公共类型
特性
公共函数
重实现公共函数
公共槽
信号
详细描述

QWebFrame Class

The QWebFrame class represents a frame in a web page. 更多...

头：	#include <QWebFrame>
Since:	Qt 4.4
继承：	QObject

公共类型

enum	RenderLayer { ContentsLayer, ScrollBarLayer, PanIconLayer, AllLayers }

特性

baseUrl : const QUrl
contentsSize : const QSize
focus : const bool
icon : const QIcon
requestedUrl : const QUrl

scrollPosition : QPoint
title : const QString
url : QUrl
zoomFactor : qreal

1 特性继承自 QObject

公共函数

void	addToJavaScriptWindowObject (const QString & name , QObject * object )
void	addToJavaScriptWindowObject (const QString & name , QObject * object , QScriptEngine::ValueOwnership own )
QUrl	baseUrl () const
QList<QWebFrame *>	childFrames () const
QSize	contentsSize () const
QWebElement	documentElement () const
QWebElementCollection	findAllElements (const QString & selectorQuery ) const
QWebElement	findFirstElement (const QString & selectorQuery ) const
QString	frameName () const
QRect	geometry () const
bool	hasFocus () const
QWebHitTestResult	hitTestContent (const QPoint & pos ) const
QIcon	icon () const
void	load (const QUrl & url )
void	load (const QNetworkRequest & req , QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray & body = QByteArray())
QMultiMap<QString, QString>	metaData () const
QWebPage *	page () const
QWebFrame *	parentFrame () const
QPoint	pos () const
void	render (QPainter * painter )
void	render (QPainter * painter , const QRegion & clip )
void	render (QPainter * painter , RenderLayer layer , const QRegion & clip = QRegion())
QString	renderTreeDump () const
QUrl	requestedUrl () const
void	scroll (int dx , int dy )
QRect	scrollBarGeometry (Qt::Orientation orientation ) const
int	scrollBarMaximum (Qt::Orientation orientation ) const
int	scrollBarMinimum (Qt::Orientation orientation ) const
Qt::ScrollBarPolicy	scrollBarPolicy (Qt::Orientation orientation ) const
int	scrollBarValue (Qt::Orientation orientation ) const
QPoint	scrollPosition () const
void	scrollToAnchor (const QString & anchor )
QWebSecurityOrigin	securityOrigin () const
void	setContent (const QByteArray & data , const QString & mimeType = QString(), const QUrl & baseUrl = QUrl())
void	setFocus ()
void	setHtml (const QString & html , const QUrl & baseUrl = QUrl())
void	setScrollBarPolicy (Qt::Orientation orientation , Qt::ScrollBarPolicy policy )
void	setScrollBarValue (Qt::Orientation orientation , int value )
void	setScrollPosition (const QPoint & pos )
void	setTextSizeMultiplier (qreal factor )
void	setUrl (const QUrl & url )
void	setZoomFactor (qreal factor )
qreal	textSizeMultiplier () const
QString	title () const
QString	toHtml () const
QString	toPlainText () const
QUrl	url () const
qreal	zoomFactor () const

重实现公共函数

virtual bool

event (QEvent * e )

29 公共函数继承自 QObject

公共槽

QVariant	evaluateJavaScript (const QString & scriptSource )
void	print (QPrinter * printer ) const

1 公共槽继承自 QObject

信号

void	contentsSizeChanged (const QSize & size )
void	iconChanged ()
void	initialLayoutCompleted ()
void	javaScriptWindowObjectCleared ()
void	loadFinished (bool ok )
void	loadStarted ()
void	pageChanged ()
void	titleChanged (const QString & title )
void	urlChanged (const QUrl & url )

1 信号继承自 QObject

额外继承成员

7 静态公共成员继承自 QObject
8 保护函数继承自 QObject

详细描述

The QWebFrame class represents a frame in a web page.

QWebFrame represents a frame inside a web page. Each QWebPage object contains at least one frame, the main frame, obtained using QWebPage::mainFrame (). Additional frames will be created for HTML <frame> or <iframe> 元素。

A frame can be loaded using load () 或 setUrl ()。另外，若拥有随时可用的 HTML 内容，可以使用 setHtml () 代替。

The page () function returns a pointer to the web page object. See QWebView 元素 for an explanation of how web frames are related to a web page and web view.

The QWebFrame class also offers methods to retrieve both the URL currently loaded by the frame (see url ()) 及要被加载的最初请求 URL (见 requestedUrl ))。这些方法使在加载进程期间出现 DNS 解答 (或重定向) 前后，检索 URL 成为可能。 requestedUrl () also matches to the URL added to the frame history ( QWebHistory ) 若加载成功。

The title of an HTML frame can be accessed with the title () property. Additionally, a frame may also specify an icon, which can be accessed using the icon () 特性。若标题或图标改变，相应 titleChanged () 和 iconChanged () 信号会被发射。 zoomFactor () property can be used to change the overall size of the content displayed in the frame.

QWebFrame objects are created and controlled by the web page. You can connect to the web page's frameCreated() signal to be notified when a new frame is created.

There are multiple ways to programmatically examine the contents of a frame. The hitTestContent () function can be used to find elements by coordinate. For access to the underlying DOM tree, there is documentElement (), findAllElements () 和 findFirstElement ().

A QWebFrame can be printed onto a QPrinter 使用 print () function. This function is marked as a slot and can be conveniently connected to QPrintPreviewDialog 's paintRequested() 信号。

另请参阅 QWebPage .

成员类型文档编制

enum QWebFrame:: RenderLayer

This enum describes the layers available for rendering using render() . The layers can be OR-ed together from the following list:

常量	值	描述
`QWebFrame::ContentsLayer`	`0x10`	The web content of the frame
`QWebFrame::ScrollBarLayer`	`0x20`	The scrollbars of the frame
`QWebFrame::PanIconLayer`	`0x40`	The icon used when panning the frame
`QWebFrame::AllLayers`	`0xff`	Includes all the above layers

特性文档编制

baseUrl : const QUrl

This property holds the base URL of the frame, can be used to resolve relative URLs.

该特性在 Qt 4.6 引入。

访问函数：

QUrl	baseUrl () const

contentsSize : const QSize

This property holds the size of the contents in this frame.

访问函数：

QSize

contentsSize () const

另请参阅 contentsSizeChanged ().

focus : const bool

Returns true if this frame has keyboard input focus; otherwise, returns false.

该特性在 Qt 4.6 引入。

访问函数：

bool	hasFocus () const

icon : const QIcon

This property holds the icon associated with this frame.

访问函数：

QIcon

icon () const

另请参阅 iconChanged () 和 QWebSettings::iconForUrl ().

requestedUrl : const QUrl

The URL requested to loaded by the frame currently viewed. The URL may differ from the one returned by url () if a DNS resolution or a redirection occurs.

该特性在 Qt 4.6 引入。

访问函数：

QUrl	requestedUrl () const

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

scrollPosition : QPoint

This property holds the position the frame is currently scrolled to.

该特性在 Qt 4.5 引入。

访问函数：

QPoint	scrollPosition () const
void	setScrollPosition (const QPoint & pos )

title : const QString

This property holds the title of the frame as defined by the HTML <title> element.

访问函数：

QString

title () const

另请参阅 titleChanged ().

url : QUrl

This property holds the url of the frame currently viewed.

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

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

访问函数：

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

另请参阅 urlChanged ().

zoomFactor : qreal

This property holds the zoom factor for the frame.

该特性在 Qt 4.5 引入。

访问函数：

qreal	zoomFactor () const
void	setZoomFactor (qreal factor )

成员函数文档编制

void QWebFrame:: addToJavaScriptWindowObject (const QString & name , QObject * object )

Make object available under name from within the frame's JavaScript context. The object will be inserted as a child of the frame's window object.

Qt properties will be exposed as JavaScript properties and slots as JavaScript methods. The interaction between C++ and JavaScript is explained in the documentation of the QtWebKit bridge .

If you want to ensure that your QObjects remain accessible after loading a new URL, you should add them in a slot connected to the javaScriptWindowObjectCleared () 信号。

If Javascript is not enabled for this page, then this method does nothing.

The object will never be explicitly deleted by QtWebKit .

void QWebFrame:: addToJavaScriptWindowObject (const QString & name , QObject * object , QScriptEngine::ValueOwnership own )

这是重载函数。

Make object available under name from within the frame's JavaScript context. The object will be inserted as a child of the frame's window object.

Qt properties will be exposed as JavaScript properties and slots as JavaScript methods. The interaction between C++ and JavaScript is explained in the documentation of the QtWebKit bridge .

If you want to ensure that your QObjects remain accessible after loading a new URL, you should add them in a slot connected to the javaScriptWindowObjectCleared () 信号。

If Javascript is not enabled for this page, then this method does nothing.

所有权对于 object is specified using own .

QList < QWebFrame *> QWebFrame:: childFrames () const

Returns a list of all frames that are direct children of this frame.

另请参阅 parentFrame ().

`[signal]` void QWebFrame:: contentsSizeChanged (const QSize & size )

This signal is emitted when the frame's contents size changes to size .

该函数在 Qt 4.6 引入。

另请参阅 contentsSize ().

QWebElement QWebFrame:: documentElement () const

Returns the document element of this frame.

The document element provides access to the entire structured content of the frame.

该函数在 Qt 4.6 引入。

`[slot]` QVariant QWebFrame:: evaluateJavaScript (const QString & scriptSource )

Evaluates the JavaScript defined by scriptSource using this frame as context and returns the result of the last executed statement.

另请参阅 addToJavaScriptWindowObject () 和 javaScriptWindowObjectCleared ().

`[虚拟]` bool QWebFrame:: event ( QEvent * e )

重实现自 QObject::event ().

QWebElementCollection QWebFrame:: findAllElements (const QString & selectorQuery ) const

Returns a new list of elements matching the given CSS selector selectorQuery . If there are no matching elements, an empty list is returned.

Standard CSS2 selector syntax is used for the query.

该函数在 Qt 4.6 引入。

另请参阅 QWebElement::findAll ().

QWebElement QWebFrame:: findFirstElement (const QString & selectorQuery ) const

Returns the first element in the frame's document that matches the given CSS selector selectorQuery . If there is no matching element, a null element is returned.

Standard CSS2 selector syntax is used for the query.

该函数在 Qt 4.6 引入。

另请参阅 QWebElement::findFirst ().

QString QWebFrame:: frameName () const

The name of this frame as defined by the parent frame.

QRect QWebFrame:: geometry () const

Return the geometry of the frame relative to it's parent frame.

QWebHitTestResult QWebFrame:: hitTestContent (const QPoint & pos ) const

Performs a hit test on the frame contents at the given position pos and returns the hit test result.

`[signal]` void QWebFrame:: iconChanged ()

This signal is emitted when the icon ("favicon") associated with the frame has been loaded.

另请参阅 icon ().

`[signal]` void QWebFrame:: initialLayoutCompleted ()

This signal is emitted when the frame is laid out the first time. This is the first time you will see contents displayed on the frame.

注意： A frame can be laid out multiple times.

`[signal]` void QWebFrame:: javaScriptWindowObjectCleared ()

This signal is emitted whenever the global window object of the JavaScript environment is cleared, e.g., before starting a new load.

If you intend to add QObjects 到 QWebFrame 使用 addToJavaScriptWindowObject (), you should add them in a slot connected to this signal. This ensures that your objects remain accessible when loading new URLs.

void QWebFrame:: load (const QUrl & url )

加载 url into this frame.

注意： The view remains the same until enough data has arrived to display the new url .

另请参阅 setUrl (), setHtml ()，和 setContent ().

void QWebFrame:: load (const QNetworkRequest & req , QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray & body = QByteArray())

Loads a network request, req , into this frame, using the method specified in operation .

body is optional and is only used for POST operations.

注意： The view remains the same until enough data has arrived to display the new content.

另请参阅 setUrl ().

`[signal]` void QWebFrame:: loadFinished ( bool ok )

This signal is emitted when a load of this frame is finished. ok 将指示加载是否成功 (或发生任何错误)。

该函数在 Qt 4.6 引入。

另请参阅 loadStarted ().

`[signal]` void QWebFrame:: loadStarted ()

This signal is emitted when a new load of this frame is started.

该函数在 Qt 4.6 引入。

另请参阅 loadFinished ().

QMultiMap < QString , QString > QWebFrame:: metaData () const

Returns the meta data in this frame as a QMultiMap

The meta data consists of the name and content attributes of the of the <meta> tags in the HTML document.

例如：

<html>
    <head>
        <meta name="description" content="This document is a tutorial about Qt development">
        <meta name="keywords" content="Qt, WebKit, Programming">
    </head>
    ...
</html>

Given the above HTML code the metaData() function will return a map with two entries:

Key	值
"description"	"This document is a tutorial about Qt development"
"keywords"	"Qt, WebKit , Programming"

This function returns a multi map to support multiple meta tags with the same attribute name.

该函数在 Qt 4.5 引入。

QWebPage * QWebFrame:: page () const

The web page that contains this frame.

另请参阅 pageChanged ().

`[signal]` void QWebFrame:: pageChanged ()

This signal is emitted when this frame has been moved to a different QWebPage .

该函数在 Qt 4.7 引入。

另请参阅 page ().

QWebFrame * QWebFrame:: parentFrame () const

Returns the parent frame of this frame, or 0 if the frame is the web pages main frame.

这相当于 qobject_cast < QWebFrame *>(frame-> parent ()).

另请参阅 childFrames ().

QPoint QWebFrame:: pos () const

Returns the position of the frame relative to it's parent frame.

`[slot]` void QWebFrame:: print ( QPrinter * printer ) const

Prints the frame to the given printer .

另请参阅 render ().

void QWebFrame:: render ( QPainter * painter )

Render the frame into painter .

void QWebFrame:: render ( QPainter * painter , const QRegion & clip )

Render the frame into painter clipping to clip .

void QWebFrame:: render ( QPainter * painter , RenderLayer layer , const QRegion & clip = QRegion())

渲染 layer of the frame using painter clipping to clip .

该函数在 Qt 4.6 引入。

另请参阅 print ().

QString QWebFrame:: renderTreeDump () const

Returns a dump of the rendering tree. This is mainly useful for debugging html.

void QWebFrame:: scroll ( int dx , int dy )

Scrolls the frame dx 像素到右侧和 dy pixels downward. Both dx and dy 可能为负值。

该函数在 Qt 4.5 引入。

另请参阅 QWebFrame::scrollPosition .

QRect QWebFrame:: scrollBarGeometry ( Qt::Orientation orientation ) const

Returns the geometry for the scrollbar with orientation orientation .

If the scrollbar does not exist an empty rect is returned.

该函数在 Qt 4.6 引入。

int QWebFrame:: scrollBarMaximum ( Qt::Orientation orientation ) const

Returns the maximum value for the scrollbar with orientation orientation , or 0 if no scrollbar is found for orientation .

另请参阅 scrollBarMinimum ().

int QWebFrame:: scrollBarMinimum ( Qt::Orientation orientation ) const

Returns the minimum value for the scrollbar with orientation orientation .

The minimum value is always 0.

另请参阅 scrollBarMaximum ().

Qt::ScrollBarPolicy QWebFrame:: scrollBarPolicy ( Qt::Orientation orientation ) const

Returns the scrollbar policy for the scrollbar defined by orientation .

另请参阅 setScrollBarPolicy ().

int QWebFrame:: scrollBarValue ( Qt::Orientation orientation ) const

Returns the current value for the scrollbar with orientation orientation , or 0 if no scrollbar is found for orientation .

另请参阅 setScrollBarValue (), scrollBarMinimum ()，和 scrollBarMaximum ().

void QWebFrame:: scrollToAnchor (const QString & anchor )

Scrolls the frame to the given anchor 名称。

该函数在 Qt 4.7 引入。

QWebSecurityOrigin QWebFrame:: securityOrigin () const

Returns the frame's security origin.

该函数在 Qt 4.5 引入。

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

Sets the content of this frame to the specified content data 。若 mimeType argument is empty it is currently assumed that the content is HTML but in future versions we may introduce auto-detection.

内容中引用的外部对象的定位相对于 baseUrl .

The data 被立即加载；外部对象是异步加载的。

注意： This method will not affect session or global history for the frame.

另请参阅 toHtml () 和 setHtml ().

void QWebFrame:: setFocus ()

Gives keyboard input focus to this frame.

该函数在 Qt 4.6 引入。

另请参阅 hasFocus ().

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

Sets the content of this frame to html . baseUrl 是可选的和用于解析文档中的相对 URL，譬如：引用的图像或样式表。

The html 被立即加载；外部对象是异步加载的。

若脚本在 html 运行时间超过默认 (目前 10 秒) 脚本超时，(例如：由于被模态 JavaScript 警报对话框所阻塞)，此方法将尽快返回在超时之后且任何后续 html 将异步加载。

When using this method WebKit assumes that external resources such as JavaScript programs or style sheets are encoded in UTF-8 unless otherwise specified. For example, the encoding of an external script can be specified through the charset attribute of the HTML script tag. It is also possible for the encoding to be specified by web server.

此方便函数相当于 setContent (html, "text/html", baseUrl ).

注意： This method will not affect session or global history for the frame.

警告： This function works only for HTML, for other mime types (i.e. XHTML, SVG) setContent () 应该被使用以取而代之。

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

void QWebFrame:: setScrollBarPolicy ( Qt::Orientation orientation , Qt::ScrollBarPolicy policy )

Sets the scrollbar policy for the scrollbar defined by orientation to policy .

另请参阅 scrollBarPolicy ().

void QWebFrame:: setScrollBarValue ( Qt::Orientation orientation , int value )

设置当前 value for the scrollbar with orientation orientation .

The scrollbar forces the value to be within the legal range: minimum <= value <= maximum.

Changing the value also updates the thumb position.

另请参阅 scrollBarValue (), scrollBarMinimum ()，和 scrollBarMaximum ().

void QWebFrame:: setTextSizeMultiplier ( qreal factor )

Sets the value of the multiplier used to scale the text in a Web frame to the factor 指定。

另请参阅 textSizeMultiplier ().

qreal QWebFrame:: textSizeMultiplier () const

Returns the value of the multiplier used to scale the text in a Web frame.

另请参阅 setTextSizeMultiplier ().

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

This signal is emitted whenever the title of the frame changes. The title 字符串指定新标题。

另请参阅 title ().

QString QWebFrame:: toHtml () const

Returns the frame's content as HTML, enclosed in HTML and BODY tags.

另请参阅 setHtml () 和 toPlainText ().

QString QWebFrame:: toPlainText () const

Returns the content of this frame converted to plain text, completely stripped of all HTML formatting.

另请参阅 toHtml ().

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

This signal is emitted with the URL of the frame when the frame's title is received. The new URL is specified by url .

另请参阅 url ().

内容

QWebFrame Class

公共类型

特性

公共函数

重实现公共函数

公共槽

信号

额外继承成员

详细描述

成员类型文档编制

enum QWebFrame:: RenderLayer

特性文档编制

baseUrl : const QUrl

contentsSize : const QSize

focus : const bool

icon : const QIcon

requestedUrl : const QUrl

scrollPosition : QPoint

title : const QString

url : QUrl

zoomFactor : qreal

成员函数文档编制

void QWebFrame:: addToJavaScriptWindowObject (const QString & name , QObject * object )

void QWebFrame:: addToJavaScriptWindowObject (const QString & name , QObject * object , QScriptEngine::ValueOwnership own )

QList < QWebFrame *> QWebFrame:: childFrames () const

[signal] void QWebFrame:: contentsSizeChanged (const QSize & size )

QWebElement QWebFrame:: documentElement () const

[slot] QVariant QWebFrame:: evaluateJavaScript (const QString & scriptSource )

[虚拟] bool QWebFrame:: event ( QEvent * e )

QWebElementCollection QWebFrame:: findAllElements (const QString & selectorQuery ) const

QWebElement QWebFrame:: findFirstElement (const QString & selectorQuery ) const

QString QWebFrame:: frameName () const

QRect QWebFrame:: geometry () const

QWebHitTestResult QWebFrame:: hitTestContent (const QPoint & pos ) const

[signal] void QWebFrame:: iconChanged ()

[signal] void QWebFrame:: initialLayoutCompleted ()

[signal] void QWebFrame:: javaScriptWindowObjectCleared ()

void QWebFrame:: load (const QUrl & url )

void QWebFrame:: load (const QNetworkRequest & req , QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray & body = QByteArray())

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

[signal] void QWebFrame:: loadStarted ()

QMultiMap < QString , QString > QWebFrame:: metaData () const

QWebPage * QWebFrame:: page () const

[signal] void QWebFrame:: pageChanged ()

QWebFrame * QWebFrame:: parentFrame () const

QPoint QWebFrame:: pos () const

[slot] void QWebFrame:: print ( QPrinter * printer ) const

void QWebFrame:: render ( QPainter * painter )

void QWebFrame:: render ( QPainter * painter , const QRegion & clip )

void QWebFrame:: render ( QPainter * painter , RenderLayer layer , const QRegion & clip = QRegion())

QString QWebFrame:: renderTreeDump () const

void QWebFrame:: scroll ( int dx , int dy )

QRect QWebFrame:: scrollBarGeometry ( Qt::Orientation orientation ) const

int QWebFrame:: scrollBarMaximum ( Qt::Orientation orientation ) const

int QWebFrame:: scrollBarMinimum ( Qt::Orientation orientation ) const

Qt::ScrollBarPolicy QWebFrame:: scrollBarPolicy ( Qt::Orientation orientation ) const

int QWebFrame:: scrollBarValue ( Qt::Orientation orientation ) const

void QWebFrame:: scrollToAnchor (const QString & anchor )

QWebSecurityOrigin QWebFrame:: securityOrigin () const

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

void QWebFrame:: setFocus ()

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

void QWebFrame:: setScrollBarPolicy ( Qt::Orientation orientation , Qt::ScrollBarPolicy policy )

void QWebFrame:: setScrollBarValue ( Qt::Orientation orientation , int value )

void QWebFrame:: setTextSizeMultiplier ( qreal factor )

qreal QWebFrame:: textSizeMultiplier () const

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

QString QWebFrame:: toHtml () const

QString QWebFrame:: toPlainText () const

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

`[signal]` void QWebFrame:: contentsSizeChanged (const QSize & size )

`[slot]` QVariant QWebFrame:: evaluateJavaScript (const QString & scriptSource )

`[虚拟]` bool QWebFrame:: event ( QEvent * e )

`[signal]` void QWebFrame:: iconChanged ()

`[signal]` void QWebFrame:: initialLayoutCompleted ()

`[signal]` void QWebFrame:: javaScriptWindowObjectCleared ()

`[signal]` void QWebFrame:: loadFinished ( bool ok )

`[signal]` void QWebFrame:: loadStarted ()

`[signal]` void QWebFrame:: pageChanged ()

`[slot]` void QWebFrame:: print ( QPrinter * printer ) const

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

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