qwt_plot_renderer.h

/******************************************************************************
 * Qwt Widget Library
 * Copyright (C) 1997   Josef Wilgen
 * Copyright (C) 2002   Uwe Rathmann
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the Qwt License, Version 1.0
 *
 * Modified by ChenZongYan in 2024 <czy.t@163.com>
 *   Summary of major modifications (see ChangeLog.md for full history):
 *   1. CMake build system & C++11 throughout.
 *   2. Core panner/ zoomer refactored:
 *        - QwtPanner → QwtCachePanner (pixmap-cache version)
 *        - New real-time QwtPlotPanner derived from QwtPicker.
 *   3. Zoomer supports multi-axis.
 *   4. Parasite-plot framework:
 *        - QwtFigure, QwtPlotParasiteLayout, QwtPlotTransparentCanvas,
 *        - QwtPlotScaleEventDispatcher, built-in pan/zoom on axis.
 *   5. New picker: QwtPlotSeriesDataPicker (works with date axis).
 *   6. Raster & color-map extensions:
 *        - QwtGridRasterData (2-D table + interpolation)
 *        - QwtLinearColorMap::stopColors(), stopPos() API rename.
 *   7. Bar-chart: expose pen/brush control.
 *   8. Amalgamated build: single QwtPlot.h / QwtPlot.cpp pair in src-amalgamate.
 *****************************************************************************/
 
#ifndef QWT_PLOT_RENDERER_H
#define QWT_PLOT_RENDERER_H
 
#include "qwt_global.h"
#include "qwt_axis_id.h"
 
#include <qobject.h>
#include <qsize.h>
 
class QwtPlot;
class QwtScaleMap;
class QRectF;
class QPainter;
class QPaintDevice;
 
#ifndef QT_NO_PRINTER
class QPrinter;
#endif
 
#ifndef QWT_NO_SVG
#ifdef QT_SVG_LIB
class QSvgGenerator;
#endif
#endif
 
class QWT_EXPORT QwtPlotRenderer : public QObject
{
    Q_OBJECT
 
  public:
    enum DiscardFlag
    {
        DiscardNone             = 0x00,
 
        DiscardBackground       = 0x01,
 
        DiscardTitle            = 0x02,
 
        DiscardLegend           = 0x04,
 
        DiscardCanvasBackground = 0x08,
 
        DiscardFooter           = 0x10,
 
        DiscardCanvasFrame           = 0x20
 
    };
 
    Q_DECLARE_FLAGS( DiscardFlags, DiscardFlag )
 
    
    enum LayoutFlag
    {
        DefaultLayout   = 0x00,
 
        FrameWithScales = 0x01
    };
 
    Q_DECLARE_FLAGS( LayoutFlags, LayoutFlag )
 
    // Constructor
    explicit QwtPlotRenderer( QObject* = nullptr );
    // Destructor
    virtual ~QwtPlotRenderer();
 
    // Set a discard flag
    void setDiscardFlag( DiscardFlag flag, bool on = true );
    // Test a discard flag
    bool testDiscardFlag( DiscardFlag flag ) const;
 
    // Set discard flags
    void setDiscardFlags( DiscardFlags flags );
    // Get discard flags
    DiscardFlags discardFlags() const;
 
    // Set a layout flag
    void setLayoutFlag( LayoutFlag flag, bool on = true );
    // Test a layout flag
    bool testLayoutFlag( LayoutFlag flag ) const;
 
    // Set layout flags
    void setLayoutFlags( LayoutFlags flags );
    // Get layout flags
    LayoutFlags layoutFlags() const;
 
    // Render the plot to a document
    void renderDocument( QwtPlot*, const QString& fileName,
        const QSizeF& sizeMM, int resolution = 85 );
 
    // Render the plot to a document with specified format
    void renderDocument( QwtPlot*, 
        const QString& fileName, const QString& format, 
        const QSizeF& sizeMM, int resolution = 85 );
 
#ifndef QWT_NO_SVG
#ifdef QT_SVG_LIB
    // Render the plot to an SVG generator
    void renderTo( QwtPlot*, QSvgGenerator& ) const;
#endif
#endif
 
#ifndef QT_NO_PRINTER
    // Render the plot to a printer
    void renderTo( QwtPlot*, QPrinter& ) const;
#endif
 
    // Render the plot to a paint device
    void renderTo( QwtPlot*, QPaintDevice& ) const;
 
    // Render the plot
    virtual void render( QwtPlot*,
        QPainter*, const QRectF& plotRect ) const;
 
    // Render the title
    virtual void renderTitle( const QwtPlot*,
        QPainter*, const QRectF& titleRect ) const;
 
    // Render the footer
    virtual void renderFooter( const QwtPlot*,
        QPainter*, const QRectF& footerRect ) const;
 
    // Render a scale
    virtual void renderScale( const QwtPlot*, QPainter*,
        QwtAxisId, int startDist, int endDist,
        int baseDist, const QRectF& scaleRect ) const;
 
    // Render the canvas
    virtual void renderCanvas( const QwtPlot*,
        QPainter*, const QRectF& canvasRect,
        const QwtScaleMap* maps ) const;
 
    // Render the legend
    virtual void renderLegend(
        const QwtPlot*, QPainter*, const QRectF& legendRect ) const;
 
    // Export the plot to a document
    bool exportTo( QwtPlot*, const QString& documentName,
        const QSizeF& sizeMM = QSizeF( 300, 200 ), int resolution = 85 );
 
  private:
    void buildCanvasMaps( const QwtPlot*,
        const QRectF&, QwtScaleMap maps[] ) const;
 
    bool updateCanvasMargins( QwtPlot*,
        const QRectF&, const QwtScaleMap maps[] ) const;
 
  private:
    class PrivateData;
    PrivateData* m_data;
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS( QwtPlotRenderer::DiscardFlags )
Q_DECLARE_OPERATORS_FOR_FLAGS( QwtPlotRenderer::LayoutFlags )
 
#endif