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

#include <qpicture.h>

Inheritance diagram for QPicture:

Collaboration diagram for QPicture:

Public Types
typedef QExplicitlySharedDataPointer< QPicturePrivate >	DataPtr

Public Types inherited from QPaintDevice
enum	PaintDeviceMetric { PdmWidth = 1 , PdmHeight , PdmWidthMM , PdmHeightMM , PdmNumColors , PdmDepth , PdmDpiX , PdmDpiY , PdmPhysicalDpiX , PdmPhysicalDpiY , PdmDevicePixelRatio , PdmDevicePixelRatioScaled }

Public Member Functions
	QPicture (int formatVersion=-1)

	QPicture (const QPicture &)

	~QPicture ()

bool	isNull () const

int	devType () const override

uint	size () const

const char *	data () const

virtual void	setData (const char *data, uint size)

bool	play (QPainter *p)

bool	load (QIODevice *dev)

bool	load (const QString &fileName)

bool	save (QIODevice *dev)

bool	save (const QString &fileName)

QRect	boundingRect () const

void	setBoundingRect (const QRect &r)

QPicture &	operator= (const QPicture &p)

void	swap (QPicture &other) noexcept

void	detach ()

bool	isDetached () const

QPaintEngine *	paintEngine () const override

DataPtr &	data_ptr ()

Public Member Functions inherited from QPaintDevice
virtual	~QPaintDevice ()

bool	paintingActive () const

int	width () const

int	height () const

int	widthMM () const

int	heightMM () const

int	logicalDpiX () const

int	logicalDpiY () const

int	physicalDpiX () const

int	physicalDpiY () const

qreal	devicePixelRatio () const

qreal	devicePixelRatioF () const

int	colorCount () const

int	depth () const

Protected Member Functions
	QPicture (QPicturePrivate &data)

int	metric (PaintDeviceMetric m) const override

Protected Member Functions inherited from QPaintDevice
	QPaintDevice () noexcept

virtual void	initPainter (QPainter *painter) const

virtual QPaintDevice *	redirected (QPoint *offset) const

virtual QPainter *	sharedPainter () const

Friends
class	QPicturePaintEngine

class	QAlphaPaintEngine

class	QPreviewPaintEngine

Q_GUI_EXPORT QDataStream &	operator<< (QDataStream &in, const QPicture &p)

Q_GUI_EXPORT QDataStream &	operator>> (QDataStream &in, QPicture &p)

Related Functions
(Note that these are not member functions.)
QDataStream &	operator<< (QDataStream &s, const QPicture &r)

QDataStream &	operator>> (QDataStream &s, QPicture &r)

Additional Inherited Members
Static Public Member Functions inherited from QPaintDevice
static qreal	devicePixelRatioFScale ()

Protected Attributes inherited from QPaintDevice
ushort	painters

Detailed Description

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

\inmodule QtGui

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:

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

Example of how to replay a picture:

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

See also: QMovie

Definition at line 54 of file qpicture.h.

Member Typedef Documentation

◆ DataPtr

typedef QExplicitlySharedDataPointer<QPicturePrivate> QPicture::DataPtr

Definition at line 105 of file qpicture.h.

Constructor & Destructor Documentation

◆ QPicture() [1/3]

QPicture::QPicture ( int formatVersion = -1 )

explicit

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.

Definition at line 138 of file qpicture.cpp.

Here is the caller graph for this function:

◆ QPicture() [2/3]

QPicture::QPicture ( const QPicture & pic )

Constructs a copy of pic.

This constructor is fast thanks to \l{implicit sharing}.

Definition at line 163 of file qpicture.cpp.

◆ ~QPicture()

QPicture::~QPicture ( )

Destroys the picture.

Definition at line 178 of file qpicture.cpp.

◆ QPicture() [3/3]

QPicture::QPicture ( QPicturePrivate & data )

protected

Definition at line 169 of file qpicture.cpp.

Member Function Documentation

◆ boundingRect()

QRect QPicture::boundingRect ( ) const

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

Definition at line 332 of file qpicture.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ data()

const char * QPicture::data ( ) const

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: size(), isNull()

Definition at line 226 of file qpicture.cpp.

Here is the caller graph for this function:

◆ data_ptr()

DataPtr & QPicture::data_ptr ( )

inline

Definition at line 106 of file qpicture.h.

◆ detach()

void QPicture::detach ( )

Definition at line 231 of file qpicture.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ devType()

int QPicture::devType ( ) const

overridevirtual

Reimplemented from QPaintDevice.

Definition at line 185 of file qpicture.cpp.

◆ isDetached()

bool QPicture::isDetached ( ) const

Definition at line 236 of file qpicture.cpp.

◆ isNull()

bool QPicture::isNull ( ) const

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

Definition at line 216 of file qpicture.cpp.

◆ load() [1/2]

bool QPicture::load ( const QString & fileName )

Loads a picture from the file specified by fileName and returns true if successful; otherwise invalidates the picture and returns false.

See also: save()

Definition at line 263 of file qpicture.cpp.

Here is the call graph for this function:

◆ load() [2/2]

bool QPicture::load ( QIODevice * dev )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

dev is the device to use for loading.

Definition at line 279 of file qpicture.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ metric()

int QPicture::metric ( PaintDeviceMetric m ) const

overrideprotectedvirtual

Reimplemented from QPaintDevice.

Definition at line 891 of file qpicture.cpp.

Here is the call graph for this function:

◆ operator=()

QPicture & QPicture::operator= ( const QPicture & p )

Move-assigns other to this QPicture instance.

Since: 5.2

Assigns picture p to this picture and returns a reference to this picture.

Definition at line 954 of file qpicture.cpp.

Here is the caller graph for this function:

◆ paintEngine()

QPaintEngine * QPicture::paintEngine ( ) const

overridevirtual

Implements QPaintDevice.

Reimplemented in Picture.

Definition at line 1086 of file qpicture.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ play()

bool QPicture::play ( QPainter * painter )

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

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

Note: The state of the painter isn't preserved by this function.

Definition at line 365 of file qpicture.cpp.

◆ save() [1/2]

bool QPicture::save ( const QString & fileName )

Saves a picture to the file specified by fileName and returns true if successful; otherwise returns false.

See also: load()

Definition at line 295 of file qpicture.cpp.

Here is the call graph for this function:

◆ save() [2/2]

bool QPicture::save ( QIODevice * dev )

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

dev is the device to use for saving.

Definition at line 315 of file qpicture.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBoundingRect()

void QPicture::setBoundingRect ( const QRect & r )

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

Definition at line 350 of file qpicture.cpp.

◆ setData()

void QPicture::setData	(	const char *	data,
		uint	size
	)

virtual

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

See also: data(), size()

Definition at line 248 of file qpicture.cpp.

Here is the call graph for this function:

◆ size()

uint QPicture::size ( ) const

Returns the size of the picture data.

See also: data()

Definition at line 221 of file qpicture.cpp.

◆ swap()

void QPicture::swap ( QPicture & other )

inlinenoexcept

Since: 4.8

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

Definition at line 81 of file qpicture.h.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<< [1/2]

QDataStream & operator<<	(	QDataStream &	s,
		const QPicture &	r
	)

friend

Writes picture r to the stream s and returns a reference to the stream.

Definition at line 1105 of file qpicture.cpp.

◆ operator<<() [2/2]

QDataStream & operator<<	(	QDataStream &	s,
		const QPicture &	r
	)

Definition at line 1105 of file qpicture.cpp.

◆ operator>> [1/2]

QDataStream & operator>>	(	QDataStream &	s,
		QPicture &	r
	)

friend

Reads a picture from the stream s into picture r and returns a reference to the stream.

Definition at line 1124 of file qpicture.cpp.

◆ operator>>() [2/2]

QDataStream & operator>>	(	QDataStream &	s,
		QPicture &	r
	)

Definition at line 1124 of file qpicture.cpp.

◆ QAlphaPaintEngine

friend class QAlphaPaintEngine

friend

Definition at line 101 of file qpicture.h.

◆ QPicturePaintEngine

friend class QPicturePaintEngine

friend

Definition at line 100 of file qpicture.h.

◆ QPreviewPaintEngine

friend class QPreviewPaintEngine

friend

Definition at line 102 of file qpicture.h.

The documentation for this class was generated from the following files:

src/gui/image/qpicture.h
src/gui/image/qpicture.cpp

Public Types

Public Member Functions

Protected Member Functions

Friends

Related Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ DataPtr

Constructor & Destructor Documentation

◆ QPicture() [1/3]

◆ QPicture() [2/3]

◆ ~QPicture()

◆ QPicture() [3/3]

Member Function Documentation

◆ boundingRect()

◆ data()

◆ data_ptr()

◆ detach()

◆ devType()

◆ isDetached()

◆ isNull()

◆ load() [1/2]

◆ load() [2/2]

◆ metric()

◆ operator=()

◆ paintEngine()

◆ play()

◆ save() [1/2]

◆ save() [2/2]

◆ setBoundingRect()

◆ setData()

◆ size()

◆ swap()

Friends And Related Function Documentation

◆ operator<< [1/2]

◆ operator<<() [2/2]

◆ operator>> [1/2]

◆ operator>>() [2/2]

◆ QAlphaPaintEngine

◆ QPicturePaintEngine

◆ QPreviewPaintEngine