QQuickView Class
The QQuickView class provides a window for displaying a Qt Quick user interface. More...
Header: | #include <QQuickView> |
qmake: | QT += quick |
Since: | Qt 5.0 |
Inherits: | QQuickWindow |
Public Types
enum | ResizeMode { SizeViewToRootObject, SizeRootObjectToView } |
enum | Status { Null, Ready, Loading, Error } |
Properties
- resizeMode : ResizeMode
- source : QUrl
- status : const Status
- 3 properties inherited from QQuickWindow
- 16 properties inherited from QWindow
- 1 property inherited from QObject
Public Functions
QQuickView(QWindow *parent = nullptr) | |
QQuickView(QQmlEngine *engine, QWindow *parent) | |
QQuickView(const QUrl &source, QWindow *parent = nullptr) | |
virtual | ~QQuickView() override |
QQmlEngine * | engine() const |
QList<QQmlError> | errors() const |
QSize | initialSize() const |
QQuickView::ResizeMode | resizeMode() const |
QQmlContext * | rootContext() const |
QQuickItem * | rootObject() const |
void | setResizeMode(QQuickView::ResizeMode) |
QUrl | source() const |
QQuickView::Status | status() const |
- 31 public functions inherited from QQuickWindow
- 82 public functions inherited from QWindow
- 31 public functions inherited from QObject
- 6 public functions inherited from QSurface
Public Slots
void | setSource(const QUrl &url) |
- 2 public slots inherited from QQuickWindow
- 24 public slots inherited from QWindow
- 1 public slot inherited from QObject
Signals
void | statusChanged(QQuickView::Status status) |
- 14 signals inherited from QQuickWindow
- 18 signals inherited from QWindow
- 2 signals inherited from QObject
Static Public Members
const QMetaObject | staticMetaObject |
- 7 static public members inherited from QQuickWindow
- 1 static public member inherited from QWindow
- 9 static public members inherited from QObject
Reimplemented Protected Functions
virtual void | keyPressEvent(QKeyEvent *e) override |
virtual void | keyReleaseEvent(QKeyEvent *e) override |
virtual void | mouseMoveEvent(QMouseEvent *e) override |
virtual void | mousePressEvent(QMouseEvent *e) override |
virtual void | mouseReleaseEvent(QMouseEvent *e) override |
- 14 protected functions inherited from QQuickWindow
- 18 protected functions inherited from QWindow
- 9 protected functions inherited from QObject
Detailed Description
The QQuickView class provides a window for displaying a Qt Quick user interface.
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.
Typical usage:
int main(int argc, char *argv[]) { QGuiApplication app(argc, argv); QQuickView *view = new QQuickView; view->setSource(QUrl::fromLocalFile("myqmlfile.qml")); view->show(); return app.exec(); }
To receive errors related to loading and executing QML with QQuickView, you can connect to the statusChanged() signal and monitor for QQuickView::Error. The errors are available via QQuickView::errors().
QQuickView also manages sizing of the view and root object. By default, the resizeMode is SizeViewToRootObject, which will load the component and resize it to the size of the view. Alternatively the resizeMode may be set to SizeRootObjectToView which will resize the view to the size of the root object.
See also Exposing Attributes of C++ Types to QML and QQuickWidget.
Member Type Documentation
enum QQuickView::ResizeMode
This enum specifies how to resize the view.
Constant | Value | Description |
---|---|---|
QQuickView::SizeViewToRootObject | 0 | The view resizes with the root item in the QML. |
QQuickView::SizeRootObjectToView | 1 | The view will automatically resize the root item to the size of the view. |
enum QQuickView::Status
Specifies the loading status of the QQuickView.
Constant | Value | Description |
---|---|---|
QQuickView::Null | 0 | This QQuickView has no source set. |
QQuickView::Ready | 1 | This QQuickView has loaded and created the QML component. |
QQuickView::Loading | 2 | This QQuickView is loading network data. |
QQuickView::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 window contents
If this property is set to SizeViewToRootObject (the default), the view resizes to the size of the root item in the QML.
If this property is set to SizeRootObjectToView, the view will automatically resize the root item to the size of the view.
Access functions:
QQuickView::ResizeMode | resizeMode() const |
void | setResizeMode(QQuickView::ResizeMode) |
See also initialSize().
source : QUrl
This property holds the URL of the source of the QML component.
Ensure that the URL provided is full and correct, in particular, use QUrl::fromLocalFile() when loading a file from the local filesystem.
Note that setting a source URL will result in the QML component being instantiated, even if the URL is unchanged from the current value.
Access functions:
status : const Status
The component's current status.
Access functions:
QQuickView::Status | status() const |
Notifier signal:
void | statusChanged(QQuickView::Status status) |
Member Function Documentation
QQuickView::QQuickView(QWindow *parent = nullptr)
Constructs a QQuickView with the given parent. The default value of parent is 0.
QQuickView::QQuickView(QQmlEngine *engine, QWindow *parent)
Constructs a QQuickView with the given QML engine and parent.
Note: In this case, the QQuickView does not own the given engine object; it is the caller's responsibility to destroy the engine. If the engine is deleted before the view, status() will return QQuickView::Error.
See also Status, status(), and errors().
QQuickView::QQuickView(const QUrl &source, QWindow *parent = nullptr)
Constructs a QQuickView with the given QML source and parent. The default value of parent is 0.
[override virtual]
QQuickView::~QQuickView()
Destroys the QQuickView.
QQmlEngine *QQuickView::engine() const
Returns a pointer to the QQmlEngine used for instantiating QML Components.
QList<QQmlError> QQuickView::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 QQuickView::initialSize() const
Returns the initial size of the root object.
If resizeMode is QQuickItem::SizeRootObjectToView the root object will be resized to the size of the view. initialSize contains the size of the root object before it was resized.
[override virtual protected]
void QQuickView::keyPressEvent(QKeyEvent *e)
Reimplemented from QQuickWindow::keyPressEvent().
[override virtual protected]
void QQuickView::keyReleaseEvent(QKeyEvent *e)
Reimplemented from QQuickWindow::keyReleaseEvent().
[override virtual protected]
void QQuickView::mouseMoveEvent(QMouseEvent *e)
Reimplemented from QQuickWindow::mouseMoveEvent().
[override virtual protected]
void QQuickView::mousePressEvent(QMouseEvent *e)
Reimplemented from QQuickWindow::mousePressEvent().
[override virtual protected]
void QQuickView::mouseReleaseEvent(QMouseEvent *e)
Reimplemented from QQuickWindow::mouseReleaseEvent().
QQmlContext *QQuickView::rootContext() const
This function returns the root of the context hierarchy. Each QML component is instantiated in a QQmlContext. QQmlContext's are essential for passing data to QML components. In QML, contexts are arranged hierarchically and this hierarchy is managed by the QQmlEngine.
QQuickItem *QQuickView::rootObject() const
Returns the view's root item.
[slot]
void QQuickView::setSource(const QUrl &url)
Sets the source to the url, loads the QML component and instantiates it.
Ensure that the URL provided is full and correct, in particular, use QUrl::fromLocalFile() when loading a file from the local filesystem.
Calling this method multiple times with the same url will result in the QML component being reinstantiated.
Note: Setter function for property source.
See also source().
QUrl QQuickView::source() const
Returns the source URL, if set.
Note: Getter function for property source.
See also setSource().
[signal]
void QQuickView::statusChanged(QQuickView::Status status)
This signal is emitted when the component's current status changes.
Note: Notifier signal for property status.
© 2019 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.