Qwt User's Guide svn
Public Types | Public Member Functions | Protected Member Functions
QwtPlotRenderer Class Reference

#include <qwt_plot_renderer.h>

List of all members.

Public Types

enum  DiscardFlag {
  DiscardNone = 0x00,
  DiscardBackground = 0x01,
  DiscardTitle = 0x02,
  DiscardLegend = 0x04,
  DiscardCanvasBackground = 0x08
}
typedef QFlags< DiscardFlagDiscardFlags
enum  LayoutFlag {
  DefaultLayout = 0x00,
  KeepFrames = 0x01,
  FrameWithScales = 0x02
}
typedef QFlags< LayoutFlagLayoutFlags

Public Member Functions

DiscardFlags discardFlags () const
LayoutFlags layoutFlags () const
 QwtPlotRenderer (QObject *=NULL)
virtual void render (QwtPlot *, QPainter *, const QRectF &rect) const
virtual void renderCanvas (const QwtPlot *, QPainter *, const QRectF &canvasRect, const QwtScaleMap *maps) const
void renderDocument (QwtPlot *, const QString &fileName, const QSizeF &sizeMM, int resolution=85)
void renderDocument (QwtPlot *, const QString &title, const QString &fileName, const QSizeF &sizeMM, int resolution=85)
virtual void renderLegend (const QwtPlot *, QPainter *, const QRectF &) const
virtual void renderLegendItem (const QwtPlot *, QPainter *, const QWidget *, const QRectF &) const
virtual void renderScale (const QwtPlot *, QPainter *, int axisId, int startDist, int endDist, int baseDist, const QRectF &) const
virtual void renderTitle (const QwtPlot *, QPainter *, const QRectF &) const
void renderTo (QwtPlot *, QPrinter &) const
void renderTo (QwtPlot *, QPaintDevice &p) const
void setDiscardFlag (DiscardFlag flag, bool on=true)
void setDiscardFlags (DiscardFlags flags)
void setLayoutFlag (LayoutFlag flag, bool on=true)
void setLayoutFlags (LayoutFlags flags)
bool testDiscardFlag (DiscardFlag flag) const
bool testLayoutFlag (LayoutFlag flag) const
virtual ~QwtPlotRenderer ()

Protected Member Functions

void buildCanvasMaps (const QwtPlot *, const QRectF &, QwtScaleMap maps[]) const

Detailed Description

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


Member Typedef Documentation

Disard flags.

Layout flags.


Member Enumeration Documentation

Disard 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.

Layout flags.

See also:
setLayoutFlag(), testLayoutFlag()
Enumerator:
DefaultLayout 

Use the default layout without margins and frames.

KeepFrames 

Render all frames of the plot.

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 ( QObject *  parent = NULL) [explicit]

Constructor

Parameters:
parentParent object
QwtPlotRenderer::~QwtPlotRenderer ( ) [virtual]

Destructor.


Member Function Documentation

void QwtPlotRenderer::buildCanvasMaps ( const QwtPlot plot,
const QRectF &  canvasRect,
QwtScaleMap  maps[] 
) const [protected]

Calculated the scale maps for rendering the canvas

Parameters:
plotPlot widget
canvasRectTarget rectangle
mapsScale maps to be calculated
QwtPlotRenderer::DiscardFlags QwtPlotRenderer::discardFlags ( ) const
Returns:
Flags, indicating what to discard from rendering
See also:
DiscardFlag, setDiscardFlags(), setDiscardFlag(), testDiscardFlag()
QwtPlotRenderer::LayoutFlags QwtPlotRenderer::layoutFlags ( ) const
Returns:
Layout flags
See also:
LayoutFlag, setLayoutFlags(), setLayoutFlag(), testLayoutFlag()
void QwtPlotRenderer::render ( QwtPlot plot,
QPainter *  painter,
const QRectF &  plotRect 
) const [virtual]

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

Parameters:
plotPlot to be rendered
painterPainter
plotRectBounding rectangle
See also:
renderDocument(), renderTo(), QwtPainter::setRoundingAlignment()
void QwtPlotRenderer::renderCanvas ( const QwtPlot plot,
QPainter *  painter,
const QRectF &  canvasRect,
const QwtScaleMap map 
) const [virtual]

Render the canvas into a given rectangle.

Parameters:
plotPlot widget
painterPainter
mapMaps mapping between plot and paint device coordinates
canvasRectCanvas rectangle
void QwtPlotRenderer::renderDocument ( QwtPlot plot,
const QString &  fileName,
const QSizeF &  sizeMM,
int  resolution = 85 
)

Render a plot to a file

The format of the document will be autodetected from the suffix of the filename.

Parameters:
plotPlot widget
fileNamePath of the file, where the document will be stored
sizeMMSize for the document in millimeters.
resolutionResolution in dots per Inch (dpi)
void QwtPlotRenderer::renderDocument ( QwtPlot plot,
const QString &  fileName,
const QString &  format,
const QSizeF &  sizeMM,
int  resolution = 85 
)

Render a plot to a file

Supported formats are:

  • pdf
    Portable Document Format PDF
  • ps
    Postcript
  • svg
    Scalable Vector Graphics SVG
  • all image formats supported by Qt
    see QImageWriter::supportedImageFormats()

Scalable vector graphic formats like PDF or SVG are superior to raster graphics formats.

Parameters:
plotPlot widget
fileNamePath of the file, where the document will be stored
formatFormat for the document
sizeMMSize for the document in millimeters.
resolutionResolution in dots per Inch (dpi)
See also:
renderTo(), render(), QwtPainter::setRoundingAlignment()
void QwtPlotRenderer::renderLegend ( const QwtPlot plot,
QPainter *  painter,
const QRectF &  rect 
) const [virtual]

Render the legend into a given rectangle.

Parameters:
plotPlot widget
painterPainter
rectBounding rectangle
void QwtPlotRenderer::renderLegendItem ( const QwtPlot plot,
QPainter *  painter,
const QWidget *  widget,
const QRectF &  rect 
) const [virtual]

Render the legend item into a given rectangle.

Parameters:
plotPlot widget
painterPainter
widgetWidget representing a legend item
rectBounding rectangle
Note:
When widget is not derived from QwtLegendItem renderLegendItem does nothing and needs to be overloaded
void QwtPlotRenderer::renderScale ( const QwtPlot plot,
QPainter *  painter,
int  axisId,
int  startDist,
int  endDist,
int  baseDist,
const QRectF &  rect 
) const [virtual]

Paint a scale into a given rectangle. Paint the scale into a given rectangle.

Parameters:
plotPlot widget
painterPainter
axisIdAxis
startDistStart border distance
endDistEnd border distance
baseDistBase distance
rectBounding rectangle
void QwtPlotRenderer::renderTitle ( const QwtPlot plot,
QPainter *  painter,
const QRectF &  rect 
) const [virtual]

Render the title into a given rectangle.

Parameters:
plotPlot widget
painterPainter
rectBounding rectangle
void QwtPlotRenderer::renderTo ( QwtPlot plot,
QPrinter &  printer 
) const

Render the plot to a QPrinter.

This function renders the contents of a QwtPlot instance to QPaintDevice object. The size is derived from the printer metrics.

Parameters:
plotPlot to be rendered
printerPrinter to paint on
See also:
renderDocument(), render(), QwtPainter::setRoundingAlignment()
void QwtPlotRenderer::renderTo ( QwtPlot plot,
QPaintDevice &  paintDevice 
) const

Render the plot to a QPaintDevice.

This function renders the contents of a QwtPlot instance to QPaintDevice object. The target rectangle is derived from its device metrics.

Parameters:
plotPlot to be rendered
paintDevicedevice to paint on, f.e a QImage
See also:
renderDocument(), render(), QwtPainter::setRoundingAlignment()
void QwtPlotRenderer::setDiscardFlag ( DiscardFlag  flag,
bool  on = true 
)

Change a flag, indicating what to discard from rendering

Parameters:
flagFlag to change
onOn/Off
See also:
DiscardFlag, testDiscardFlag(), setDiscardFlags(), discardFlags()
void QwtPlotRenderer::setDiscardFlags ( DiscardFlags  flags)

Set the flags, indicating what to discard from rendering

Parameters:
flagsFlags
See also:
DiscardFlag, setDiscardFlag(), testDiscardFlag(), discardFlags()
void QwtPlotRenderer::setLayoutFlag ( LayoutFlag  flag,
bool  on = true 
)

Change a layout flag

Parameters:
flagFlag to change
onOn/Off
See also:
LayoutFlag, testLayoutFlag(), setLayoutFlags(), layoutFlags()
void QwtPlotRenderer::setLayoutFlags ( LayoutFlags  flags)

Set the layout flags

Parameters:
flagsFlags
See also:
LayoutFlag, setLayoutFlag(), testLayoutFlag(), layoutFlags()
bool QwtPlotRenderer::testDiscardFlag ( DiscardFlag  flag) const

Check if a flag is set.

Parameters:
flagFlag to be tested
See also:
DiscardFlag, setDiscardFlag(), setDiscardFlags(), discardFlags()
bool QwtPlotRenderer::testLayoutFlag ( LayoutFlag  flag) const

Check if a flag is set.

Parameters:
flagFlag to be tested
See also:
LayoutFlag, setLayoutFlag(), setLayoutFlags(), layoutFlags()
qmi style