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 将是一个有效的、已分离的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

对于支持动画的图像格式，该函数返回当前图像在动画序列中的序号。如果在调用该函数之前尚未通过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 。该格式对于支持多种图像格式的处理程序最为有用。

该函数被声明为 const，以便可以从canRead() 中调用它。

另请参阅 format()。

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

将选项option 设置为值value 。

另请参阅 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 。