QWebFrame Class Reference

    #include <QWebFrame>

Member Function Documentation

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

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 )

This is an overloaded function.

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 ownership of object is specified using own.

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

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

See also parentFrame().

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

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

This function was introduced in qtwebkit 4.6.

See also 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.

This function was introduced in qtwebkit 4.6.

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

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 ( QEvent * e ) [virtual]

Reimplemented from 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.

This function was introduced in qtwebkit 4.6.

See also 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.

This function was introduced in qtwebkit 4.6.

See also 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.

void QWebFrame::iconChanged () [signal]

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

See also icon().

void QWebFrame::initialLayoutCompleted () [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 QWebFrame::javaScriptWindowObjectCleared () [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 QWebFrame::load ( const 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().

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.

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

See also setUrl().

void QWebFrame::loadFinished ( bool ok ) [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 qtwebkit 4.6.

See also loadStarted().

void QWebFrame::loadStarted () [signal]

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

This function was introduced in qtwebkit 4.6.

See also 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.

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 qtwebkit 4.5.

QWebPage * QWebFrame::page () const

The web page that contains this frame.

See also pageChanged().

void QWebFrame::pageChanged () [signal]

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

This function was introduced in qtwebkit 4.7.

See also page().

QWebFrame * QWebFrame::parentFrame () const

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

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

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

Prints the frame to the given printer.

See also 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() )

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

This function was introduced in qtwebkit 4.6.

See also 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 pixels to the right and dy pixels downward. Both dx and dy may be negative.

This function was introduced in qtwebkit 4.5.

See also 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.

This function was introduced in qtwebkit 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.

See also scrollBarMinimum().

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

Returns the minimum value for the scrollbar with orientation orientation.

The minimum value is always 0.

See also scrollBarMaximum().

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

Returns the scrollbar policy for the scrollbar defined by orientation.

See also 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.

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

void QWebFrame::scrollToAnchor ( const QString & anchor )

Scrolls the frame to the given anchor name.

This function was introduced in qtwebkit 4.7.

QWebSecurityOrigin QWebFrame::securityOrigin () const

Returns the frame's security origin.

This function was introduced in qtwebkit 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. 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().

void QWebFrame::setFocus ()

Gives keyboard input focus to this frame.

This function was introduced in qtwebkit 4.6.

See also hasFocus().

void QWebFrame::setHtml ( const QString & html, const 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().

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

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

See also scrollBarPolicy().

void QWebFrame::setScrollBarValue ( 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().

void QWebFrame::setTextSizeMultiplier ( qreal factor )

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

See also textSizeMultiplier().

qreal QWebFrame::textSizeMultiplier () const

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

See also setTextSizeMultiplier().

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

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

See also title().

QString QWebFrame::toHtml () const

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

See also setHtml() and toPlainText().

QString QWebFrame::toPlainText () const

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

See also toHtml().

void QWebFrame::urlChanged ( const QUrl & url ) [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().