QQuickView 类

QQuickView 类提供用于显示 Qt Quick 用户界面的窗口。 更多...

Header: #include <QQuickView>
CMake: find_package(Qt6 COMPONENTS Quick REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::Quick)
qmake: QT += quick
Since: Qt 5.0
继承: QQuickWindow

公共类型

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

特性

公共函数

QQuickView (const QUrl & source , QWindow * parent = nullptr)
QQuickView (QQmlEngine * engine , QWindow * parent )
QQuickView (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

公共槽

void setInitialProperties (const QVariantMap & initialProperties )
void setSource (const QUrl & url )

信号

void statusChanged (QQuickView::Status status )

重实现保护函数

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

详细描述

这是方便子类化的 QQuickWindow 将自动加载并显示 QML 场景当有给出主源文件的 URL 时。另外,可以实例化自己的对象使用 QQmlComponent 并放置它们以手动设置 QQuickWindow .

典型用法:

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.

另请参阅 将 C++ 类型属性暴露给 QML and QQuickWidget .

成员类型文档编制

enum QQuickView:: ResizeMode

This enum specifies how to resize the view.

常量 描述
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 .

常量 描述
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.

特性文档编制

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.

访问函数:

QQuickView::ResizeMode resizeMode () const
void setResizeMode (QQuickView::ResizeMode)

另请参阅 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.

访问函数:

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

[read-only] status : const Status

The component's current status .

访问函数:

QQuickView::Status status () const

通知程序信号:

void statusChanged (QQuickView::Status status )

成员函数文档编制

QQuickView:: QQuickView (const QUrl & source , QWindow * parent = nullptr)

Constructs a QQuickView with the given QML source and parent . The default value of parent 为 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 () 会返回 QQuickView::Error .

另请参阅 Status , status (),和 errors ().

QQuickView:: QQuickView ( QWindow * parent = nullptr)

Constructs a QQuickView with the given parent . The default value of parent 为 0。

[slot, since 5.14] void QQuickView:: setInitialProperties (const QVariantMap & initialProperties )

Sets the initial properties initialProperties with which the QML component gets initialized after calling QQuickView::setSource ().

    QScopedPointer<QQuickView> view { new QQuickView };
    view->setInitialProperties({"x, 100"}, {"width", 50});
    view->setSource(QUrl::fromLocalFile("myqmlfile.qml"));
    view->show();
							

注意: You can only use this function to initialize top-level properties.

注意: This function should always be called before setSource , as it has no effect once the component has become Ready .

该函数在 Qt 5.14 引入。

另请参阅 QQmlComponent::createWithInitialProperties ().

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

注意: Setter 函数为特性 source .

另请参阅 source ().

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

This signal is emitted when the component's current status 改变。

注意: 通知程序信号为特性 status .

[override virtual] QQuickView:: ~QQuickView ()

销毁 QQuickView .

QQmlEngine *QQuickView:: engine () const

返回指针指向 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.

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 )

重实现: QQuickWindow::keyPressEvent (QKeyEvent *e).

[override virtual protected] void QQuickView:: keyReleaseEvent ( QKeyEvent * e )

重实现: QQuickWindow::keyReleaseEvent (QKeyEvent *e).

[override virtual protected] void QQuickView:: mouseMoveEvent ( QMouseEvent * e )

重实现: QQuickWindow::mouseMoveEvent (QMouseEvent *event).

[override virtual protected] void QQuickView:: mousePressEvent ( QMouseEvent * e )

重实现: QQuickWindow::mousePressEvent (QMouseEvent *event).

[override virtual protected] void QQuickView:: mouseReleaseEvent ( QMouseEvent * e )

重实现: QQuickWindow::mouseReleaseEvent (QMouseEvent *event).

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 .

QUrl QQuickView:: source () const

Returns the source URL, if set.

注意: Getter 函数对于特性 source。

另请参阅 setSource ().