The QQuickView class provides a window for displaying a Qt Quick user interface. More...

#include <qquickview.h>

Inheritance diagram for QQuickView:

Collaboration diagram for QQuickView:

Public Types
enum	ResizeMode { SizeViewToRootObject , SizeRootObjectToView }
	This enum specifies how to resize the view. More...

enum	Status { Null , Ready , Loading , Error }
	Specifies the loading status of the QQuickView. More...

Public Types inherited from QSurface
enum	SurfaceClass { Window , Offscreen }
	The SurfaceClass enum describes the actual subclass of the surface. More...

enum	SurfaceType { RasterSurface , OpenGLSurface , RasterGLSurface , OpenVGSurface , VulkanSurface , MetalSurface , Direct3DSurface }
	The SurfaceType enum describes what type of surface this is. More...

Public Slots
void	setSource (const QUrl &)
	Sets the source to the url, loads the QML component and instantiates it.

void	setInitialProperties (const QVariantMap &initialProperties)
	Sets the initial properties initialProperties with which the QML component gets initialized after calling \l QQuickView::setSource().

void	setContent (const QUrl &url, QQmlComponent component, QObject item)

Public Slots inherited from QQuickWindow
void	update ()
	Schedules the window to render another frame.

void	releaseResources ()
	This function tries to release redundant resources currently held by the QML scene.

Public Slots inherited from QWindow
	Q_REVISION (2, 1) void requestActivate()

void	setVisible (bool visible)

void	show ()
	Shows the window.

void	hide ()
	Hides the window.

void	showMinimized ()
	Shows the window as minimized.

void	showMaximized ()
	Shows the window as maximized.

void	showFullScreen ()
	Shows the window as fullscreen.

void	showNormal ()
	Shows the window as normal, i.e.

bool	close ()
	Close the window.

void	raise ()
	Raise the window in the windowing system.

void	lower ()
	Lower the window in the windowing system.

bool	startSystemResize (Qt::Edges edges)
	Start a system-specific resize operation.

bool	startSystemMove ()
	Start a system-specific move operation.

void	setTitle (const QString &)

void	setX (int arg)

void	setY (int arg)

void	setWidth (int arg)

void	setHeight (int arg)

void	setGeometry (int posx, int posy, int w, int h)
	Sets the geometry of the window, excluding its window frame, to a rectangle constructed from posx, posy, w and h.

void	setGeometry (const QRect &rect)
	Sets the geometry of the window, excluding its window frame, to rect.

void	setMinimumWidth (int w)

void	setMinimumHeight (int h)

void	setMaximumWidth (int w)

void	setMaximumHeight (int h)

	Q_REVISION (2, 1) void alert(int msec)

	Q_REVISION (2, 3) void requestUpdate()

Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

Signals
void	statusChanged (QQuickView::Status)
	This signal is emitted when the component's current status changes.

Signals inherited from QQuickWindow
void	frameSwapped ()
	This signal is emitted when a frame has been queued for presenting.

void	sceneGraphInitialized ()
	\qmlsignal QtQuick::Window::frameSwapped()

void	sceneGraphInvalidated ()
	\qmlsignal QtQuick::Window::sceneGraphInitialized()

void	beforeSynchronizing ()
	This signal is emitted before the scene graph is synchronized with the QML state.

	Q_REVISION (2, 2) void afterSynchronizing()

void	beforeRendering ()
	\qmlsignal QtQuick::Window::afterSynchronizing()

void	afterRendering ()
	\qmlsignal QtQuick::Window::beforeRendering()

	Q_REVISION (2, 2) void afterAnimating()

	Q_REVISION (2, 2) void sceneGraphAboutToStop()

	Q_REVISION (2, 1) void closing(QQuickCloseEvent *close)

void	colorChanged (const QColor &)

	Q_REVISION (2, 1) void activeFocusItemChanged()

Q_REVISION(2, 2) void sceneGraphError(QQuickWindow	Q_REVISION (2, 14) void beforeRenderPassRecording()

	Q_REVISION (2, 14) void afterRenderPassRecording()

	Q_REVISION (6, 0) void paletteChanged()

	Q_REVISION (6, 0) void paletteCreated()

	Q_REVISION (6, 0) void beforeFrameBegin()

	Q_REVISION (6, 0) void afterFrameEnd()

Signals inherited from QWindow
void	screenChanged (QScreen *screen)
	This signal is emitted when a window's screen changes, either by being set explicitly with setScreen(), or automatically when the window's screen is removed.

void	modalityChanged (Qt::WindowModality modality)
	This signal is emitted when the Qwindow::modality property changes to modality.

void	windowStateChanged (Qt::WindowState windowState)
	This signal is emitted when the windowState changes, either by being set explicitly with setWindowStates(), or automatically when the user clicks one of the titlebar buttons or by other means.

	Q_REVISION (2, 2) void windowTitleChanged(const QString &title)

void	xChanged (int arg)

void	yChanged (int arg)

void	widthChanged (int arg)

void	heightChanged (int arg)

void	minimumWidthChanged (int arg)

void	minimumHeightChanged (int arg)

void	maximumWidthChanged (int arg)

void	maximumHeightChanged (int arg)

void	visibleChanged (bool arg)

Q_REVISION(2, 1) void visibilityChanged(QWindow	Q_REVISION (2, 1) void activeChanged()

void	contentOrientationChanged (Qt::ScreenOrientation orientation)

void	focusObjectChanged (QObject *object)
	This signal is emitted when the final receiver of events tied to focus is changed to object.

	Q_REVISION (2, 1) void opacityChanged(qreal opacity)

	Q_REVISION (2, 13) void transientParentChanged(QWindow *transientParent)

Signals inherited from QObject
void	destroyed (QObject *=nullptr)
	This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.

void	objectNameChanged (const QString &objectName, QPrivateSignal)
	This signal is emitted after the object's name has been changed.

Public Member Functions
	QQuickView (QWindow *parent=nullptr)
	Constructs a QQuickView with the given parent.

	QQuickView (QQmlEngine engine, QWindow parent)
	Constructs a QQuickView with the given QML engine and parent.

	QQuickView (const QUrl &source, QWindow *parent=nullptr)
	Constructs a QQuickView with the given QML source and parent.

	QQuickView (const QUrl &source, QQuickRenderControl *renderControl)

	~QQuickView () override
	Destroys the QQuickView.

QUrl	source () const
	Returns the source URL, if set.

QQmlEngine *	engine () const
	Returns a pointer to the QQmlEngine used for instantiating QML Components.

QQmlContext *	rootContext () const
	This function returns the root of the context hierarchy.

QQuickItem *	rootObject () const
	Returns the view's root \l {QQuickItem} {item}.

ResizeMode	resizeMode () const

void	setResizeMode (ResizeMode)

Status	status () const

QList< QQmlError >	errors () const
	Return the list of errors that occurred during the last compile or create operation.

QSize	sizeHint () const

QSize	initialSize () const
	Returns the initial size of the root object.

Public Member Functions inherited from QObject
Q_INVOKABLE	QObject (QObject *parent=nullptr)
	Constructs an object with parent object parent.

virtual	~QObject ()
	Destroys the object, deleting all its child objects.

virtual bool	event (QEvent *event)
	This virtual function receives events to an object and should return true if the event e was recognized and processed.

virtual bool	eventFilter (QObject watched, QEvent event)
	Filters events if this object has been installed as an event filter for the watched object.

QString	objectName () const

Q_WEAK_OVERLOAD void	setObjectName (const QString &name)
	Sets the object's name to name.

void	setObjectName (QAnyStringView name)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QBindable< QString >	bindableObjectName ()

bool	isWidgetType () const
	Returns `true` if the object is a widget; otherwise returns `false`.

bool	isWindowType () const
	Returns `true` if the object is a window; otherwise returns `false`.

bool	isQuickItemType () const
	Returns `true` if the object is a QQuickItem; otherwise returns `false`.

bool	signalsBlocked () const noexcept
	Returns `true` if signals are blocked; otherwise returns `false`.

bool	blockSignals (bool b) noexcept
	If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).

QThread *	thread () const
	Returns the thread in which the object lives.

void	moveToThread (QThread *thread)
	Changes the thread affinity for this object and its children.

int	startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
	This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.

int	startTimer (std::chrono::milliseconds time, Qt::TimerType timerType=Qt::CoarseTimer)

void	killTimer (int id)
	Kills the timer with timer identifier, id.

template<typename T >
T	findChild (const QString &aName=QString(), Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.

template<typename T >
QList< T >	findChildren (const QString &aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.

template<typename T >
QList< T >	findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

const QObjectList &	children () const
	Returns a list of child objects.

void	setParent (QObject *parent)
	Makes the object a child of parent.

void	installEventFilter (QObject *filterObj)
	Installs an event filter filterObj on this object.

void	removeEventFilter (QObject *obj)
	Removes an event filter object obj from this object.

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const

bool	disconnect (const char signal=nullptr, const QObject receiver=nullptr, const char *member=nullptr) const

bool	disconnect (const QObject receiver, const char member=nullptr) const

void	dumpObjectTree () const
	Dumps a tree of children to the debug output.

void	dumpObjectInfo () const
	Dumps information about signal connections, etc.

bool	setProperty (const char *name, const QVariant &value)
	Sets the value of the object's name property to value.

bool	setProperty (const char *name, QVariant &&value)

QVariant	property (const char *name) const
	Returns the value of the object's name property.

QList< QByteArray >	dynamicPropertyNames () const

QBindingStorage *	bindingStorage ()

const QBindingStorage *	bindingStorage () const

QObject *	parent () const
	Returns a pointer to the parent object.

bool	inherits (const char *classname) const
	Returns `true` if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns `false`.

Public Member Functions inherited from QSurface
virtual	~QSurface ()
	Destroys the surface.

SurfaceClass	surfaceClass () const
	Returns the surface class of this surface.

virtual QSurfaceFormat	format () const =0
	Returns the format of the surface.

virtual QPlatformSurface *	surfaceHandle () const =0
	Returns a handle to the platform-specific implementation of the surface.

virtual SurfaceType	surfaceType () const =0
	Returns the type of the surface.

bool	supportsOpenGL () const
	Returns true if the surface is OpenGL compatible and can be used in conjunction with QOpenGLContext; otherwise returns false.

virtual QSize	size () const =0
	Returns the size of the surface in pixels.

Protected Member Functions
void	resizeEvent (QResizeEvent *) override

void	timerEvent (QTimerEvent *) override

void	keyPressEvent (QKeyEvent *) override
	\reimp

void	keyReleaseEvent (QKeyEvent *) override
	\reimp

void	mousePressEvent (QMouseEvent *) override
	\reimp

void	mouseReleaseEvent (QMouseEvent *) override
	\reimp

void	mouseMoveEvent (QMouseEvent *) override
	\reimp

Protected Member Functions inherited from QQuickWindow
	QQuickWindow (QQuickWindowPrivate &dd, QWindow *parent=nullptr)

	QQuickWindow (QQuickWindowPrivate &dd, QQuickRenderControl *control)

void	exposeEvent (QExposeEvent *) override
	\reimp

void	resizeEvent (QResizeEvent *) override
	\reimp

void	showEvent (QShowEvent *) override
	\reimp

void	hideEvent (QHideEvent *) override
	\reimp

void	closeEvent (QCloseEvent *) override
	\reimp

void	focusInEvent (QFocusEvent *) override
	\reimp

void	focusOutEvent (QFocusEvent *) override
	\reimp

bool	event (QEvent *) override
	\reimp

void	keyPressEvent (QKeyEvent *) override
	\reimp

void	keyReleaseEvent (QKeyEvent *) override
	\reimp

void	mousePressEvent (QMouseEvent *) override
	\reimp

void	mouseReleaseEvent (QMouseEvent *) override
	\reimp

void	mouseDoubleClickEvent (QMouseEvent *) override
	\reimp

void	mouseMoveEvent (QMouseEvent *) override
	\reimp

Protected Member Functions inherited from QWindow
virtual void	exposeEvent (QExposeEvent *)
	The expose event (ev) is sent by the window system when a window moves between the un-exposed and exposed states.

virtual void	resizeEvent (QResizeEvent *)
	Override this to handle resize events (ev).

virtual void	paintEvent (QPaintEvent *)
	The paint event (ev) is sent by the window system whenever an area of the window needs a repaint, for example when initially showing the window, or due to parts of the window being uncovered by moving another window.

virtual void	moveEvent (QMoveEvent *)
	Override this to handle window move events (ev).

virtual void	focusInEvent (QFocusEvent *)
	Override this to handle focus in events (ev).

virtual void	focusOutEvent (QFocusEvent *)
	Override this to handle focus out events (ev).

virtual void	showEvent (QShowEvent *)
	Override this to handle show events (ev).

virtual void	hideEvent (QHideEvent *)
	Override this to handle hide events (ev).

virtual void	closeEvent (QCloseEvent *)
	Override this to handle close events (ev).

virtual bool	event (QEvent *) override
	Override this to handle any event (ev) sent to the window.

virtual void	keyPressEvent (QKeyEvent *)
	Override this to handle key press events (ev).

virtual void	keyReleaseEvent (QKeyEvent *)
	Override this to handle key release events (ev).

virtual void	mousePressEvent (QMouseEvent *)
	Override this to handle mouse press events (ev).

virtual void	mouseReleaseEvent (QMouseEvent *)
	Override this to handle mouse release events (ev).

virtual void	mouseDoubleClickEvent (QMouseEvent *)
	Override this to handle mouse double click events (ev).

virtual void	mouseMoveEvent (QMouseEvent *)
	Override this to handle mouse move events (ev).

virtual void	touchEvent (QTouchEvent *)
	Override this to handle touch events (ev).

virtual bool	nativeEvent (const QByteArray &eventType, void message, qintptr result)
	Override this to handle platform dependent events.

	QWindow (QWindowPrivate &dd, QWindow *parent)
	Creates a window as a child of the given parent window with the dd private implementation.

Protected Member Functions inherited from QObject
QObject *	sender () const
	Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.

int	senderSignalIndex () const

int	receivers (const char *signal) const
	Returns the number of receivers connected to the signal.

bool	isSignalConnected (const QMetaMethod &signal) const

virtual void	timerEvent (QTimerEvent *event)
	This event handler can be reimplemented in a subclass to receive timer events for the object.

virtual void	childEvent (QChildEvent *event)
	This event handler can be reimplemented in a subclass to receive child events.

virtual void	customEvent (QEvent *event)
	This event handler can be reimplemented in a subclass to receive custom events.

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	disconnectNotify (const QMetaMethod &signal)

	QObject (QObjectPrivate &dd, QObject *parent=nullptr)

Protected Member Functions inherited from QSurface
	QSurface (SurfaceClass type)
	Creates a surface with the given type.

Properties
ResizeMode	resizeMode
	whether the view should resize the window contents

Status	status
	The component's current \l{QQuickView::Status} {status}.

QUrl	source
	The URL of the source of the QML component.

Properties inherited from QQuickWindow
QColor	color
	\qmlproperty color Window::color

QQuickItem *	contentItem
	\qmlattachedproperty Item Window::contentItem

QQuickItem *	activeFocusItem
	The item which currently has active focus or `null` if there is no item with active focus.

Properties inherited from QWindow
QString	title
	the window's title in the windowing system

Qt::WindowModality	modality
	the modality of the window

Qt::WindowFlags	flags
	the window flags of the window

int	x
	the x position of the window's geometry

int	y
	the y position of the window's geometry

int	width
	the width of the window's geometry

int	height
	the height of the window's geometry

int	minimumWidth
	the minimum width of the window's geometry

int	minimumHeight
	the minimum height of the window's geometry

int	maximumWidth
	the maximum width of the window's geometry

int	maximumHeight
	the maximum height of the window's geometry

bool	visible
	whether the window is visible or not

bool	active
	the active status of the window

Visibility	visibility
	the screen-occupation state of the window

Qt::ScreenOrientation	contentOrientation
	the orientation of the window's contents

qreal	opacity
	The opacity of the window in the windowing system.

Properties inherited from QObject
QString	objectName
	the name of this object

Additional Inherited Members
Static Public Member Functions inherited from QObject
static QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char member, Qt::ConnectionType=Qt::AutoConnection)
	\threadsafe

static QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)

template<typename Func1 , typename Func2 >
static QMetaObject::Connection	connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)

static bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char member)
	\threadsafe

static bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &member)

static bool	disconnect (const QMetaObject::Connection &)
	Disconnect a connection.

template<typename Func1 , typename Func2 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object receiver, Func2 slot)

template<typename Func1 >
static bool	disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object sender, Func1 signal, const QObject receiver, void **zero)

Protected Attributes inherited from QObject
QScopedPointer< QObjectData >	d_ptr

Protected Attributes inherited from QSurface
SurfaceClass	m_type

QSurfacePrivate *	m_reserved

Related Symbols inherited from QObject
template< class T > T	qobject_cast (const QObject *object)
	Returns the given object cast to type T if the object is of type T (or of a subclass); otherwise returns \nullptr.

template< typename T > T	qFindChildqFindChildren (const QObject *obj, const QString &name)()

template< typename T > QList< T >	qFindChildrenqFindChildren (const QObject *obj, const QString &name)()

	QObjectList
	\macro Q_CLASSINFO(Name, Value)

Detailed Description

The QQuickView class provides a window for displaying a Qt Quick user interface.

Since: 5.0

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

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 \l 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}, QQuickWidget

Definition at line 19 of file qquickview.h.

Member Enumeration Documentation

◆ ResizeMode

enum QQuickView::ResizeMode

This enum specifies how to resize the view.

\value SizeViewToRootObject The view resizes with the root item in the QML. \value SizeRootObjectToView The view will automatically resize the root item to the size of the view.

Enumerator
SizeViewToRootObject
SizeRootObjectToView

Definition at line 39 of file qquickview.h.

◆ Status

enum QQuickView::Status

Specifies the loading status of the QQuickView.

\value Null This QQuickView has no source set. \value Ready This QQuickView has loaded and created the QML component. \value Loading This QQuickView is loading network data. \value Error One or more errors has occurred. Call errors() to retrieve a list of errors.

Enumerator
Null
Ready
Loading
Error

Definition at line 44 of file qquickview.h.

Constructor & Destructor Documentation

◆ QQuickView() [1/4]

QQuickView::QQuickView ( QWindow * parent = nullptr )

explicit

Constructs a QQuickView with the given parent.

The default value of parent is 0.

Definition at line 124 of file qquickview.cpp.

◆ QQuickView() [2/4]

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(), errors()

Definition at line 150 of file qquickview.cpp.

References engine(), and Q_ASSERT.

Here is the call graph for this function:

◆ QQuickView() [3/4]

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

explicit

Constructs a QQuickView with the given QML source and parent.

The default value of parent is 0.

Definition at line 135 of file qquickview.cpp.

References setSource().

Here is the call graph for this function:

◆ QQuickView() [4/4]

QQuickView::QQuickView	(	const QUrl &	source,
		QQuickRenderControl *	control
	)

Definition at line 160 of file qquickview.cpp.

References setSource().

Here is the call graph for this function:

◆ ~QQuickView()

QQuickView::~QQuickView ( )

override

Destroys the QQuickView.

Definition at line 170 of file qquickview.cpp.

References d.

Member Function Documentation

◆ engine()

QQmlEngine * QQuickView::engine ( ) const

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

Definition at line 265 of file qquickview.cpp.

References d.

Referenced by QQuickView(), main(), and quick_test_main_with_setup().

Here is the caller graph for this function:

◆ errors()

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.

Definition at line 327 of file qquickview.cpp.

References d, error, and QQmlComponent::Ready.

Referenced by QQuickTest::initView(), and quick_test_main_with_setup().

Here is the caller graph for this function:

◆ initialSize()

QSize QQuickView::initialSize ( ) const

Returns the initial size of the root object.

If \l 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.

Definition at line 559 of file qquickview.cpp.

References d.

◆ keyPressEvent()

void QQuickView::keyPressEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWindow.

Definition at line 589 of file qquickview.cpp.

References e, and QQuickWindow::keyPressEvent().

Here is the call graph for this function:

◆ keyReleaseEvent()

void QQuickView::keyReleaseEvent ( QKeyEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWindow.

Definition at line 595 of file qquickview.cpp.

References e, and QQuickWindow::keyReleaseEvent().

Here is the call graph for this function:

◆ mouseMoveEvent()

void QQuickView::mouseMoveEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWindow.

Definition at line 601 of file qquickview.cpp.

References e, and QQuickWindow::mouseMoveEvent().

Here is the call graph for this function:

◆ mousePressEvent()

void QQuickView::mousePressEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWindow.

Definition at line 607 of file qquickview.cpp.

References e, and QQuickWindow::mousePressEvent().

Here is the call graph for this function:

◆ mouseReleaseEvent()

void QQuickView::mouseReleaseEvent ( QMouseEvent * e )

overrideprotectedvirtual

\reimp

Reimplemented from QWindow.

Definition at line 613 of file qquickview.cpp.

References e, and QQuickWindow::mouseReleaseEvent().

Here is the call graph for this function:

◆ resizeEvent()

void QQuickView::resizeEvent ( QResizeEvent * e )

overrideprotectedvirtual

This function handles the \l {QResizeEvent} {resize event} e.

Reimplemented from QWindow.

Definition at line 579 of file qquickview.cpp.

References d, e, QQuickWindow::resizeEvent(), and SizeRootObjectToView.

Here is the call graph for this function:

◆ resizeMode()

QQuickView::ResizeMode QQuickView::resizeMode ( ) const

Definition at line 433 of file qquickview.cpp.

References d.

◆ rootContext()

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.

Definition at line 278 of file qquickview.cpp.

References d.

Referenced by main(), main(), and quick_test_main_with_setup().

Here is the caller graph for this function:

◆ rootObject()

QQuickItem * QQuickView::rootObject ( ) const

Returns the view's root \l {QQuickItem} {item}.

Definition at line 568 of file qquickview.cpp.

References d.

Referenced by QQuick3DLightmapBaker::bake(), QQmlDebugTranslationServicePrivate::currentRootItem(), main(), and QQuickTest::showView().

Here is the caller graph for this function:

◆ setContent

void QQuickView::setContent	(	const QUrl &	url,
		QQmlComponent *	component,
		QObject *	item
	)

slot

Set the source url, component and content item (root of the QML object hierarchy) directly.

Definition at line 229 of file qquickview.cpp.

References component(), d, emit, error, item, status, statusChanged(), url, and QMessageLogger::warning().

Here is the call graph for this function:

◆ setInitialProperties

void QQuickView::setInitialProperties ( const QVariantMap & initialProperties )

slot

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

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

Note: 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.

See also: QQmlComponent::createWithInitialProperties()

Since: 5.14

Definition at line 218 of file qquickview.cpp.

References d.

Referenced by makeDocTeamHappyByKeepingExampleCompilable().

Here is the caller graph for this function:

◆ setResizeMode()

void QQuickView::setResizeMode ( ResizeMode mode )

Definition at line 361 of file qquickview.cpp.

References d, QQuickItemPrivate::Geometry, QQuickItemPrivate::get(), and SizeViewToRootObject.

Here is the call graph for this function:

◆ setSource

void QQuickView::setSource ( const QUrl & url )

slot

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 \l 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.

Definition at line 198 of file qquickview.cpp.

References d, and url.

Referenced by QQuickView(), QQuickView(), QQuick3DLightmapBaker::bake(), QQuickTest::initView(), main(), main(), makeDocTeamHappyByKeepingExampleCompilable(), and quick_test_main_with_setup().

Here is the caller graph for this function:

◆ sizeHint()

QSize QQuickView::sizeHint ( ) const

Preferred size follows the root object geometry.

Definition at line 541 of file qquickview.cpp.

References d, QSize::isEmpty(), and QWindow::size().

Here is the call graph for this function:

◆ source()

QUrl QQuickView::source ( ) const

Returns the source URL, if set.

See also: setSource()

Definition at line 255 of file qquickview.cpp.

References d.

◆ status()

QQuickView::Status QQuickView::status ( ) const

Definition at line 308 of file qquickview.cpp.

References d, Error, Null, and QQmlComponent::Ready.

◆ statusChanged

void QQuickView::statusChanged ( QQuickView::Status status )

signal

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

Referenced by setContent().

Here is the caller graph for this function:

◆ timerEvent()

void QQuickView::timerEvent ( QTimerEvent * e )

overrideprotectedvirtual

If the \l {QTimerEvent} {timer event} e is this view's resize timer, sceneResized() is emitted.

Reimplemented from QObject.

Definition at line 528 of file qquickview.cpp.

References d, and e.

Property Documentation

◆ resizeMode

QQuickView::resizeMode

readwrite

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.

See also: initialSize()

Definition at line 78 of file qquickview.h.

◆ source

QQuickView::source

readwrite

The URL of the source of the QML component.

Ensure that the URL provided is full and correct, in particular, use \l 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.

Definition at line 78 of file qquickview.h.

◆ status

QQuickView::status

read

The component's current \l{QQuickView::Status} {status}.

Definition at line 78 of file qquickview.h.

Referenced by QQuickTest::initView(), quick_test_main_with_setup(), and setContent().

The documentation for this class was generated from the following files:

qtdeclarative/src/quick/items/qquickview.h
qtdeclarative/src/quick/items/qquickview.cpp

Public Types

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ResizeMode

◆ Status

Constructor & Destructor Documentation

◆ QQuickView() [1/4]

◆ QQuickView() [2/4]

◆ QQuickView() [3/4]

◆ QQuickView() [4/4]

◆ ~QQuickView()

Member Function Documentation

◆ engine()

◆ errors()

◆ initialSize()

◆ keyPressEvent()

◆ keyReleaseEvent()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ resizeEvent()

◆ resizeMode()

◆ rootContext()

◆ rootObject()

◆ setContent

◆ setInitialProperties

◆ setResizeMode()

◆ setSource

◆ sizeHint()

◆ source()

◆ status()

◆ statusChanged

◆ timerEvent()

Property Documentation

◆ resizeMode

◆ source

◆ status