|  | Home · All Classes · Modules

# QWebFrame Class Reference
[QtWebKit module]

The QWebFrame class represents a frame in a web page. More...

Inherits QObject.

### Types

- enum RenderLayer { ContentsLayer, ScrollBarLayer, PanIconLayer, AllLayers }

### Methods

- addToJavaScriptWindowObject (self, QString name, QObject object)
- QUrl baseUrl (self)
- list-of-QWebFrame childFrames (self)
- QSize contentsSize (self)
- QWebElement documentElement (self)
- QVariant evaluateJavaScript (self, QString scriptSource)
- bool event (self, QEvent)
- QWebElementCollection findAllElements (self, QString selectorQuery)
- QWebElement findFirstElement (self, QString selectorQuery)
- QString frameName (self)
- QRect geometry (self)
- bool hasFocus (self)
- QWebHitTestResult hitTestContent (self, QPoint pos)
- QIcon icon (self)
- load (self, QUrl url)
- load (self, QNetworkRequest request, QNetworkAccessManager.Operation operation = QNetworkAccessManager.GetOperation, QByteArray body = QByteArray())
- dict-of-QString-list-of-QString metaData (self)
- QWebPage page (self)
- QWebFrame parentFrame (self)
- QPoint pos (self)
- print (self, QPrinter printer)
- print_ (self, QPrinter printer)
- render (self, QPainter painter, QRegion clip)
- render (self, QPainter painter)
- render (self, QPainter, RenderLayer layer, QRegion clip = QRegion())
- QString renderTreeDump (self)
- QUrl requestedUrl (self)
- scroll (self, int, int)
- QRect scrollBarGeometry (self, Qt.Orientation orientation)
- int scrollBarMaximum (self, Qt.Orientation orientation)
- int scrollBarMinimum (self, Qt.Orientation orientation)
- Qt.ScrollBarPolicy scrollBarPolicy (self, Qt.Orientation orientation)
- int scrollBarValue (self, Qt.Orientation orientation)
- QPoint scrollPosition (self)
- scrollToAnchor (self, QString anchor)
- QWebSecurityOrigin securityOrigin (self)
- setContent (self, QByteArray data, QString mimeType = QString(), QUrl baseUrl = QUrl())
- setFocus (self)
- setHtml (self, QString html, QUrl baseUrl = QUrl())
- setScrollBarPolicy (self, Qt.Orientation orientation, Qt.ScrollBarPolicy policy)
- setScrollBarValue (self, Qt.Orientation orientation, int value)
- setScrollPosition (self, QPoint pos)
- setTextSizeMultiplier (self, float factor)
- setUrl (self, QUrl url)
- setZoomFactor (self, float factor)
- float textSizeMultiplier (self)
- QString title (self)
- QString toHtml (self)
- QString toPlainText (self)
- QUrl url (self)
- float zoomFactor (self)

### Qt Signals

- void contentsSizeChanged (const QSize&)
- void iconChanged ()
- void initialLayoutCompleted ()
- void javaScriptWindowObjectCleared ()
- void loadFinished (bool)
- void loadStarted ()
- void pageChanged ()
- void titleChanged (const QString&)
- void urlChanged (const QUrl&)

## Detailed Description

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>` elements.

A frame can be loaded using load() or setUrl(). Alternatively, if you have the HTML content readily available, you can use setHtml() instead.

The page() function returns a pointer to the web page object. See Elements of 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()) as well as the URL originally requested to be loaded (see requestedUrl()). These methods make possible the retrieval of the URL before and after a DNS resolution or a redirection occurs during the load process. The requestedUrl() also matches to the URL added to the frame history (QWebHistory) if load is successful.

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() property. If the title or the icon changes, the corresponding titleChanged() and iconChanged() signals will be emitted. The 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() and findFirstElement().

A QWebFrame can be printed onto a QPrinter using the print_() function. This function is marked as a slot and can be conveniently connected to QPrintPreviewDialog's paintRequested() signal.

## Type Documentation

### QWebFrame.RenderLayer

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

Constant | Value | Description
--- | --- | ---
`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

## Method Documentation

### QWebFrame.addToJavaScriptWindowObject (self, QString name, QObject object)

The object argument has it's ownership transferred to Qt.

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() signal.

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

The object will never be explicitly deleted by QtWebKit.

### QUrl QWebFrame.baseUrl (self)

### list-of-QWebFrame QWebFrame.childFrames (self)

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

See also parentFrame().

### QSize QWebFrame.contentsSize (self)

### QWebElement QWebFrame.documentElement (self)

Returns the document element of this frame.

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

This function was introduced in Qt 4.6.

### QVariant QWebFrame.evaluateJavaScript (self, QString scriptSource)

This method is also a Qt slot with the C++ signature `QVariant evaluateJavaScript(const QString&)`.

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

See also addToJavaScriptWindowObject() and javaScriptWindowObjectCleared().

### bool QWebFrame.event (self, QEvent)

Reimplemented from QObject.event().

### QWebElementCollection QWebFrame.findAllElements (self, QString selectorQuery)

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.

This function was introduced in Qt 4.6.

See also QWebElement.findAll().

### QWebElement QWebFrame.findFirstElement (self, QString selectorQuery)

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.

This function was introduced in Qt 4.6.

See also QWebElement.findFirst().

### QString QWebFrame.frameName (self)

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

### QRect QWebFrame.geometry (self)

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

### bool QWebFrame.hasFocus (self)

### QWebHitTestResult QWebFrame.hitTestContent (self, QPoint pos)

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

### QIcon QWebFrame.icon (self)

### QWebFrame.load (self, QUrl url)

Loads url into this frame.

Note: The view remains the same until enough data has arrived to display the new url.

See also setUrl(), setHtml(), and setContent().

### QWebFrame.load (self, QNetworkRequest request, QNetworkAccessManager.Operation operation = QNetworkAccessManager.GetOperation, 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.

Note: The view remains the same until enough data has arrived to display the new content.

See also setUrl().

### dict-of-QString-list-of-QString QWebFrame.metaData (self)

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.

For example:

     <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 | Value
--- | ---
"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.

This function was introduced in Qt 4.5.

### QWebPage QWebFrame.page (self)

The web page that contains this frame.

See also pageChanged().

### QWebFrame QWebFrame.parentFrame (self)

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

This is equivalent to qobject_cast<QWebFrame*>(frame->parent()).

See also childFrames().

### QPoint QWebFrame.pos (self)

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

### QWebFrame.print (self, QPrinter printer)

This method is also a Qt slot with the C++ signature `void print(QPrinter *) const`.

Prints the frame to the given printer.

See also render().

### QWebFrame.print_ (self, QPrinter printer)

This method is also a Qt slot with the C++ signature `void print(QPrinter *) const`.

Prints the frame to the given printer.

See also render().

### QWebFrame.render (self, QPainter painter, QRegion clip)

Render the frame into painter.

### QWebFrame.render (self, QPainter painter)

Render the frame into painter clipping to clip.

### QWebFrame.render (self, QPainter, RenderLayer layer, QRegion clip = QRegion())

Render the layer of the frame using painter clipping to clip.

This function was introduced in Qt 4.6.

See also print_().

### QString QWebFrame.renderTreeDump (self)

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

### QUrl QWebFrame.requestedUrl (self)

### QWebFrame.scroll (self, int, int)

Scrolls the frame dx pixels to the right and dy pixels downward. Both dx and dy may be negative.

This function was introduced in Qt 4.5.

See also QWebFrame.scrollPosition.

### QRect QWebFrame.scrollBarGeometry (self, Qt.Orientation orientation)

Returns the geometry for the scrollbar with orientation orientation.

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

This function was introduced in Qt 4.6.

### int QWebFrame.scrollBarMaximum (self, Qt.Orientation orientation)

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

See also scrollBarMinimum().

### int QWebFrame.scrollBarMinimum (self, Qt.Orientation orientation)

Returns the minimum value for the scrollbar with orientation orientation.

The minimum value is always 0.

See also scrollBarMaximum().

### Qt.ScrollBarPolicy QWebFrame.scrollBarPolicy (self, Qt.Orientation orientation)

Returns the scrollbar policy for the scrollbar defined by orientation.

See also setScrollBarPolicy().

### int QWebFrame.scrollBarValue (self, Qt.Orientation orientation)

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

See also setScrollBarValue(), scrollBarMinimum(), and scrollBarMaximum().

### QPoint QWebFrame.scrollPosition (self)

### QWebFrame.scrollToAnchor (self, QString anchor)

Scrolls the frame to the given anchor name.

This function was introduced in Qt 4.7.

### QWebSecurityOrigin QWebFrame.securityOrigin (self)

Returns the frame's security origin.

This function was introduced in Qt 4.5.

### QWebFrame.setContent (self, QByteArray data, QString mimeType = QString(), QUrl baseUrl = QUrl())

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

External objects referenced in the content are located relative to baseUrl.

The data is loaded immediately; external objects are loaded asynchronously.

Note: This method will not affect session or global history for the frame.

See also toHtml() and setHtml().

### QWebFrame.setFocus (self)

Gives keyboard input focus to this frame.

This function was introduced in Qt 4.6.

See also hasFocus().

### QWebFrame.setHtml (self, QString html, QUrl baseUrl = QUrl())

Sets the content of this frame to html. baseUrl is optional and used to resolve relative URLs in the document, such as referenced images or stylesheets.

The html is loaded immediately; external objects are loaded asynchronously.

If a script in the html runs longer than the default script timeout (currently 10 seconds), for example due to being blocked by a modal JavaScript alert dialog, this method will return as soon as possible after the timeout and any subsequent html will be loaded asynchronously.

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.

This is a convenience function equivalent to setContent(html, "text/html", baseUrl).

Note: This method will not affect session or global history for the frame.

Warning: This function works only for HTML, for other mime types (i.e. XHTML, SVG) setContent() should be used instead.

See also toHtml(), setContent(), and load().

### QWebFrame.setScrollBarPolicy (self, Qt.Orientation orientation, Qt.ScrollBarPolicy policy)

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

See also scrollBarPolicy().

### QWebFrame.setScrollBarValue (self, Qt.Orientation orientation, int value)

Sets the current 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.

See also scrollBarValue(), scrollBarMinimum(), and scrollBarMaximum().

### QWebFrame.setScrollPosition (self, QPoint pos)

### QWebFrame.setTextSizeMultiplier (self, float factor)

Sets the value of the multiplier used to scale the text in a Web frame to the factor specified.

See also textSizeMultiplier().

### QWebFrame.setUrl (self, QUrl url)

### QWebFrame.setZoomFactor (self, float factor)

### float QWebFrame.textSizeMultiplier (self)

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

See also setTextSizeMultiplier().

### QString QWebFrame.title (self)

### QString QWebFrame.toHtml (self)

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

See also setHtml() and toPlainText().

### QString QWebFrame.toPlainText (self)

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

See also toHtml().

### QUrl QWebFrame.url (self)

### float QWebFrame.zoomFactor (self)

## Qt Signal Documentation

### void contentsSizeChanged (const QSize&)

This is the default overload of this signal.

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

This function was introduced in Qt 4.6.

See also contentsSize().

### void iconChanged ()

This is the default overload of this signal.

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

See also icon().

### void initialLayoutCompleted ()

This is the default overload of this signal.

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.

Note: A frame can be laid out multiple times.

### void javaScriptWindowObjectCleared ()

This is the default overload of this signal.

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 to a QWebFrame using addToJavaScriptWindowObject(), you should add them in a slot connected to this signal. This ensures that your objects remain accessible when loading new URLs.

### void loadFinished (bool)

This is the default overload of this signal.

This signal is emitted when a load of this frame is finished. ok will indicate whether the load was successful or any error occurred.

This function was introduced in Qt 4.6.

See also loadStarted().

### void loadStarted ()

This is the default overload of this signal.

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

This function was introduced in Qt 4.6.

See also loadFinished().

### void pageChanged ()

This is the default overload of this signal.

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

This function was introduced in Qt 4.7.

See also page().

### void titleChanged (const QString&)

This is the default overload of this signal.

This signal is emitted whenever the title of the frame changes. The title string specifies the new title.

See also title().

### void urlChanged (const QUrl&)

This is the default overload of this signal.

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

See also url().