Renderer for exporting a plot to a document, a printer or anything else, that is supported by QPainter/QPaintDevice . More...

#include <qwt_plot_renderer.h>

Inheritance diagram for QwtPlotRenderer:

Classes
class	PrivateData

Public Types
enum	DiscardFlag { DiscardNone = 0x00 , DiscardBackground = 0x01 , DiscardTitle = 0x02 , DiscardLegend = 0x04 , DiscardCanvasBackground = 0x08 , DiscardFooter = 0x10 , DiscardCanvasFrame = 0x20 }
	Discard flags. More...

enum	LayoutFlag { DefaultLayout = 0x00 , FrameWithScales = 0x01 }
	Layout flags. More...

Public Member Functions
	QwtPlotRenderer (QObject *=nullptr)
	Constructor.

virtual	~QwtPlotRenderer ()
	Destructor .

void	setDiscardFlag (DiscardFlag flag, bool on=true)
	Change a flag, indicating what to discard from rendering.

bool	testDiscardFlag (DiscardFlag flag) const
	Test if a discard flag is enabled.

void	setDiscardFlags (DiscardFlags flags)
	Set the flags, indicating what to discard from rendering.

DiscardFlags	discardFlags () const
	Get the flags indicating what to discard from rendering.

void	setLayoutFlag (LayoutFlag flag, bool on=true)
	Change a layout flag.

bool	testLayoutFlag (LayoutFlag flag) const
	Test if a layout flag is enabled.

void	setLayoutFlags (LayoutFlags flags)
	Set the layout flags.

LayoutFlags	layoutFlags () const
	Get the layout flags.

void	renderDocument (QwtPlot *, const QString &fileName, const QSizeF &sizeMM, int resolution=85)
	Render a plot to a file.

void	renderDocument (QwtPlot *, const QString &fileName, const QString &format, const QSizeF &sizeMM, int resolution=85)
	Render a plot to a file with specified format.

void	renderTo (QwtPlot *, QPrinter &) const
	Render the plot to a QPrinter.

void	renderTo (QwtPlot *, QPaintDevice &) const
	Render the plot to a QPaintDevice.

virtual void	render (QwtPlot , QPainter , const QRectF &plotRect) const
	Paint the contents of a QwtPlot instance into a given rectangle.

virtual void	renderTitle (const QwtPlot , QPainter , const QRectF &titleRect) const
	Render the title into a given rectangle.

virtual void	renderFooter (const QwtPlot , QPainter , const QRectF &footerRect) const
	Render the footer into a given rectangle.

virtual void	renderScale (const QwtPlot , QPainter , QwtAxisId, int startDist, int endDist, int baseDist, const QRectF &scaleRect) const
	Paint a scale into a given rectangle.

virtual void	renderCanvas (const QwtPlot , QPainter , const QRectF &canvasRect, const QwtScaleMap *maps) const
	Render the canvas into a given rectangle.

virtual void	renderLegend (const QwtPlot , QPainter , const QRectF &legendRect) const
	Render the legend into a given rectangle.

bool	exportTo (QwtPlot *, const QString &documentName, const QSizeF &sizeMM=QSizeF(300, 200), int resolution=85)
	Execute a file dialog and render the plot to the selected file.

Detailed Description

Renderer for exporting a plot to a document, a printer or anything else, that is supported by QPainter/QPaintDevice

.

Member Enumeration Documentation

◆ DiscardFlag

enum QwtPlotRenderer::DiscardFlag

Discard flags.

Enumerator
DiscardNone	Render all components of the plot.
DiscardBackground	Don't render the background of the plot.
DiscardTitle	Don't render the title of the plot.
DiscardLegend	Don't render the legend of the plot.
DiscardCanvasBackground	Don't render the background of the canvas.
DiscardFooter	Don't render the footer of the plot.
DiscardCanvasFrame	Don't render the frame of the canvas Note This flag has no effect when using style sheets, where the frame is part of the background

◆ LayoutFlag

enum QwtPlotRenderer::LayoutFlag

Layout flags.

Enumerator
DefaultLayout	Use the default layout as on screen.
FrameWithScales	Instead of the scales a box is painted around the plot canvas, where the scale ticks are aligned to.

Constructor & Destructor Documentation

◆ QwtPlotRenderer()

QwtPlotRenderer::QwtPlotRenderer ( QObject * parent = nullptr )

explicit

Constructor.

◆ ~QwtPlotRenderer()

QwtPlotRenderer::~QwtPlotRenderer ( )

virtual

Destructor .

Member Function Documentation

◆ discardFlags()

QwtPlotRenderer::DiscardFlags QwtPlotRenderer::discardFlags ( ) const

Get the flags indicating what to discard from rendering.

◆ exportTo()

bool QwtPlotRenderer::exportTo	(	QwtPlot *	plot,
		const QString &	documentName,
		const QSizeF &	sizeMM = `QSizeF( 300, 200 )`,
		int	resolution = `85`
	)

Execute a file dialog and render the plot to the selected file.

◆ layoutFlags()

QwtPlotRenderer::LayoutFlags QwtPlotRenderer::layoutFlags ( ) const

Get the layout flags.

◆ render()

void QwtPlotRenderer::render	(	QwtPlot *	plot,
		QPainter *	painter,
		const QRectF &	plotRect
	)		const

virtual

Paint the contents of a QwtPlot instance into a given rectangle.

◆ renderCanvas()

void QwtPlotRenderer::renderCanvas	(	const QwtPlot *	plot,
		QPainter *	painter,
		const QRectF &	canvasRect,
		const QwtScaleMap *	maps
	)		const

virtual

Render the canvas into a given rectangle.

◆ renderDocument() [1/2]

void QwtPlotRenderer::renderDocument	(	QwtPlot *	plot,
		const QString &	fileName,
		const QSizeF &	sizeMM,
		int	resolution = `85`
	)

Render a plot to a file.

◆ renderDocument() [2/2]

void QwtPlotRenderer::renderDocument	(	QwtPlot *	plot,
		const QString &	fileName,
		const QString &	format,
		const QSizeF &	sizeMM,
		int	resolution = `85`
	)

Render a plot to a file with specified format.

◆ renderFooter()

void QwtPlotRenderer::renderFooter	(	const QwtPlot *	plot,
		QPainter *	painter,
		const QRectF &	footerRect
	)		const

virtual

Render the footer into a given rectangle.

◆ renderLegend()

void QwtPlotRenderer::renderLegend	(	const QwtPlot *	plot,
		QPainter *	painter,
		const QRectF &	legendRect
	)		const

virtual

Render the legend into a given rectangle.

◆ renderScale()

void QwtPlotRenderer::renderScale	(	const QwtPlot *	plot,
		QPainter *	painter,
		QwtAxisId	axisId,
		int	startDist,
		int	endDist,
		int	baseDist,
		const QRectF &	scaleRect
	)		const

virtual

Paint a scale into a given rectangle.

◆ renderTitle()

void QwtPlotRenderer::renderTitle	(	const QwtPlot *	plot,
		QPainter *	painter,
		const QRectF &	titleRect
	)		const

virtual

Render the title into a given rectangle.

◆ renderTo() [1/2]

void QwtPlotRenderer::renderTo	(	QwtPlot *	plot,
		QPaintDevice &	paintDevice
	)		const

Render the plot to a QPaintDevice.

◆ renderTo() [2/2]

void QwtPlotRenderer::renderTo	(	QwtPlot *	plot,
		QPrinter &	printer
	)		const

Render the plot to a QPrinter.

◆ setDiscardFlag()

void QwtPlotRenderer::setDiscardFlag	(	DiscardFlag	flag,
		bool	on = `true`
	)

Change a flag, indicating what to discard from rendering.

◆ setDiscardFlags()

void QwtPlotRenderer::setDiscardFlags ( DiscardFlags flags )

Set the flags, indicating what to discard from rendering.

◆ setLayoutFlag()

void QwtPlotRenderer::setLayoutFlag	(	LayoutFlag	flag,
		bool	on = `true`
	)

Change a layout flag.

◆ setLayoutFlags()

void QwtPlotRenderer::setLayoutFlags ( LayoutFlags flags )

Set the layout flags.

◆ testDiscardFlag()

bool QwtPlotRenderer::testDiscardFlag ( DiscardFlag flag ) const

Test if a discard flag is enabled.

◆ testLayoutFlag()

bool QwtPlotRenderer::testLayoutFlag ( LayoutFlag flag ) const

Test if a layout flag is enabled.

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

/home/runner/work/QWT/QWT/src/plot/qwt_plot_renderer.h
/home/runner/work/QWT/QWT/src/plot/qwt_plot_renderer.cpp

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ DiscardFlag

◆ LayoutFlag

Constructor & Destructor Documentation

◆ QwtPlotRenderer()

◆ ~QwtPlotRenderer()

Member Function Documentation

◆ discardFlags()

◆ exportTo()

◆ layoutFlags()

◆ render()

◆ renderCanvas()

◆ renderDocument() [1/2]

◆ renderDocument() [2/2]

◆ renderFooter()

◆ renderLegend()

◆ renderScale()

◆ renderTitle()

◆ renderTo() [1/2]

◆ renderTo() [2/2]

◆ setDiscardFlag()

◆ setDiscardFlags()

◆ setLayoutFlag()

◆ setLayoutFlags()

◆ testDiscardFlag()

◆ testLayoutFlag()