QPictureIO¶

PyQt5.QtGui.QPictureIO

Description¶

The QPictureIO class contains parameters for loading and saving pictures.

QPictureIO contains a QIODevice object that is used for picture data I/O. The programmer can install new picture file formats in addition to those that Qt provides.

You don’t normally need to use this class; load(), save().

See also

QPicture, QPixmap, QFile.

Methods¶

__init__(): Constructs a QPictureIO object with all parameters set to zero.

__init__(QIODevice, str): Constructs a QPictureIO object with the I/O device ioDevice and a format tag.

__init__(str, str): Constructs a QPictureIO object with the file name fileName and a format tag.

@staticmethod defineIOHandler(str, str, str, Optional[Callable[[QPictureIO], None]], Optional[Callable[[QPictureIO], None]]): TODO

description() → str: Returns the picture description string.

See also

setDescription().

fileName() → str: Returns the file name currently set.

See also

setFileName().

format() → str: Returns the picture format string or 0 if no format has been explicitly set.

See also

setFormat().

gamma() → float: Returns the gamma value at which the picture will be viewed.

See also

setGamma().

@staticmethod inputFormats() → List[QByteArray]: Returns a sorted list of picture formats that are supported for picture input.

ioDevice() → QIODevice: Returns the IO device currently set.

See also

setIODevice().

@staticmethod outputFormats() → List[QByteArray]: Returns a sorted list of picture formats that are supported for picture output.

parameters() → str: Returns the picture’s parameters string.

See also

setParameters().

picture() → QPicture: Returns the picture currently set.

See also

setPicture().

@staticmethod pictureFormat(str) → QByteArray: Returns a string that specifies the picture format of the file fileName, or null if the file cannot be read or if the format is not recognized.

@staticmethod pictureFormat(QIODevice) → QByteArray

This is an overloaded function.

Returns a string that specifies the picture format of the picture read from IO device d, or 0 if the device cannot be read or if the format is not recognized.

Make sure that d is at the right position in the device (for example, at the beginning of the file).

See also

pos().

quality() → int: Returns the quality of the written picture, related to the compression ratio.

See also

setQuality(), save().

read() → bool

Reads an picture into memory and returns true if the picture was successfully read; otherwise returns false.

Before reading an picture you must set an IO device or a file name. If both an IO device and a file name have been set, the IO device will be used.

Setting the picture file format string is optional.

Note that this function does not set the format() used to read the picture. If you need that information, use the pictureFormat() static functions.

Example:

#         QPictureIO iio;
#         QPixmap  pixmap;
#         iio.setFileName("vegeburger.pic");
#         if (iio.read()) {        // OK
#             QPicture picture = iio.picture();
#             QPainter painter(&pixmap);
#             painter.drawPicture(0, 0, picture);
#         }

setDescription(str)

Sets the picture description string for picture handlers that support picture descriptions to description.

Currently, no picture format supported by Qt uses the description string.

See also

description().

setFileName(str): Sets the name of the file to read or write an picture from to fileName.

See also

fileName(), setIODevice().

setFormat(str)

Sets the picture format to format for the picture to be read or written.

It is necessary to specify a format before writing an picture, but it is not necessary to specify a format before reading an picture.

If no format has been set, Qt guesses the picture format before reading it. If a format is set the picture will only be read if it has that format.

See also

read(), write(), format().

setGamma(float)

Sets the gamma value at which the picture will be viewed to gamma. If the picture format stores a gamma value for which the picture is intended to be used, then this setting will be used to modify the picture. Setting to 0.0 will disable gamma correction (i.e. any specification in the file will be ignored).

The default value is 0.0.

See also

gamma().

setIODevice(QIODevice)

Sets the IO device to be used for reading or writing an picture.

Setting the IO device allows pictures to be read/written to any block-oriented QIODevice.

If ioDevice is not null, this IO device will override file name settings.

See also

setFileName().

setParameters(str)

Sets the picture’s parameter string to parameters. This is for picture handlers that require special parameters.

Although the current picture formats supported by Qt ignore the parameters string, it may be used in future extensions or by contributions (for example, JPEG).

See also

parameters().

setPicture(QPicture): Sets the picture to picture.

See also

picture().

setQuality(int)

Sets the quality of the written picture to q, related to the compression ratio.

q must be in the range -1..100. Specify 0 to obtain small compressed files, 100 for large uncompressed files. (-1 signifies the default compression.)

See also

quality(), save().

setStatus(int): Sets the picture IO status to status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful.

See also

status().

status() → int: Returns the picture’s IO status. A non-zero value indicates an error, whereas 0 means that the IO operation was successful.

See also

setStatus().

write() → bool

Writes an picture to an IO device and returns true if the picture was successfully written; otherwise returns false.

Before writing an picture you must set an IO device or a file name. If both an IO device and a file name have been set, the IO device will be used.

The picture will be written using the specified picture format.

Example:

#         QPictureIO iio;
#         QPicture   picture;
#         QPainter painter(&picture);
#         painter.drawPixmap(0, 0, pixmap);
#         iio.setPicture(picture);
#         iio.setFileName("vegeburger.pic");
#         iio.setFormat("PIC");
#         if (iio.write())
#             return true; // returned true if written successfully