Skip to content

PythonQt.QtGui.QImageIOHandler · declarations 001

Back to PythonQt.QtGui.QImageIOHandler

Animation instance-attribute

Animation: Any

BackgroundColor instance-attribute

BackgroundColor: Any

ClipRect instance-attribute

ClipRect: Any

CompressionRatio instance-attribute

CompressionRatio: Any

Description instance-attribute

Description: Any

Endianness instance-attribute

Endianness: Any

Gamma instance-attribute

Gamma: Any

ImageFormat instance-attribute

ImageFormat: Any

ImageOption instance-attribute

ImageOption: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

ImageTransformation instance-attribute

ImageTransformation: Any

IncrementalReading instance-attribute

IncrementalReading: Any

OptimizedWrite instance-attribute

OptimizedWrite: Any

ProgressiveScanWrite instance-attribute

ProgressiveScanWrite: Any

Quality instance-attribute

Quality: Any

ScaledClipRect instance-attribute

ScaledClipRect: Any

ScaledSize instance-attribute

ScaledSize: Any

SubType instance-attribute

SubType: Any

SupportedSubTypes instance-attribute

SupportedSubTypes: Any

Transformation instance-attribute

Transformation: type

int([x]) -> integer int(x, base=10) -> integer

Convert a number or string to an integer, or return 0 if no arguments are given. If x is a number, return x.int(). For floating point numbers, this truncates towards zero.

If x is not a number or if base is given, then x must be a string, bytes, or bytearray instance representing an integer literal in the given base. The literal can be preceded by '+' or '-' and be surrounded by whitespace. The base defaults to 10. Valid bases are 0 and 2-36. Base 0 means to interpret the base from the string as an integer literal.

int('0b100', base=0) 4

TransformationFlip instance-attribute

TransformationFlip: Any

TransformationFlipAndRotate90 instance-attribute

TransformationFlipAndRotate90: Any

TransformationMirror instance-attribute

TransformationMirror: Any

TransformationMirrorAndRotate90 instance-attribute

TransformationMirrorAndRotate90: Any

TransformationNone instance-attribute

TransformationNone: Any

TransformationRotate180 instance-attribute

TransformationRotate180: Any

TransformationRotate270 instance-attribute

TransformationRotate270: Any

TransformationRotate90 instance-attribute

TransformationRotate90: Any

TransformedByDefault instance-attribute

TransformedByDefault: Any

canRead

canRead() -> bool

X.canRead() -> bool

Supplemental documentation: Qt 5 reference:

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

Returns true if an image can be read from the device (i.e., the image format is supported, the device can be read from and the initial header information suggests that the image can be read); otherwise returns false.

When reimplementing canRead(), make sure that the I/O device (device()) is left in its original state (e.g., by using peek() rather than read()).

See also read() and QIODevice::peek().

Upstream PySide2 reference signatures (binding differences may apply):

canRead(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#canRead

currentImageNumber

currentImageNumber() -> int

X.currentImageNumber() -> int

Supplemental documentation: Qt 5 reference:

[virtual] int QImageIOHandler::currentImageNumber() const

For image formats that support animation, this function returns the sequence number of the current image in the animation. If this function is called before any image is read(), -1 is returned. The number of the first image in the sequence is 0.

If the image format does not support animation, 0 is returned.

See also read().

Upstream PySide2 reference signatures (binding differences may apply):

currentImageNumber(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#currentImageNumber

currentImageRect

currentImageRect() -> Any

X.currentImageRect() -> PythonQt.QtCore.QRect

Supplemental documentation: Qt 5 reference:

[virtual] QRect QImageIOHandler::currentImageRect() const

Returns the rect of the current image. If no rect is defined for the image, and empty QRect() is returned.

This function is useful for animations, where only parts of the frame may be updated at a time.

Upstream PySide2 reference signatures (binding differences may apply):

currentImageRect(self) -> PySide2.QtCore.QRect

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#currentImageRect

device

device() -> Any

X.device() -> PythonQt.QtCore.QIODevice

Supplemental documentation: Qt 5 reference:

QIODevice *QImageIOHandler::device() const

Returns the device currently assigned to the QImageIOHandler. If not device has been assigned, nullptr is returned.

See also setDevice().

Upstream PySide2 reference signatures (binding differences may apply):

device(self) -> PySide2.QtCore.QIODevice

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#device

format

format() -> Any

X.format() -> PythonQt.QtCore.QByteArray

Supplemental documentation: Qt 5 reference:

QByteArray QImageIOHandler::format() const

Returns the format that is currently assigned to QImageIOHandler. If no format has been assigned, an empty string is returned.

See also setFormat().

Upstream PySide2 reference signatures (binding differences may apply):

format(self) -> PySide2.QtCore.QByteArray

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#format

imageCount

imageCount() -> int

X.imageCount() -> int

Supplemental documentation: Qt 5 reference:

[virtual] int QImageIOHandler::imageCount() const

For image formats that support animation, this function returns the number of images in the animation. If the image format does not support animation, or if it is unable to determine the number of images, 0 is returned.

The default implementation returns 1 if canRead() returns true; otherwise 0 is returned.

Upstream PySide2 reference signatures (binding differences may apply):

imageCount(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#imageCount

jumpToImage

jumpToImage(imageNumber: int) -> bool

X.jumpToImage(imageNumber) -> bool

Supplemental documentation: Qt 5 reference:

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

For image formats that support animation, this function jumps to the image whose sequence number is imageNumber. The next call to read() will attempt to read this image.

The default implementation does nothing, and returns false.

Upstream PySide2 reference signatures (binding differences may apply):

jumpToImage(self, imageNumber: int) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#jumpToImage

jumpToNextImage

jumpToNextImage() -> bool

X.jumpToNextImage() -> bool

Supplemental documentation: Qt 5 reference:

[virtual] bool QImageIOHandler::jumpToNextImage()

For image formats that support animation, this function jumps to the next image.

The default implementation does nothing, and returns false.

Upstream PySide2 reference signatures (binding differences may apply):

jumpToNextImage(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#jumpToNextImage

loopCount

loopCount() -> int

X.loopCount() -> int

Supplemental documentation: Qt 5 reference:

[virtual] int QImageIOHandler::loopCount() const

For image formats that support animation, this function returns the number of times the animation should loop. If the image format does not support animation, 0 is returned.

Upstream PySide2 reference signatures (binding differences may apply):

loopCount(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#loopCount

nextImageDelay

nextImageDelay() -> int

X.nextImageDelay() -> int

Supplemental documentation: Qt 5 reference:

[virtual] int QImageIOHandler::nextImageDelay() const

For image formats that support animation, this function returns the number of milliseconds to wait until reading the next image. If the image format does not support animation, 0 is returned.

Upstream PySide2 reference signatures (binding differences may apply):

nextImageDelay(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#nextImageDelay

option

option(option: Any) -> Any

X.option(option) -> object

Supplemental documentation: Qt 5 reference:

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

Returns the value assigned to option as a QVariant. The type of the value depends on the option. For example, option(Size) returns a QSize variant.

See also setOption() and supportsOption().

Upstream PySide2 reference signatures (binding differences may apply):

option(self, option: PySide2.QtGui.QImageIOHandler.ImageOption) -> typing.Any

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#option

read

read(image: Any) -> bool

X.read(image) -> bool

Supplemental documentation: Qt 5 reference:

[pure virtual] bool QImageIOHandler::read(QImage *image)

Read an image from the device, and stores it in image. Returns true if the image is successfully read; otherwise returns false.

For image formats that support incremental loading, and for animation formats, the image handler can assume that image points to the previous frame.

See also canRead().

Upstream PySide2 reference signatures (binding differences may apply):

read(self, image: PySide2.QtGui.QImage) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qimageiohandler.html#read