QQuickItemGrabResult Class

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

Header:	#include <QQuickItemGrabResult>
qmake:	QT += quick
Instantiated By:	ItemGrabResult
Inherits:	QObject

List of all members, including inherited members

Properties

image : const QImage
url : const QUrl

1 property inherited from QObject

Public Functions

QImage	image() const
bool	saveToFile(const QString &fileName) const
QUrl	url() const

33 public functions inherited from QObject

Signals

void	ready()

2 signals inherited from QObject

Additional Inherited Members

1 public slot inherited from QObject
1 public variable inherited from QObject
10 static public members inherited from QObject
9 protected functions inherited from QObject
2 protected variables inherited from QObject

Detailed Description

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

See also QQuickItem::grabToImage().

Property Documentation

image : const 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).

Access functions:

QImage image() const

url : const QUrl

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.

Access functions:

QUrl	url() const

Member Function Documentation

`[signal]` void QQuickItemGrabResult::ready()

This signal is emitted when the grab has completed.

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

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.

Note: This function can be invoked via the meta-object system and from QML. See Q_INVOKABLE.

Contents