|  | Home · All Classes · Modules

# QWebFrame Class Reference
[QtWebKit module]

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

Inherits QObject.

### Methods

- addToJavaScriptWindowObject (self, QString name, QObject object)
- QList<QWebFrame *> childFrames (self)
- QSize contentsSize (self)
- QVariant evaluateJavaScript (self, QString scriptSource)
- bool event (self, QEvent)
- QString frameName (self)
- QRect geometry (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())
- QWebPage page (self)
- QWebFrame parentFrame (self)
- QPoint pos (self)
- print (self, QPrinter printer)
- render (self, QPainter painter, QRegion clip)
- render (self, QPainter painter)
- QString renderTreeDump (self)
- 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)
- setContent (self, QByteArray data, QString mimeType = QString(), QUrl baseUrl = QUrl())
- setHtml (self, QString html, QUrl baseUrl = QUrl())
- setScrollBarPolicy (self, Qt.Orientation orientation, Qt.ScrollBarPolicy policy)
- setScrollBarValue (self, Qt.Orientation orientation, int value)
- setTextSizeMultiplier (self, float factor)
- setUrl (self, QUrl url)
- float textSizeMultiplier (self)
- QString title (self)
- QString toHtml (self)
- QString toPlainText (self)
- QUrl url (self)

### Qt Signals

- void iconChanged ()
- void initialLayoutCompleted ()
- void javaScriptWindowObjectCleared ()
- 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 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 textSizeMultiplier() property can be used to change the overall size of the text 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.

The hitTestContent() function can be used to programmatically examine the contents of a frame.

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.

See also QWebPage.

## 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.

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.

### QList<QWebFrame *> QWebFrame.childFrames (self)

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

See also parentFrame().

### QSize QWebFrame.contentsSize (self)

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

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

Evaluate JavaScript defined by scriptSource using this frame as context.

See also addToJavaScriptWindowObject() and javaScriptWindowObjectCleared().

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

### 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.

### 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())

This is an overloaded member function, provided for convenience.

Loads a network request, req, into this frame.

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

### QWebPage QWebFrame.page (self)

The web page that contains this frame.

### 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.render (self, QPainter painter, QRegion clip)

Render the frame into painter clipping to clip.

See also print_().

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

This is an overloaded member function, provided for convenience.

Render the frame into painter.

### QString QWebFrame.renderTreeDump (self)

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

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

### 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.

See also toHtml().

### 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.

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.

See also toHtml().

### 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.setTextSizeMultiplier (self, float factor)

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

### float QWebFrame.textSizeMultiplier (self)

### QString QWebFrame.title (self)

### QString QWebFrame.toHtml (self)

Returns the frame's content, converted to HTML.

See also setHtml() and toPlainText().

### QString QWebFrame.toPlainText (self)

Returns the content of this frame converted to plain text.

See also toHtml().

### QUrl QWebFrame.url (self)

## Qt Signal Documentation

### void iconChanged ()

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

See also icon().

### void 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.

Note: A frame can be laid out multiple times.

### void 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 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 titleChanged (const QString&)

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