QImageIOHandler Class

成员函数文档

QImageIOHandler::QImageIOHandler()

构造一个 QImageIOHandler 对象。

[virtual noexcept] QImageIOHandler::~QImageIOHandler()

销毁QImageIOHandler 对象。

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

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

此函数在 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

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

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

另请参见 read()。

[virtual] QRect QImageIOHandler::currentImageRect() const

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

此函数对动画非常有用，因为动画一次只能更新帧的一部分。

QIODevice *QImageIOHandler::device() const

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

另请参阅 setDevice() 。

QByteArray QImageIOHandler::format() const

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

另请参阅 setFormat()。

[virtual] int QImageIOHandler::imageCount() const

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

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

[virtual] bool QImageIOHandler::jumpToImage(int imageNumber)

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

默认实现什么也不做，而是返回false 。

[virtual] bool QImageIOHandler::jumpToNextImage()

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

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

[virtual] int QImageIOHandler::loopCount() const

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

[virtual] int QImageIOHandler::nextImageDelay() const

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

[virtual] QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option) const

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

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

[pure virtual] 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 。该格式对支持多种图像格式的处理程序最有用。

该函数声明为常量，因此可以从canRead() 中调用。

另请参阅 format()。

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

用value 设置选项option 的值。

另请参阅 option() 和ImageOption 。

[virtual] bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option) const

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

另请参阅 setOption() 和option()。

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

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

默认实现不做任何操作，仅返回false 。