QImageIOHandler 类

成员函数文档

QImageIOHandler::QImageIOHandler()

构造QImageIOHandler对象。

[virtual noexcept] QImageIOHandler::~QImageIOHandler()

销毁QImageIOHandler对象。

[static, since 6.0] bool QImageIOHandler::allocateImage(QSize size, QImage::Format format, QImage *image)

这是子类中阅读功能的便捷方法。图像格式处理程序必须拒绝加载图像，如果所需的分配会超出当前的分配限制。此函数检查参数和限制，并在有效且需要时进行分配。成功返回后，image将是一个有效、分离的QImage，具有给定的size和format。

此函数是在Qt 6.0中引入的。

另请参阅 QImageReader::allocationLimit。

[pure virtual] bool QImageIOHandler::canRead() const

如果可以从设备（即图像格式受支持、设备可读，并且初始头部信息建议可以读取图像）中读取图像，则返回true；否则返回false。

在重新实现canRead()时，确保I/O设备（device）保持其原始状态（例如，通过使用peek()而不是read())。

另请参阅 read()和QIODevice::peek。

[virtual] int QImageIOHandler::currentImageNumber() const

对于支持动画的图像格式，此函数返回动画中当前图像的序列号。如果在此函数调用之前任何图像尚未读取，则返回-1。序列中第一张图像的编号为0。

如果图像格式不支持动画，则返回0。

另请参阅 read。

[virtual] QRect QImageIOHandler::currentImageRect() const

返回当前图像的矩形。如果没有为图像定义矩形，则返回空的QRect()。

此函数对于动画很有用，在动画中，每次可能只更新帧的一部分。

QIODevice *QImageIOHandler::device() const

返回当前分配给 QImageIOHandler 的设备。如果没有分配设备，则返回 nullptr。

另请参阅setDevice().

QByteArray QImageIOHandler::format() const

返回当前分配给 QImageIOHandler 的格式。如果没有分配格式，则返回空字符串。

另请参阅setFormat().

[虚函数] int QImageIOHandler::imageCount() const

对于支持动画的图像格式，此函数返回动画中的图像数量。如果图像格式不支持动画或无法确定图像数量，则返回 0。

默认实现：如果 canRead() 返回 true，则返回 1；否则返回 0。

[虚函数] bool QImageIOHandler::jumpToImage(int imageNumber)

对于支持动画的图像格式，此函数跳转到具有序列号 imageNumber 的图像。下一次调用 read() 将尝试读取此图像。

默认实现不执行任何操作，并返回 false。

[虚函数] bool QImageIOHandler::jumpToNextImage()

对于支持动画的图像格式，此函数跳转到下一幅图像。

默认实现不执行任何操作，并返回 false。

[虚函数] int QImageIOHandler::loopCount() const

对于支持动画的图像格式，此函数返回动画应该循环的次数。如果图像格式不支持动画，则返回 0。

[虚函数] int QImageIOHandler::nextImageDelay() const

对于支持动画的图像格式，此函数返回读取下一图像之前等待的毫秒数。如果图像格式不支持动画，则返回 0。

[纯虚函数] QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option) const

返回分配给 option 的值作为 QVariant。值的类型取决于选项。例如，选项(Size) 返回一个 QSize 变体。

另请参阅setOption() 和 supportsOption().

[纯虚函数] bool QImageIOHandler::read(QImage *image)

从设备读取图像，并将其存储在 image 中。如果图像成功读取，则返回 true；否则返回 false。

对于支持增量加载的图像格式以及动画格式，图像处理程序可以假设 image 指向上一帧。

另请参阅 canRead().

void QImageIOHandler::setDevice(QIODevice *device)

将 QImageIOHandler 的设备设置为 device。图像处理程序将在读取和写入图像时使用此设备。

设备只能设置一次，必须在调用 canRead()、read()、write() 等之前设置。如果需要读取多个文件，构造适当 QImageIOHandler 子类的多个实例。

另请参阅 device().

void QImageIOHandler::setFormat(const QByteArray &format)

将 QImageIOHandler 的格式设置为 format。对于支持多种图像格式的处理程序，格式最有用。

另请参阅 format().

void QImageIOHandler::setFormat(const QByteArray &format) const

将 QImageIOHandler 的格式设置为 format。对于支持多种图像格式的处理程序，格式最有用。

此函数被声明为 const，因此可以从 canRead() 调用。

另请参阅 format().

[虚拟] void QImageIOHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)

使用值 value 设置选项 option。

另请参阅 option() 和 ImageOption.

[虚拟] bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option) const

如果 QImageIOHandler 支持 option 选项，则返回 true；否则返回 false。例如，如果 QImageIOHandler 支持大小选项，则支持选项 (Size) 必须返回 true。

另请参阅 setOption() 和 option.

[虚拟] bool QImageIOHandler::write(const QImage &image)

将图像 image 写入指定的设备。成功则返回 true；否则返回 false。

默认实现什么都不做，直接返回 false。