ItemGrabResult QML Type

Contains the results from a call to Item::grabToImage(). More...

Import Statement: import QtQuick
Instantiates: QQuickItemGrabResult




Detailed Description

The ItemGrabResult is a small container used to encapsulate the results from Item::grabToImage().

See also Item::grabToImage().

Property Documentation

[read-only] image : variant

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

[read-only] url : 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.

Method Documentation

bool saveToFile(fileName)

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

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.