Skip to content

PythonQt.QtGui.QPictureIO · declarations 001

Back to PythonQt.QtGui.QPictureIO

description

description() -> str

X.description() -> str

Supplemental documentation: Qt 5 reference:

QString QPictureIO::description() const

Returns the picture description string.

See also setDescription().

Upstream PySide2 reference signatures (binding differences may apply):

description(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#description

fileName

fileName() -> str

X.fileName() -> str

Supplemental documentation: Qt 5 reference:

QString QPictureIO::fileName() const

Returns the file name currently set.

See also setFileName().

Upstream PySide2 reference signatures (binding differences may apply):

fileName(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#fileName

format

format() -> str

X.format() -> int

Supplemental documentation: Qt 5 reference:

const char *QPictureIO::format() const

Returns the picture format string or nullptr if no format has been explicitly set.

See also setFormat().

Upstream PySide2 reference signatures (binding differences may apply):

format(self) -> str

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

gamma

gamma() -> float

X.gamma() -> float

Supplemental documentation: Qt 5 reference:

float QPictureIO::gamma() const

Returns the gamma value at which the picture will be viewed.

See also setGamma().

Upstream PySide2 reference signatures (binding differences may apply):

gamma(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#gamma

inputFormats

inputFormats() -> Any

X.inputFormats()

Supplemental documentation: Qt 5 reference:

[static] QList\<QByteArray> QPictureIO::inputFormats()

Returns a sorted list of picture formats that are supported for picture input.

Upstream PySide2 reference signatures (binding differences may apply):

inputFormats() -> typing.List[PySide2.QtCore.QByteArray]

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#inputFormats

ioDevice

ioDevice() -> Any

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

Supplemental documentation: Qt 5 reference:

QIODevice *QPictureIO::ioDevice() const

Returns the IO device currently set.

See also setIODevice().

Upstream PySide2 reference signatures (binding differences may apply):

ioDevice(self) -> PySide2.QtCore.QIODevice

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#ioDevice

outputFormats

outputFormats() -> Any

X.outputFormats()

Supplemental documentation: Qt 5 reference:

[static] QList\<QByteArray> QPictureIO::outputFormats()

Returns a sorted list of picture formats that are supported for picture output.

Upstream PySide2 reference signatures (binding differences may apply):

outputFormats() -> typing.List[PySide2.QtCore.QByteArray]

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#outputFormats

parameters

parameters() -> str

X.parameters() -> int

Supplemental documentation: Qt 5 reference:

const char *QPictureIO::parameters() const

Returns the picture's parameters string.

See also setParameters().

Upstream PySide2 reference signatures (binding differences may apply):

parameters(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#parameters

picture

picture() -> Any

X.picture() -> PythonQt.QtGui.QPicture

Supplemental documentation: Qt 5 reference:

const QPicture \&QPictureIO::picture() const

Returns the picture currently set.

See also setPicture().

Upstream PySide2 reference signatures (binding differences may apply):

picture(self) -> PySide2.QtGui.QPicture

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#picture

pictureFormat

pictureFormat(arg__1: Any) -> Any

X.pictureFormat(arg__1) -> PythonQt.QtCore.QByteArray

Supplemental documentation: Qt 5 reference:

[static] QByteArray QPictureIO::pictureFormat(const QString \&fileName)

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.

[static] QByteArray QPictureIO::pictureFormat(QIODevice *d)

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 QIODevice::pos().

Upstream PySide2 reference signatures (binding differences may apply):

pictureFormat(arg__1: PySide2.QtCore.QIODevice) -> PySide2.QtCore.QByteArray
pictureFormat(fileName: str) -> PySide2.QtCore.QByteArray

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#pictureFormat

quality

quality() -> int

X.quality() -> int

Supplemental documentation: Qt 5 reference:

int QPictureIO::quality() const

Returns the quality of the written picture, related to the compression ratio.

See also setQuality() and QPicture::save().

Upstream PySide2 reference signatures (binding differences may apply):

quality(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#quality

read

read() -> bool

X.read() -> bool

Supplemental documentation: Qt 5 reference:

bool QPictureIO::read()

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);
        }

See also setIODevice(), setFileName(), setFormat(), write(), and QPixmap::load().

Upstream PySide2 reference signatures (binding differences may apply):

read(self) -> bool

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

setDescription

setDescription(arg__1: str) -> None

X.setDescription(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setDescription(const QString \&description)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setDescription(self, arg__1: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setDescription

setFileName

setFileName(arg__1: str) -> None

X.setFileName(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setFileName(const QString \&fileName)

Sets the name of the file to read or write an picture from to fileName.

See also fileName() and setIODevice().

Upstream PySide2 reference signatures (binding differences may apply):

setFileName(self, arg__1: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setFileName

setFormat

setFormat(arg__1: str) -> None

X.setFormat(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setFormat(const char *format)

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(), and format().

Upstream PySide2 reference signatures (binding differences may apply):

setFormat(self, arg__1: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setFormat

setGamma

setGamma(arg__1: float) -> None

X.setGamma(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setGamma(float gamma)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setGamma(self, arg__1: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setGamma

setIODevice

setIODevice(arg__1: Any) -> None

X.setIODevice(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setIODevice(QIODevice *ioDevice)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setIODevice(self, arg__1: PySide2.QtCore.QIODevice) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setIODevice

setParameters

setParameters(arg__1: str) -> None

X.setParameters(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setParameters(const char *parameters)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setParameters(self, arg__1: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setParameters

setPicture

setPicture(arg__1: Any) -> None

X.setPicture(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setPicture(const QPicture \&picture)

Sets the picture to picture.

See also picture().

Upstream PySide2 reference signatures (binding differences may apply):

setPicture(self, arg__1: PySide2.QtGui.QPicture) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setPicture

setQuality

setQuality(arg__1: int) -> None

X.setQuality(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setQuality(int q)

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() and QPicture::save().

Upstream PySide2 reference signatures (binding differences may apply):

setQuality(self, arg__1: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setQuality

setStatus

setStatus(arg__1: int) -> None

X.setStatus(arg__1)

Supplemental documentation: Qt 5 reference:

void QPictureIO::setStatus(int status)

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().

Upstream PySide2 reference signatures (binding differences may apply):

setStatus(self, arg__1: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#setStatus

status

status() -> int

X.status() -> int

Supplemental documentation: Qt 5 reference:

int QPictureIO::status() const

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().

Upstream PySide2 reference signatures (binding differences may apply):

status(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#status

write

write() -> bool

X.write() -> bool

Supplemental documentation: Qt 5 reference:

bool QPictureIO::write()

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

See also setIODevice(), setFileName(), setFormat(), read(), and QPixmap::save().

Upstream PySide2 reference signatures (binding differences may apply):

write(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qpictureio.html#write