QDeclarativeView Class Reference

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

  1. #include <QDeclarativeView>

Inherits: QGraphicsView.

This class was introduced in Qt 4.7.

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:

  1. QDeclarativeView *view = new QDeclarativeView;
  2. view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
  3. view->show();

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.

Public Types

Toggle detailsenum QDeclarativeView::

ResizeModeResizeMode { SizeViewToRootObject , SizeRootObjectToView 1 ...} { SizeViewToRootObject , SizeRootObjectToView 1 }

This enum specifies how to resize the view.

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

Look up this member in the source code.

Toggle detailsenum QDeclarativeView::

StatusStatus { Null , Ready , Loading , Error 3 ...} { Null , Ready , Loading , Error 3 }

Specifies the loading status of the QDeclarativeView.

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

Look up this member in the source code.

    Properties

    Toggle detailsresizeModeresizeMode : 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:

    Look up this member in the source code.

    Toggle detailssourcesource : 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:

    Look up this member in the source code.

    Toggle detailsstatusstatus : const Status

    The component's current status.

    Access functions:

    Look up this member in the source code.

      Public Functions

      Toggle details QDeclarativeView

      QDeclarativeViewQDeclarativeView ( QWidget *parent=0 ) ( QWidget *parent=0 )

      Constructs a QDeclarativeView with the given parent.

      Look up this member in the source code.

      Toggle details QDeclarativeView

      QDeclarativeViewQDeclarativeView ( const QUrl &source , QWidget *parent=0 ...) ( const QUrl &source , QWidget *parent=0 )

      Constructs a QDeclarativeView with the given QML source and parent.

      Look up this member in the source code.

      Toggle details QDeclarativeView

      ~QDeclarativeView~QDeclarativeView () () [virtual]

      Destroys the view.

      Look up this member in the source code.

      Toggle details QDeclarativeEngine * QDeclarativeView

      engineengine () ()const

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

      Look up this member in the source code.

      Toggle details QList <QDeclarativeError > QDeclarativeView

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

      Look up this member in the source code.

      Toggle details QSize QDeclarativeView

      initialSizeinitialSize () ()const

      Returns the initial size of the root object

      Look up this member in the source code.

      Toggle details QDeclarativeContext * QDeclarativeView

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

      Look up this member in the source code.

      Toggle details QGraphicsObject * QDeclarativeView

      rootObjectrootObject () ()const

      Returns the view's root item.

      Look up this member in the source code.

        Signals

        Toggle details void QDeclarativeView

        sceneResizedsceneResized ( QSize size ) ( QSize size ) [signal]

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

        Look up this member in the source code.

        Toggle details void QDeclarativeView

        statusChangedstatusChanged ( QDeclarativeView::Status status ...) ( QDeclarativeView::Status status ) [signal]

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

        Look up this member in the source code.

          Notes provided by the Qt Community

          No notes