\inmodule QtQuick More...

#include <qquickitemgrabresult.h>

Inheritance diagram for QQuickItemGrabResult:

Collaboration diagram for QQuickItemGrabResult:

Signals
void	ready ()
	This signal is emitted when the grab has completed.

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
QImage	image () const

QUrl	url () const

Q_INVOKABLE bool	saveToFile (const QString &fileName) const
	\qmlmethod bool QtQuick::ItemGrabResult::saveToFile(fileName)

	Q_REVISION (6, 2) Q_INVOKABLE bool saveToFile(const QUrl &fileName) const

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

Protected Member Functions
bool	event (QEvent *) override

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)

Properties
QImage	image
	\qmlproperty variant QtQuick::ItemGrabResult::image

QUrl	url
	\qmlproperty url QtQuick::ItemGrabResult::url

Properties inherited from QObject
QString	objectName
	the name of this object

Friends
class	QQuickItem

Additional Inherited Members
Public Slots inherited from QObject
void	deleteLater ()
	\threadsafe

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

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

\inmodule QtQuick

The QQuickItemGrabResult contains the result from QQuickItem::grabToImage().

See also: QQuickItem::grabToImage()

Definition at line 21 of file qquickitemgrabresult.h.

Member Function Documentation

◆ event()

bool QQuickItemGrabResult::event ( QEvent * e )

overrideprotectedvirtual

Reimplemented from QObject.

Definition at line 211 of file qquickitemgrabresult.cpp.

References d, QObject::deleteLater(), e, QObject::event(), Event_Grab_Completed, Q_EMIT, and ready().

Here is the call graph for this function:

◆ image()

QImage QQuickItemGrabResult::image ( ) const

Definition at line 202 of file qquickitemgrabresult.cpp.

References d.

◆ Q_REVISION()

QQuickItemGrabResult::Q_REVISION	(	6	,
		2
	)		const &

◆ ready

void QQuickItemGrabResult::ready ( )

signal

This signal is emitted when the grab has completed.

Referenced by event().

Here is the caller graph for this function:

◆ saveToFile()

bool QQuickItemGrabResult::saveToFile ( const QString & fileName ) const

\qmlmethod bool QtQuick::ItemGrabResult::saveToFile(fileName)

Saves the grab result as an image to fileName. Returns true if successful; otherwise returns false.

Note: In Qt versions prior to 5.9, this function is marked as non-{const}.

Since: 6.2 Saves the grab result as an image to filePath, which must refer to a \l{QUrl::isLocalFile}{local file name} with a \l{QImageWriter::supportedImageFormats()}{supported image format} extension. Returns true if successful; otherwise returns false.

Definition at line 157 of file qquickitemgrabresult.cpp.

References d, fileName, and saveToFile().

Referenced by saveToFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ url()

QUrl QQuickItemGrabResult::url ( ) const

Definition at line 195 of file qquickitemgrabresult.cpp.

References d.

Friends And Related Symbol Documentation

◆ QQuickItem

friend class QQuickItem

friend

Definition at line 55 of file qquickitemgrabresult.h.

Property Documentation

◆ image

QQuickItemGrabResult::image

read

\qmlproperty variant QtQuick::ItemGrabResult::image

This property holds the pixel results from a grab in the form of a QImage.

This property holds the pixel results from a grab.

If the grab is not yet complete or if it failed, a null image is returned ({image.isNull()} will return true).

Definition at line 60 of file qquickitemgrabresult.h.

◆ url

QQuickItemGrabResult::url

read

\qmlproperty url QtQuick::ItemGrabResult::url

This property holds a URL which can be used in conjunction with URL based image consumers, such as the QtQuick::Image type.

The URL is valid while there is a reference in QML or JavaScript to the ItemGrabResult or while the image the URL references is actively used.

The URL does not represent a valid file or location to read it from, it is primarily a key to access images through Qt Quick's image-based types.

This property holds a URL which can be used in conjunction with URL based image consumers, such as the QtQuick::Image type.

The URL is valid until the QQuickItemGrabResult object is deleted.

The URL does not represent a valid file or location to read it from, it is primarily a key to access images through Qt Quick's image-based types.

Definition at line 60 of file qquickitemgrabresult.h.

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

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

Signals

Public Member Functions

Protected Member Functions

Properties

Friends

Additional Inherited Members