qwt_plot_abstract_barchart.h

/* -*- mode: C++ ; c-file-style: "stroustrup" -*- *****************************
 * 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
 *****************************************************************************/

#ifndef QWT_PLOT_ABSTRACT_BAR_CHART_H
#define QWT_PLOT_ABSTRACT_BAR_CHART_H

#include "qwt_global.h"
#include "qwt_plot_seriesitem.h"
#include "qwt_series_data.h"

/*!
  \brief Abstract base class for bar chart items

  In opposite to almost all other plot items bar charts can't be
  displayed inside of their bounding rectangle and need a special
  API  how to calculate the width of the bars and how they affect
  the layout of the attached plot.
 */
class QWT_EXPORT QwtPlotAbstractBarChart: public QwtPlotSeriesItem
{
public:
    /*!
        \brief Mode how to calculate the bar width

        setLayoutPolicy(), setLayoutHint(), barWidthHint()
     */
    enum LayoutPolicy
    {
        /*!
          The sample width is calculated by dividing the bounding rectangle
          by the number of samples. The layoutHint() is used as a minimum width
          in paint device coordinates.

          \sa boundingRectangle()
         */
        AutoAdjustSamples,

        /*!
          layoutHint() defines an interval in axis coordinates
         */
        ScaleSamplesToAxes,

        /*!
          The bar width is calculated by multiplying layoutHint()
          with the height or width of the canvas.

          \sa boundingRectangle()
         */
        ScaleSampleToCanvas,

        /*!
          layoutHint() defines a fixed width in paint device coordinates.
         */
        FixedSampleSize
    };

    explicit QwtPlotAbstractBarChart( const QwtText &title );
    virtual ~QwtPlotAbstractBarChart();

    void setLayoutPolicy( LayoutPolicy );
    LayoutPolicy layoutPolicy() const;

    void setLayoutHint( double );
    double layoutHint() const;

    void setSpacing( int );
    int spacing() const;

    void setMargin( int );
    int margin() const;

    void setBaseline( double );
    double baseline() const;

    virtual void getCanvasMarginHint(
        const QwtScaleMap &xMap, const QwtScaleMap &yMap,
        const QRectF &canvasRect,
        double &left, double &top, double &right, double &bottom) const;


protected:
    double sampleWidth( const QwtScaleMap &map,
        double canvasSize, double boundingSize,
        double value ) const;

private:
    class PrivateData;
    PrivateData *d_data;
};

#endif