PySide6.QtQuick.QQuickItemGrabResult

class QQuickItemGrabResult

The QQuickItemGrabResult contains the result from grabToImage() .

Details

See also

grabToImage()

Synopsis

Properties

• imageᅟ

• urlᅟ

Methods

• def image()

• def saveToFile()

• def url()

Signals

• def ready()

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Note

Properties can be used directly when from __feature__ import true_property is used or via accessor functions otherwise.

property imageᅟ: 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:

• image()

property urlᅟ: 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:

• url()

image()

Return type:

QImage

Getter of property imageᅟ .

ready()

This signal is emitted when the grab has completed.

saveToFile(fileName)

Parameters:

fileName – str

Return type:

bool

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.

saveToFile(fileName)

Parameters:

fileName – QUrl

Return type:

bool

Saves the grab result as an image to filePath, which must refer to a local file name with a supported image format extension. Returns true if successful; otherwise returns false.

url()

Return type:

QUrl

Getter of property urlᅟ .