diff options
author | Laszlo Agocs <laszlo.agocs@digia.com> | 2014-02-19 14:10:20 +0100 |
---|---|---|
committer | The Qt Project <gerrit-noreply@qt-project.org> | 2014-02-20 15:30:11 +0100 |
commit | 32ce3d2714c0e327d96183f99578417b89946f80 (patch) | |
tree | 3de91010101b2960b0ff20c90c07ec91d99cd538 | |
parent | 6df89c3b9d4e88d600c80aa3f39718fcab14fc6f (diff) |
Update QQuickWidget docs and changelog
Change-Id: I853295f31cf9367a8e11157c9ef0764174c614cf
Reviewed-by: Gunnar Sletta <gunnar.sletta@jollamobile.com>
-rw-r--r-- | dist/changes-5.3.0 | 6 | ||||
-rw-r--r-- | src/quickwidgets/qquickwidget.cpp | 20 |
2 files changed, 21 insertions, 5 deletions
diff --git a/dist/changes-5.3.0 b/dist/changes-5.3.0 index 5cda809d97..05550765d4 100644 --- a/dist/changes-5.3.0 +++ b/dist/changes-5.3.0 @@ -42,6 +42,12 @@ QtQml QtQuick ------ +- Introduced QQuickWidget. This is the equivalent of QQuickView in the + QWidget world. It allows easy and flexible embedding of QtQuick + scenes into widget-based application windows without the + restrictions imposed by QWidget::createWindowContainer(). + + **************************************************************************** * Database Drivers * **************************************************************************** diff --git a/src/quickwidgets/qquickwidget.cpp b/src/quickwidgets/qquickwidget.cpp index da95e03e5f..ec4ce2f314 100644 --- a/src/quickwidgets/qquickwidget.cpp +++ b/src/quickwidgets/qquickwidget.cpp @@ -166,14 +166,14 @@ void QQuickWidgetPrivate::renderSceneGraph() /*! \class QQuickWidget - \since 5.0 - \brief The QQuickWidget class provides a window for displaying a Qt Quick user interface. + \since 5.3 + \brief The QQuickWidget class provides a widget for displaying a Qt Quick user interface. \inmodule QtQuick - This is a convenience subclass of QQuickWindow which - will automatically load and display a QML scene when given the URL of the main source file. Alternatively, - you can instantiate your own objects using QQmlComponent and place them in a manually setup QQuickWindow. + This is a convenience wrapper for QQuickWindow which will automatically load and display a QML + scene when given the URL of the main source file. Alternatively, you can instantiate your own + objects using QQmlComponent and place them in a manually setup QQuickWidget. Typical usage: @@ -192,6 +192,16 @@ void QQuickWidgetPrivate::renderSceneGraph() size of the view. Alternatively the resizeMode may be set to SizeRootObjectToView which will resize the view to the size of the root object. + \note QQuickWidget is an alternative to using QQuickView and QWidget::createWindowContainer(). + The restrictions on stacking order do not apply, making QQuickWidget the more flexible + alternative behaving more like an ordinary widget. This comes at the expense of + performance. Unlike QQuickWindow and QQuickView, QQuickWidget involves rendering into OpenGL + framebuffer objects. This will naturally carry a minor performance hit. + + \note Using QQuickWidget disables the threaded render loop on all platforms. This means that + some of the benefits of threaded rendering, for example Animator classes and vsync driven + animations, will not be available. + \sa {qtqml-cppintegration-exposecppattributes.html}{Exposing Attributes of C++ Types to QML} */ |