#include <qpaintengine_preview_p.h>

Inheritance diagram for QPreviewPaintEngine:

Collaboration diagram for QPreviewPaintEngine:

Public Member Functions
	QPreviewPaintEngine ()

	~QPreviewPaintEngine ()

bool	begin (QPaintDevice *dev) override
	Reimplement this function to initialise your paint engine when painting is to start on the paint device pdev.

bool	end () override
	Reimplement this function to finish painting on the current paint device.

void	updateState (const QPaintEngineState &state) override
	Reimplement this function to update the state of a paint engine.

void	drawPath (const QPainterPath &path) override
	The default implementation ignores the path and does nothing.

void	drawPolygon (const QPointF *points, int pointCount, PolygonDrawMode mode) override
	Reimplement this virtual function to draw the polygon defined by the pointCount first points in points, using mode mode.

void	drawTextItem (const QPointF &p, const QTextItem &textItem) override
	This function draws the text item textItem at position p.

void	drawPixmap (const QRectF &r, const QPixmap &pm, const QRectF &sr) override
	Reimplement this function to draw the part of the pm specified by the sr rectangle in the given r.

void	drawTiledPixmap (const QRectF &r, const QPixmap &pm, const QPointF &p) override
	Reimplement this function to draw the pixmap in the given rect, starting at the given p.

QList< const QPicture * >	pages ()

QPaintEngine::Type	type () const override
	Reimplement this function to return the paint engine \l{Type}.

void	setProxyEngines (QPrintEngine printEngine, QPaintEngine paintEngine)

void	setProperty (PrintEnginePropertyKey key, const QVariant &value) override
	Sets the print engine's property specified by key to the given value.

QVariant	property (PrintEnginePropertyKey key) const override
	Returns the print engine's property specified by key.

bool	newPage () override
	Instructs the print engine to start a new page.

bool	abort () override
	Instructs the print engine to abort the printing process.

int	metric (QPaintDevice::PaintDeviceMetric) const override
	Returns the metric for the given id.

QPrinter::PrinterState	printerState () const override
	Returns the current state of the printer being used by the print engine.

Public Member Functions inherited from QPaintEngine
	QPaintEngine (PaintEngineFeatures features=PaintEngineFeatures())
	Creates a paint engine with the featureset specified by caps.

virtual	~QPaintEngine ()
	Destroys the paint engine.

bool	isActive () const
	Returns `true` if the paint engine is actively drawing; otherwise returns `false`.

void	setActive (bool newState)
	Sets the active state of the paint engine to state.

virtual bool	begin (QPaintDevice *pdev)=0
	Reimplement this function to initialise your paint engine when painting is to start on the paint device pdev.

virtual bool	end ()=0
	Reimplement this function to finish painting on the current paint device.

virtual void	updateState (const QPaintEngineState &state)=0
	Reimplement this function to update the state of a paint engine.

virtual void	drawRects (const QRect *rects, int rectCount)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The default implementation converts the first rectCount rectangles in the buffer rects to a QRectF and calls the floating point version of this function.

virtual void	drawRects (const QRectF *rects, int rectCount)
	Draws the first rectCount rectangles in the buffer rects.

virtual void	drawLines (const QLine *lines, int lineCount)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.The default implementation converts the first lineCount lines in lines to a QLineF and calls the floating point version of this function.

virtual void	drawLines (const QLineF *lines, int lineCount)
	The default implementation splits the list of lines in lines into lineCount separate calls to drawPath() or drawPolygon() depending on the feature set of the paint engine.

virtual void	drawEllipse (const QRectF &r)
	Reimplement this function to draw the largest ellipse that can be contained within rectangle rect.

virtual void	drawEllipse (const QRect &r)
	The default implementation of this function calls the floating point version of this function.

virtual void	drawPath (const QPainterPath &path)
	The default implementation ignores the path and does nothing.

virtual void	drawPoints (const QPointF *points, int pointCount)
	Draws the first pointCount points in the buffer points.

virtual void	drawPoints (const QPoint *points, int pointCount)
	Draws the first pointCount points in the buffer points.

virtual void	drawPolygon (const QPointF *points, int pointCount, PolygonDrawMode mode)
	Reimplement this virtual function to draw the polygon defined by the pointCount first points in points, using mode mode.

virtual void	drawPolygon (const QPoint *points, int pointCount, PolygonDrawMode mode)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.Reimplement this virtual function to draw the polygon defined by the pointCount first points in points, using mode mode.

virtual void	drawPixmap (const QRectF &r, const QPixmap &pm, const QRectF &sr)=0
	Reimplement this function to draw the part of the pm specified by the sr rectangle in the given r.

virtual void	drawTextItem (const QPointF &p, const QTextItem &textItem)
	This function draws the text item textItem at position p.

virtual void	drawTiledPixmap (const QRectF &r, const QPixmap &pixmap, const QPointF &s)
	Reimplement this function to draw the pixmap in the given rect, starting at the given p.

virtual void	drawImage (const QRectF &r, const QImage &pm, const QRectF &sr, Qt::ImageConversionFlags flags=Qt::AutoColor)
	Reimplement this function to draw the part of the image specified by the sr rectangle in the given rectangle using the given conversion flags flags, to convert it to a pixmap.

void	setPaintDevice (QPaintDevice *device)

QPaintDevice *	paintDevice () const
	Returns the device that this engine is painting on, if painting is active; otherwise returns \nullptr.

void	setSystemClip (const QRegion &baseClip)

QRegion	systemClip () const

void	setSystemRect (const QRect &rect)

QRect	systemRect () const

virtual QPoint	coordinateOffset () const

virtual Type	type () const =0
	Reimplement this function to return the paint engine \l{Type}.

void	fix_neg_rect (int x, int y, int w, int h)

bool	testDirty (DirtyFlags df)

void	setDirty (DirtyFlags df)

void	clearDirty (DirtyFlags df)

bool	hasFeature (PaintEngineFeatures feature) const
	Returns `true` if the paint engine supports the specified feature; otherwise returns `false`.

QPainter *	painter () const
	Returns the paint engine's painter.

void	syncState ()

bool	isExtended () const

virtual QPixmap	createPixmap (QSize size)

virtual QPixmap	createPixmapFromImage (QImage image, Qt::ImageConversionFlags flags=Qt::AutoColor)

Public Member Functions inherited from QPrintEngine

Additional Inherited Members
Public Types inherited from QPaintEngine
enum	PaintEngineFeature { PrimitiveTransform = 0x00000001 , PatternTransform = 0x00000002 , PixmapTransform = 0x00000004 , PatternBrush = 0x00000008 , LinearGradientFill = 0x00000010 , RadialGradientFill = 0x00000020 , ConicalGradientFill = 0x00000040 , AlphaBlend = 0x00000080 , PorterDuff = 0x00000100 , PainterPaths = 0x00000200 , Antialiasing = 0x00000400 , BrushStroke = 0x00000800 , ConstantOpacity = 0x00001000 , MaskedBrush = 0x00002000 , PerspectiveTransform = 0x00004000 , BlendModes = 0x00008000 , ObjectBoundingModeGradients = 0x00010000 , RasterOpModes = 0x00020000 , PaintOutsidePaintEvent = 0x20000000 , AllFeatures = 0xffffffff }
	This enum is used to describe the features or capabilities that the paint engine has. More...

enum	DirtyFlag { DirtyPen = 0x0001 , DirtyBrush = 0x0002 , DirtyBrushOrigin = 0x0004 , DirtyFont = 0x0008 , DirtyBackground = 0x0010 , DirtyBackgroundMode = 0x0020 , DirtyTransform = 0x0040 , DirtyClipRegion = 0x0080 , DirtyClipPath = 0x0100 , DirtyHints = 0x0200 , DirtyCompositionMode = 0x0400 , DirtyClipEnabled = 0x0800 , DirtyOpacity = 0x1000 , AllDirty = 0xffff }
	\value DirtyPen The pen is dirty and needs to be updated. More...

enum	PolygonDrawMode { OddEvenMode , WindingMode , ConvexMode , PolylineMode }
	\value OddEvenMode The polygon should be drawn using OddEven fill rule. More...

enum	Type { X11 , Windows , QuickDraw , CoreGraphics , MacPrinter , QWindowSystem , OpenGL , Picture , SVG , Raster , Direct3D , Pdf , OpenVG , OpenGL2 , PaintBuffer , Blitter , Direct2D , User = 50 , MaxUser = 100 }
	\value X11 \value Windows \value MacPrinter \value CoreGraphics \macos's Quartz2D (CoreGraphics) \value QuickDraw \macos's QuickDraw \value QWindowSystem Qt for Embedded Linux \value OpenGL \value Picture QPicture format \value SVG Scalable Vector Graphics XML format \value Raster \value Direct3D Windows only, Direct3D based engine \value Pdf Portable Document Format \value OpenVG \value User First user type ID \value MaxUser Last user type ID \value OpenGL2 \value PaintBuffer \value Blitter \value Direct2D Windows only, Direct2D based engine More...

Public Types inherited from QPrintEngine
enum	PrintEnginePropertyKey { PPK_CollateCopies , PPK_ColorMode , PPK_Creator , PPK_DocumentName , PPK_FullPage , PPK_NumberOfCopies , PPK_Orientation , PPK_OutputFileName , PPK_PageOrder , PPK_PageRect , PPK_PageSize , PPK_PaperRect , PPK_PaperSource , PPK_PrinterName , PPK_PrinterProgram , PPK_Resolution , PPK_SelectionOption , PPK_SupportedResolutions , PPK_WindowsPageSize , PPK_FontEmbedding , PPK_Duplex , PPK_PaperSources , PPK_CustomPaperSize , PPK_PageMargins , PPK_CopyCount , PPK_SupportsMultipleCopies , PPK_PaperName , PPK_QPageSize , PPK_QPageMargins , PPK_QPageLayout , PPK_PaperSize = PPK_PageSize , PPK_CustomBase = 0xff00 }
	This enum is used to communicate properties between the print engine and QPrinter. More...

Protected Member Functions inherited from QPaintEngine
	QPaintEngine (QPaintEnginePrivate &data, PaintEngineFeatures devcaps=PaintEngineFeatures())

Protected Attributes inherited from QPaintEngine
QPaintEngineState *	state

PaintEngineFeatures	gccaps

uint	active: 1

uint	selfDestruct: 1

uint	extended: 1

QScopedPointer< QPaintEnginePrivate >	d_ptr

Detailed Description

Definition at line 29 of file qpaintengine_preview_p.h.

Constructor & Destructor Documentation

◆ QPreviewPaintEngine()

QPreviewPaintEngine::QPreviewPaintEngine ( )

Definition at line 32 of file qpaintengine_preview.cpp.

References d.

◆ ~QPreviewPaintEngine()

QPreviewPaintEngine::~QPreviewPaintEngine ( )

Definition at line 40 of file qpaintengine_preview.cpp.

References d, and qDeleteAll().

Here is the call graph for this function:

Member Function Documentation

◆ abort()

bool QPreviewPaintEngine::abort ( )

overridevirtual

Instructs the print engine to abort the printing process.

Returns true if successful; otherwise returns false.

Implements QPrintEngine.

Definition at line 136 of file qpaintengine_preview.cpp.

References QPrinter::Aborted, d, end(), and qDeleteAll().

Here is the call graph for this function:

◆ begin()

bool QPreviewPaintEngine::begin ( QPaintDevice * pdev )

overridevirtual

Reimplement this function to initialise your paint engine when painting is to start on the paint device pdev.

Return true if the initialization was successful; otherwise return false.

See also: end(), isActive()

Implements QPaintEngine.

Definition at line 47 of file qpaintengine_preview.cpp.

References QPrinter::Active, d, page, QPaintEngine::painter(), qDeleteAll(), and QPaintEngine::QPainter.

Here is the call graph for this function:

◆ drawPath()

void QPreviewPaintEngine::drawPath ( const QPainterPath & path )

overridevirtual

The default implementation ignores the path and does nothing.

Reimplemented from QPaintEngine.

Definition at line 81 of file qpaintengine_preview.cpp.

References d.

◆ drawPixmap()

void QPreviewPaintEngine::drawPixmap	(	const QRectF &	r,
		const QPixmap &	pm,
		const QRectF &	sr
	)

overridevirtual

Reimplement this function to draw the part of the pm specified by the sr rectangle in the given r.

Implements QPaintEngine.

Definition at line 99 of file qpaintengine_preview.cpp.

References d.

◆ drawPolygon()

void QPreviewPaintEngine::drawPolygon	(	const QPointF *	points,
		int	pointCount,
		PolygonDrawMode	mode
	)

overridevirtual

Reimplement this virtual function to draw the polygon defined by the pointCount first points in points, using mode mode.

Note: At least one of the drawPolygon() functions must be reimplemented.

Reimplemented from QPaintEngine.

Definition at line 87 of file qpaintengine_preview.cpp.

References d.

◆ drawTextItem()

void QPreviewPaintEngine::drawTextItem	(	const QPointF &	p,
		const QTextItem &	textItem
	)

overridevirtual

This function draws the text item textItem at position p.

The default implementation of this function converts the text to a QPainterPath and paints the resulting path.

Reimplemented from QPaintEngine.

Definition at line 93 of file qpaintengine_preview.cpp.

References d.

◆ drawTiledPixmap()

void QPreviewPaintEngine::drawTiledPixmap	(	const QRectF &	rect,
		const QPixmap &	pixmap,
		const QPointF &	p
	)

overridevirtual

Reimplement this function to draw the pixmap in the given rect, starting at the given p.

The pixmap will be drawn repeatedly until the rect is filled.

Reimplemented from QPaintEngine.

Definition at line 105 of file qpaintengine_preview.cpp.

References d.

◆ end()

bool QPreviewPaintEngine::end ( )

overridevirtual

Reimplement this function to finish painting on the current paint device.

Return true if painting was finished successfully; otherwise return false.

See also: begin(), isActive()

Implements QPaintEngine.

Definition at line 64 of file qpaintengine_preview.cpp.

References d, and QPrinter::Idle.

Referenced by abort().

Here is the caller graph for this function:

◆ metric()

int QPreviewPaintEngine::metric ( QPaintDevice::PaintDeviceMetric id ) const

overridevirtual

Returns the metric for the given id.

Implements QPrintEngine.

Definition at line 171 of file qpaintengine_preview.cpp.

References d.

◆ newPage()

bool QPreviewPaintEngine::newPage ( )

overridevirtual

Instructs the print engine to start a new page.

Returns true if the printer was able to create the new page; otherwise returns false.

Implements QPrintEngine.

Definition at line 111 of file qpaintengine_preview.cpp.

References QPaintEngine::AllDirty, d, QPaintEngine::DirtyCompositionMode, page, QPainter::paintEngine(), QPaintEngine::painter(), Q_ASSERT, QPaintEngine::QPainter, QPaintEngine::setDirty(), QPaintEngine::state, and QPaintEngine::syncState().

Here is the call graph for this function:

◆ pages()

QList< const QPicture * > QPreviewPaintEngine::pages ( )

Definition at line 146 of file qpaintengine_preview.cpp.

References d.

◆ printerState()

QPrinter::PrinterState QPreviewPaintEngine::printerState ( ) const

overridevirtual

Returns the current state of the printer being used by the print engine.

Implements QPrintEngine.

Definition at line 177 of file qpaintengine_preview.cpp.

References d.

◆ property()

QVariant QPreviewPaintEngine::property ( PrintEnginePropertyKey key ) const

overridevirtual

Returns the print engine's property specified by key.

See also: setProperty()

Implements QPrintEngine.

Definition at line 165 of file qpaintengine_preview.cpp.

References d.

◆ setProperty()

void QPreviewPaintEngine::setProperty	(	PrintEnginePropertyKey	key,
		const QVariant &	value
	)

overridevirtual

Sets the print engine's property specified by key to the given value.

See also: property()

Implements QPrintEngine.

Definition at line 159 of file qpaintengine_preview.cpp.

References d.

◆ setProxyEngines()

void QPreviewPaintEngine::setProxyEngines	(	QPrintEngine *	printEngine,
		QPaintEngine *	paintEngine
	)

Definition at line 152 of file qpaintengine_preview.cpp.

References d.

◆ type()

QPaintEngine::Type QPreviewPaintEngine::type ( ) const

inlineoverridevirtual

Reimplement this function to return the paint engine \l{Type}.

Implements QPaintEngine.

Definition at line 50 of file qpaintengine_preview_p.h.

References QPaintEngine::Picture.

◆ updateState()

void QPreviewPaintEngine::updateState ( const QPaintEngineState & state )

overridevirtual

Reimplement this function to update the state of a paint engine.

When implemented, this function is responsible for checking the paint engine's current state and update the properties that are changed. Use the QPaintEngineState::state() function to find out which properties that must be updated, then use the corresponding \l {GetFunction}{get function} to retrieve the current values for the given properties.

See also: QPaintEngineState

Implements QPaintEngine.

Definition at line 75 of file qpaintengine_preview.cpp.

References d, and QPaintEngine::state.

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

qtbase/src/printsupport/kernel/qpaintengine_preview_p.h
qtbase/src/printsupport/kernel/qpaintengine_preview.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QPreviewPaintEngine()

◆ ~QPreviewPaintEngine()

Member Function Documentation

◆ abort()

◆ begin()

◆ drawPath()

◆ drawPixmap()

◆ drawPolygon()

◆ drawTextItem()

◆ drawTiledPixmap()

◆ end()

◆ metric()

◆ newPage()

◆ pages()

◆ printerState()

◆ property()

◆ setProperty()

◆ setProxyEngines()

◆ type()

◆ updateState()