QwtPlotRenderer(3) Qwt User's Guide QwtPlotRenderer(3) NAME QwtPlotRenderer - Renderer for exporting a plot to a document, a printer or anything else, that is supported by QPainter/QPaintDevice. SYNOPSIS #include Inherits QObject. Public Types enum DiscardFlag { DiscardNone = 0x00, DiscardBackground = 0x01, DiscardTitle = 0x02, DiscardLegend = 0x04, DiscardCanvasBackground = 0x08, DiscardFooter = 0x10, DiscardCanvasFrame = 0x20 } Discard flags. enum LayoutFlag { DefaultLayout = 0x00, FrameWithScales = 0x01 } Layout flags. typedef QFlags< DiscardFlag > DiscardFlags typedef QFlags< LayoutFlag > LayoutFlags Public Member Functions QwtPlotRenderer (QObject *=NULL) virtual ~QwtPlotRenderer () Destructor. void setDiscardFlag (DiscardFlag flag, bool on=true) bool testDiscardFlag (DiscardFlag flag) const void setDiscardFlags (DiscardFlags flags) DiscardFlags discardFlags () const void setLayoutFlag (LayoutFlag flag, bool on=true) bool testLayoutFlag (LayoutFlag flag) const void setLayoutFlags (LayoutFlags flags) LayoutFlags layoutFlags () const void renderDocument (QwtPlot *, const QString &fileName, const QSizeF &sizeMM, int resolution=85) void renderDocument (QwtPlot *, const QString &fileName, const QString &format, const QSizeF &sizeMM, int resolution=85) 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 virtual void renderTitle (const QwtPlot *, QPainter *, const QRectF &titleRect) const virtual void renderFooter (const QwtPlot *, QPainter *, const QRectF &footerRect) const virtual void renderScale (const QwtPlot *, QPainter *, QwtAxisId, int startDist, int endDist, int baseDist, const QRectF &scaleRect) const Paint a scale into a given rectangle. Paint the scale into a given rectangle. virtual void renderCanvas (const QwtPlot *, QPainter *, const QRectF &canvasRect, const QwtScaleMap *maps) const virtual void renderLegend (const QwtPlot *, QPainter *, const QRectF &legendRect) const 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. Definition at line 39 of file qwt_plot_renderer.h. Member Typedef Documentation typedef QFlags QwtPlotRenderer::DiscardFlags An ORed combination of DiscardFlag values. Definition at line 76 of file qwt_plot_renderer.h. typedef QFlags QwtPlotRenderer::LayoutFlags An ORed combination of LayoutFlag values. Definition at line 94 of file qwt_plot_renderer.h. Member Enumeration Documentation 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 Definition at line 45 of file qwt_plot_renderer.h. enum QwtPlotRenderer::LayoutFlag Layout flags. See also setLayoutFlag(), testLayoutFlag() 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. Definition at line 82 of file qwt_plot_renderer.h. Constructor & Destructor Documentation QwtPlotRenderer::QwtPlotRenderer (QObject * parent = NULL) [explicit] Constructor Parameters parent Parent object Definition at line 146 of file qwt_plot_renderer.cpp. Member Function Documentation QwtPlotRenderer::DiscardFlags QwtPlotRenderer::discardFlags () const Returns Flags, indicating what to discard from rendering See also DiscardFlag, setDiscardFlags(), setDiscardFlag(), testDiscardFlag() Definition at line 199 of file qwt_plot_renderer.cpp. 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. Parameters plot Plot widget documentName Default document name sizeMM Size for the document in millimeters. resolution Resolution in dots per Inch (dpi) Returns True, when exporting was successful See also renderDocument() Definition at line 1060 of file qwt_plot_renderer.cpp. QwtPlotRenderer::LayoutFlags QwtPlotRenderer::layoutFlags () const Returns Layout flags See also LayoutFlag, setLayoutFlags(), setLayoutFlag(), testLayoutFlag() Definition at line 245 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::render (QwtPlot * plot, QPainter * painter, const QRectF & plotRect) const [virtual] Paint the contents of a QwtPlot instance into a given rectangle. Parameters plot Plot to be rendered painter Painter plotRect Bounding rectangle See also renderDocument(), renderTo(), QwtPainter::setRoundingAlignment() Definition at line 482 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::renderCanvas (const QwtPlot * plot, QPainter * painter, const QRectF & canvasRect, const QwtScaleMap * maps) const [virtual] Render the canvas into a given rectangle. Parameters plot Plot widget painter Painter maps Maps mapping between plot and paint device coordinates canvasRect Canvas rectangle Definition at line 831 of file qwt_plot_renderer.cpp. 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 auto-detected from the suffix of the file name. Parameters plot Plot widget fileName Path of the file, where the document will be stored sizeMM Size for the document in millimeters. resolution Resolution in dots per Inch (dpi) Definition at line 261 of file qwt_plot_renderer.cpp. 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: o pdf Portable Document Format PDF o ps Postcript o svg Scalable Vector Graphics SVG o all image formats supported by Qt see QImageWriter::supportedImageFormats() Scalable vector graphic formats like PDF or SVG are superior to raster graphics formats. Parameters plot Plot widget fileName Path of the file, where the document will be stored format Format for the document sizeMM Size for the document in millimeters. resolution Resolution in dots per Inch (dpi) See also renderTo(), render(), QwtPainter::setRoundingAlignment() Definition at line 293 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::renderFooter (const QwtPlot * plot, QPainter * painter, const QRectF & footerRect) const [virtual] Render the footer into a given rectangle. Parameters plot Plot widget painter Painter footerRect Bounding rectangle for the footer Definition at line 692 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::renderLegend (const QwtPlot * plot, QPainter * painter, const QRectF & legendRect) const [virtual] Render the legend into a given rectangle. Parameters plot Plot widget painter Painter legendRect Bounding rectangle for the legend Definition at line 711 of file qwt_plot_renderer.cpp. 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. Paint the scale into a given rectangle. Parameters plot Plot widget painter Painter axisId Axis startDist Start border distance endDist End border distance baseDist Base distance scaleRect Bounding rectangle for the scale Definition at line 733 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::renderTitle (const QwtPlot * plot, QPainter * painter, const QRectF & titleRect) const [virtual] Render the title into a given rectangle. Parameters plot Plot widget painter Painter titleRect Bounding rectangle for the title Definition at line 673 of file qwt_plot_renderer.cpp. 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 plot Plot to be rendered paintDevice device to paint on, f.e a QImage See also renderDocument(), render(), QwtPainter::setRoundingAlignment() Definition at line 402 of file qwt_plot_renderer.cpp. 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 plot Plot to be rendered printer Printer to paint on See also renderDocument(), render(), QwtPainter::setRoundingAlignment() Definition at line 427 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::setDiscardFlag (DiscardFlag flag, bool on = true) Change a flag, indicating what to discard from rendering Parameters flag Flag to change on On/Off See also DiscardFlag, testDiscardFlag(), setDiscardFlags(), discardFlags() Definition at line 166 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::setDiscardFlags (DiscardFlags flags) Set the flags, indicating what to discard from rendering Parameters flags Flags See also DiscardFlag, setDiscardFlag(), testDiscardFlag(), discardFlags() Definition at line 190 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::setLayoutFlag (LayoutFlag flag, bool on = true) Change a layout flag Parameters flag Flag to change on On/Off See also LayoutFlag, testLayoutFlag(), setLayoutFlags(), layoutFlags() Definition at line 212 of file qwt_plot_renderer.cpp. void QwtPlotRenderer::setLayoutFlags (LayoutFlags flags) Set the layout flags Parameters flags Flags See also LayoutFlag, setLayoutFlag(), testLayoutFlag(), layoutFlags() Definition at line 236 of file qwt_plot_renderer.cpp. bool QwtPlotRenderer::testDiscardFlag (DiscardFlag flag) const Returns True, if flag is enabled. Parameters flag Flag to be tested See also DiscardFlag, setDiscardFlag(), setDiscardFlags(), discardFlags() Definition at line 179 of file qwt_plot_renderer.cpp. bool QwtPlotRenderer::testLayoutFlag (LayoutFlag flag) const Returns True, if flag is enabled. Parameters flag Flag to be tested See also LayoutFlag, setLayoutFlag(), setLayoutFlags(), layoutFlags() Definition at line 225 of file qwt_plot_renderer.cpp. Author Generated automatically by Doxygen for Qwt User's Guide from the source code. Version 6.2.0 Sun Jul 18 2021 QwtPlotRenderer(3)