Home · All Classes · All Functions · Overviews

QGraphicsWebView Class Reference
[
QtWebKit module]

The QGraphicsWebView class allows web content to be added to a GraphicsView. More...

 #include <QGraphicsWebView>

This class is not part of the Qt GUI Framework Edition.

Inherits QGraphicsWidget.

This class was introduced in Qt 4.6.


Properties


Public Functions

QGraphicsWebView ( QGraphicsItem * parent = 0 )
~QGraphicsWebView ()
QWebHistory * history () const
QIcon icon () const
bool isInteractive () const
void load ( const QUrl & url )
void load ( const QNetworkRequest & request, QNetworkAccessManager::Operation operation = QNetworkAccessManager::GetOperation, const QByteArray & body = QByteArray() )
QWebPage * page () const
qreal progress () const
void setContent ( const QByteArray & data, const QString & mimeType = QString(), const QUrl & baseUrl = QUrl() )
void setHtml ( const QString & html, const QUrl & baseUrl = QUrl() )
void setInteractive ( bool )
void setPage ( QWebPage * page )
void setUrl ( const QUrl & )
void setZoomFactor ( qreal )
QWebSettings * settings () const
QString status () const
QString title () const
QString toHtml () const
QUrl url () const
qreal zoomFactor () const

Reimplemented Public Functions

virtual bool event ( QEvent * event )
virtual void paint ( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = 0 )
virtual void setGeometry ( const QRectF & rect )
virtual void updateGeometry ()

Public Slots

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

Signals

void iconChanged ()
void interactivityChanged ()
void loadFailed ()
void loadFinished ()
void loadStarted ()
void progressChanged ( qreal )
void statusChanged ()
void titleChanged ( const QString & )
void urlChanged ( const QUrl & )
void zoomFactorChanged ()

Reimplemented Protected Functions

virtual void contextMenuEvent ( QGraphicsSceneContextMenuEvent * ev )
virtual void dragEnterEvent ( QGraphicsSceneDragDropEvent * ev )
virtual void dragLeaveEvent ( QGraphicsSceneDragDropEvent * ev )
virtual void dragMoveEvent ( QGraphicsSceneDragDropEvent * ev )
virtual void dropEvent ( QGraphicsSceneDragDropEvent * ev )
virtual void focusInEvent ( QFocusEvent * ev )
virtual bool focusNextPrevChild ( bool next )
virtual void focusOutEvent ( QFocusEvent * ev )
virtual void hoverLeaveEvent ( QGraphicsSceneHoverEvent * ev )
virtual void hoverMoveEvent ( QGraphicsSceneHoverEvent * ev )
virtual void inputMethodEvent ( QInputMethodEvent * ev )
virtual void keyPressEvent ( QKeyEvent * ev )
virtual void keyReleaseEvent ( QKeyEvent * ev )
virtual void mouseDoubleClickEvent ( QGraphicsSceneMouseEvent * ev )
virtual void mouseMoveEvent ( QGraphicsSceneMouseEvent * ev )
virtual void mousePressEvent ( QGraphicsSceneMouseEvent * ev )
virtual void mouseReleaseEvent ( QGraphicsSceneMouseEvent * ev )
virtual bool sceneEvent ( QEvent * event )
virtual void wheelEvent ( QGraphicsSceneWheelEvent * ev )

Additional Inherited Members


Detailed Description

The QGraphicsWebView class allows web content to be added to a GraphicsView.

A WebGraphicsItem renders web content based on a URL or set data.

If the width and height of the item is not set, they will dynamically adjust to a size appropriate for the content. This width may be large (eg. 980) for typical online web pages.


Property Documentation

html : QString

This property provides an HTML interface to the text in the webview.

When setting this property, external objects such as stylesheets or images referenced in the HTML document are located relative to baseUrl.

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

When using these methods, 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. Alternatively, the encoding can also be specified by the web server.

Access functions:

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

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

icon : const QIcon

This property holds the icon associated with the web page currently viewed.

By default, this property contains a null icon.

Access functions:

QIcon icon () const

Notifier signal:

void iconChanged ()

See also iconChanged() and QWebSettings::iconForUrl().

interactive : bool

This property holds controls whether the item responds to mouse and key events.

Access functions:

bool isInteractive () const
void setInteractive ( bool )

Notifier signal:

void interactivityChanged ()

progress : const qreal

This property holds the progress of loading the current URL, from 0 to 1.

Access functions:

qreal progress () const

Notifier signal:

void progressChanged ( qreal )

status : const QString

This property holds the load status message.

Provides the latest status message set during the load of a URL. Commonly shown by Status Bar widgets.

Access functions:

QString status () const

Notifier signal:

void statusChanged ()

See also statusChanged().

title : const QString

This property holds the title of the web page currently viewed.

By default, this property contains an empty string.

Access functions:

QString title () const

Notifier signal:

void titleChanged ( const QString & )

See also titleChanged().

url : QUrl

This property holds the url of the web page currently viewed.

Setting this property clears the view and loads the URL.

By default, this property contains an empty, invalid URL.

Access functions:

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

Notifier signal:

void urlChanged ( const QUrl & )

See also load() and urlChanged().

zoomFactor : qreal

This property holds the zoom factor for the view.

This property was introduced in Qt 4.5.

Access functions:

qreal zoomFactor () const
void setZoomFactor ( qreal )

Notifier signal:

void zoomFactorChanged ()

Member Function Documentation

QGraphicsWebView::QGraphicsWebView ( QGraphicsItem * parent = 0 )

Constructs an empty QGraphicsWebView with parent parent.

See also load().

QGraphicsWebView::~QGraphicsWebView ()

Destroys the web graphicsitem.

void QGraphicsWebView::back ()   [slot]

Convenience slot that loads the previous document in the list of documents built by navigating links. Does nothing if there is no previous document.

See also forward().

void QGraphicsWebView::contextMenuEvent ( QGraphicsSceneContextMenuEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::contextMenuEvent().

void QGraphicsWebView::dragEnterEvent ( QGraphicsSceneDragDropEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::dragEnterEvent().

void QGraphicsWebView::dragLeaveEvent ( QGraphicsSceneDragDropEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::dragLeaveEvent().

void QGraphicsWebView::dragMoveEvent ( QGraphicsSceneDragDropEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::dragMoveEvent().

void QGraphicsWebView::dropEvent ( QGraphicsSceneDragDropEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::dropEvent().

bool QGraphicsWebView::event ( QEvent * event )   [virtual]

Reimplemented from QObject::event().

void QGraphicsWebView::focusInEvent ( QFocusEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::focusInEvent().

bool QGraphicsWebView::focusNextPrevChild ( bool next )   [virtual protected]

Reimplemented from QGraphicsWidget::focusNextPrevChild().

void QGraphicsWebView::focusOutEvent ( QFocusEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::focusOutEvent().

void QGraphicsWebView::forward ()   [slot]

Convenience slot that loads the next document in the list of documents built by navigating links. Does nothing if there is no next document.

See also back().

QWebHistory * QGraphicsWebView::history () const

Returns a pointer to the view's history of navigated web pages.

It is equivalent to

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

void QGraphicsWebView::hoverLeaveEvent ( QGraphicsSceneHoverEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::hoverLeaveEvent().

void QGraphicsWebView::hoverMoveEvent ( QGraphicsSceneHoverEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::hoverMoveEvent().

void QGraphicsWebView::iconChanged ()   [signal]

void QGraphicsWebView::inputMethodEvent ( QInputMethodEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::inputMethodEvent().

void QGraphicsWebView::interactivityChanged ()   [signal]

void QGraphicsWebView::keyPressEvent ( QKeyEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::keyPressEvent().

void QGraphicsWebView::keyReleaseEvent ( QKeyEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::keyReleaseEvent().

void QGraphicsWebView::load ( const QUrl & url )

Loads the specified url and displays it.

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

See also setUrl(), url(), and urlChanged().

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

Loads a network request, request, 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 url.

See also url() and urlChanged().

void QGraphicsWebView::loadFailed ()   [signal]

void QGraphicsWebView::loadFinished ()   [signal]

void QGraphicsWebView::loadStarted ()   [signal]

void QGraphicsWebView::mouseDoubleClickEvent ( QGraphicsSceneMouseEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::mouseDoubleClickEvent().

void QGraphicsWebView::mouseMoveEvent ( QGraphicsSceneMouseEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::mouseMoveEvent().

void QGraphicsWebView::mousePressEvent ( QGraphicsSceneMouseEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::mousePressEvent().

void QGraphicsWebView::mouseReleaseEvent ( QGraphicsSceneMouseEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::mouseReleaseEvent().

QWebPage * QGraphicsWebView::page () const

Returns a pointer to the underlying web page.

See also setPage().

void QGraphicsWebView::paint ( QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = 0 )   [virtual]

Reimplemented from QGraphicsItem::paint().

void QGraphicsWebView::progressChanged ( qreal )   [signal]

void QGraphicsWebView::reload ()   [slot]

Reloads the current document.

See also stop() and loadStarted().

bool QGraphicsWebView::sceneEvent ( QEvent * event )   [virtual protected]

Reimplemented from QGraphicsItem::sceneEvent().

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

Sets the content of the web graphicsitem 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.

See also load(), setHtml(), and QWebFrame::toHtml().

void QGraphicsWebView::setGeometry ( const QRectF & rect )   [virtual]

Reimplemented from QGraphicsLayoutItem::setGeometry().

void QGraphicsWebView::setPage ( QWebPage * page )

Makes page the new web page of the web graphicsitem.

The parent QObject of the provided page remains the owner of the object. If the current document is a child of the web view, it will be deleted.

See also page().

QWebSettings * QGraphicsWebView::settings () const

Returns a pointer to the view/page specific settings object.

It is equivalent to

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

See also QWebSettings::globalSettings().

void QGraphicsWebView::statusChanged ()   [signal]

void QGraphicsWebView::stop ()   [slot]

Convenience slot that stops loading the document.

See also reload() and loadFinished().

void QGraphicsWebView::titleChanged ( const QString & )   [signal]

void QGraphicsWebView::updateGeometry ()   [virtual]

Reimplemented from QGraphicsLayoutItem::updateGeometry().

void QGraphicsWebView::urlChanged ( const QUrl & )   [signal]

void QGraphicsWebView::wheelEvent ( QGraphicsSceneWheelEvent * ev )   [virtual protected]

Reimplemented from QGraphicsItem::wheelEvent().

void QGraphicsWebView::zoomFactorChanged ()   [signal]


Copyright © 2009 Nokia Corporation and/or its subsidiary(-ies) Trademarks
Qt 4.6.0