MeeGo 1.2 Harmattan Developer Documentation Develop for the Nokia N9

QDeclarativeView Class Reference

The QDeclarativeView class provides a widget for displaying a Qt Declarative user interface. More...

 #include <QDeclarativeView>

Inherits: QGraphicsView.

This class was introduced in Qt 4.7.

Public Types

enum ResizeMode { SizeViewToRootObject, SizeRootObjectToView }
enum Status { Null, Ready, Loading, Error }


Public Functions

QDeclarativeView ( QWidget * parent = 0 )
QDeclarativeView ( const QUrl & source, QWidget * parent = 0 )
virtual ~QDeclarativeView ()
QDeclarativeEngine * engine () const
QList<QDeclarativeError> errors () const
QSize initialSize () const
ResizeMode resizeMode () const
QDeclarativeContext * rootContext () const
QGraphicsObject * rootObject () const
void setResizeMode ( ResizeMode )
void setSource ( const QUrl & url )
QUrl source () const
Status status () const


void sceneResized ( QSize size )
void statusChanged ( QDeclarativeView::Status status )

Additional Inherited Members

Detailed Description

The QDeclarativeView class provides a widget for displaying a Qt Declarative user interface.

QDeclarativeItem objects can be placed on a standard QGraphicsScene and displayed with QGraphicsView. QDeclarativeView is a QGraphicsView subclass provided as a convenience for displaying QML files, and connecting between QML and C++ Qt objects.

QDeclarativeView provides:

Typical usage:

 QDeclarativeView *view = new QDeclarativeView;

Since QDeclarativeView is a QWidget-based class, it can be used to display QML interfaces within QWidget-based GUI applications that do not use the Graphics View framework.

To receive errors related to loading and executing QML with QDeclarativeView, you can connect to the statusChanged() signal and monitor for QDeclarativeView::Error. The errors are available via QDeclarativeView::errors().

If you're using your own QGraphicsScene-based scene with QDeclarativeView, remember to enable scene's sticky focus mode and to set itemIndexMethod to QGraphicsScene::NoIndex.

See also Integrating QML Code with Existing Qt UI Code and Using QML Bindings in C++ Applications.

Member Type Documentation

enum QDeclarativeView::ResizeMode

This enum specifies how to resize the view.

Constant Value Description
QDeclarativeView::SizeViewToRootObject 0 The view resizes with the root item in the QML.
QDeclarativeView::SizeRootObjectToView 1 The view will automatically resize the root item to the size of the view.

enum QDeclarativeView::Status

Specifies the loading status of the QDeclarativeView.

Constant Value Description
QDeclarativeView::Null 0 This QDeclarativeView has no source set.
QDeclarativeView::Ready 1 This QDeclarativeView has loaded and created the QML component.
QDeclarativeView::Loading 2 This QDeclarativeView is loading network data.
QDeclarativeView::Error 3 One or more errors has occurred. Call errors() to retrieve a list of errors.

Property Documentation

resizeMode : ResizeMode

This property holds whether the view should resize the canvas contents.

If this property is set to SizeViewToRootObject (the default), the view resizes with the root item in the QML.

If this property is set to SizeRootObjectToView, the view will automatically resize the root item.

Regardless of this property, the sizeHint of the view is the initial size of the root item. Note though that since QML may load dynamically, that size may change.

Access functions:

ResizeMode resizeMode () const
void setResizeMode ( ResizeMode )

source : QUrl

This property holds the URL of the source of the QML component.

Changing this property causes the QML component to be reloaded.

Ensure that the URL provided is full and correct, in particular, use QUrl::fromLocalFile() when loading a file from the local filesystem.

Access functions:

QUrl source () const
void setSource ( const QUrl & url )

status : const Status

The component's current status.

Access functions:

Status status () const

Notifier signal:

void statusChanged ( QDeclarativeView::Status status )

Member Function Documentation

QDeclarativeView::QDeclarativeView ( QWidget * parent = 0 )

Constructs a QDeclarativeView with the given parent.

QDeclarativeView::QDeclarativeView ( const QUrl & source, QWidget * parent = 0 )

Constructs a QDeclarativeView with the given QML source and parent.

QDeclarativeView::~QDeclarativeView () [virtual]

Destroys the view.

QDeclarativeEngine * QDeclarativeView::engine () const

Returns a pointer to the QDeclarativeEngine used for instantiating QML Components.

QList<QDeclarativeError> QDeclarativeView::errors () const

Return the list of errors that occurred during the last compile or create operation. When the status is not Error, an empty list is returned.

QSize QDeclarativeView::initialSize () const

Returns the initial size of the root object

QDeclarativeContext * QDeclarativeView::rootContext () const

This function returns the root of the context hierarchy. Each QML component is instantiated in a QDeclarativeContext. QDeclarativeContext's are essential for passing data to QML components. In QML, contexts are arranged hierarchically and this hierarchy is managed by the QDeclarativeEngine.

QGraphicsObject * QDeclarativeView::rootObject () const

Returns the view's root item.

void QDeclarativeView::sceneResized ( QSize size ) [signal]

This signal is emitted when the view is resized to size.

void QDeclarativeView::statusChanged ( QDeclarativeView::Status status ) [signal]

This signal is emitted when the component's current status changes.