QQuickItemGrabResult Class

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

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

Properties

  • 1 property inherited from QObject

Public Functions

QImage image() const
bool saveToFile(const QString &fileName) const
QUrl url() const
  • 32 public functions inherited from QObject

Signals

void ready()

Additional Inherited Members

  • 1 public slot inherited from QObject
  • 11 static public members inherited from QObject
  • 9 protected functions 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, an empty image is returned.

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.

© 2017 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.