QPicture

The QPicture class is a paint device that records and replays QPainter commands. More…

Inheritance diagram of PySide2.QtGui.QPicture

Synopsis

Functions

Virtual functions

Static functions

Detailed Description

A picture serializes painter commands to an IO device in a platform-independent format. They are sometimes referred to as meta-files.

Qt pictures use a proprietary binary format. Unlike native picture (meta-file) formats on many window systems, Qt pictures have no limitations regarding their contents. Everything that can be painted on a widget or pixmap (e.g., fonts, pixmaps, regions, transformed graphics, etc.) can also be stored in a picture.

QPicture is resolution independent, i.e. a QPicture can be displayed on different devices (for example svg, pdf, ps, printer and screen) looking the same. This is, for instance, needed for WYSIWYG print preview. QPicture runs in the default system dpi, and scales the painter to match differences in resolution depending on the window system.

Example of how to record a picture:

picture = QPicture()
painter = QPainter()
painter.begin(picture)            # paint in picture
painter.drawEllipse(10,20, 80,70) # draw an ellipse
painter.end()                     # painting done
picture.save("drawing.pic")       # save picture

Note that the list of painter commands is reset on each call to the begin() function.

Example of how to replay a picture:

picture = QPicture()
picture.load("drawing.pic")           # load picture
painter = QPainter()
painter.begin(myImage)                # paint in myImage
painter.drawPicture(0, 0, picture)    # draw the picture at (0,0)
painter.end()                         # painting done

Pictures can also be drawn using play() . Some basic data about a picture is available, for example, size() , isNull() and boundingRect() .

See also

QMovie

class PySide2.QtGui.QPicture(arg__1)

PySide2.QtGui.QPicture([formatVersion=-1])

param arg__1:

PySide2.QtGui.QPicture

param formatVersion:

int

Constructs an empty picture.

The formatVersion parameter may be used to create a QPicture that can be read by applications that are compiled with earlier versions of Qt.

Note that the default formatVersion is -1 which signifies the current release, i.e. for Qt 4.0 a formatVersion of 7 is the same as the default formatVersion of -1.

Reading pictures generated by earlier versions of Qt is not supported in Qt 4.0.

PySide2.QtGui.QPicture.boundingRect()
Return type:

PySide2.QtCore.QRect

Returns the picture’s bounding rectangle or an invalid rectangle if the picture contains no data.

See also

setBoundingRect()

PySide2.QtGui.QPicture.data()
Return type:

PyObject

Returns a pointer to the picture data. The pointer is only valid until the next non-const function is called on this picture. The returned pointer is 0 if the picture contains no data.

See also

setData() size() isNull()

static PySide2.QtGui.QPicture.inputFormatList()
Return type:

list of strings

Note

This function is deprecated.

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

Note that if you want to iterate over the list, you should iterate over a copy, e.g.

list = QPicture.inputFormatList()
for string in list:
    myProcessing(string)

See also

outputFormatList() inputFormats() QPictureIO

static PySide2.QtGui.QPicture.inputFormats()
Return type:

Note

This function is deprecated.

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

See also

outputFormats() inputFormatList() QPictureIO

PySide2.QtGui.QPicture.isNull()
Return type:

bool

Returns true if the picture contains no data; otherwise returns false.

PySide2.QtGui.QPicture.load(dev[, format=None])
Parameters:
Return type:

bool

This is an overloaded function.

dev is the device to use for loading.

PySide2.QtGui.QPicture.load(fileName[, format=None])
Parameters:

  • fileName – str

  • format – str

Return type:

bool

static PySide2.QtGui.QPicture.outputFormatList()
Return type:

list of strings

Note

This function is deprecated.

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

Note that if you want to iterate over the list, you should iterate over a copy, e.g.

list = QPicture.outputFormatList()
for string in list:
    myProcessing(string)

See also

inputFormatList() outputFormats() QPictureIO

static PySide2.QtGui.QPicture.outputFormats()
Return type:

Note

This function is deprecated.

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

See also

inputFormats() outputFormatList() QPictureIO

static PySide2.QtGui.QPicture.pictureFormat(fileName)
Parameters:

fileName – str

Return type:

str

Note

This function is deprecated.

Returns a string that specifies the picture format of the file fileName , or None if the file cannot be read or if the format is not recognized.

See also

load() save()

PySide2.QtGui.QPicture.play(p)
Parameters:

p – PySide2.QtGui.QPainter

Return type:

bool

Replays the picture using painter , and returns true if successful; otherwise returns false .

This function does exactly the same as drawPicture() with (x, y) = (0, 0).

PySide2.QtGui.QPicture.save(dev[, format=None])
Parameters:
Return type:

bool

This is an overloaded function.

dev is the device to use for saving.

PySide2.QtGui.QPicture.save(fileName[, format=None])
Parameters:

  • fileName – str

  • format – str

Return type:

bool

PySide2.QtGui.QPicture.setBoundingRect(r)
Parameters:

r – PySide2.QtCore.QRect

Sets the picture’s bounding rectangle to r . The automatically calculated value is overridden.

See also

boundingRect()

PySide2.QtGui.QPicture.setData(data)
Parameters:

data – str

Sets the picture data directly from data and size . This function copies the input data.

See also

data() size()

PySide2.QtGui.QPicture.size()
Return type:

uint

Returns the size of the picture data.

See also

data()

PySide2.QtGui.QPicture.swap(other)
Parameters:

other – PySide2.QtGui.QPicture

Swaps picture other with this picture. This operation is very fast and never fails.