kplotwidget.h

Go to the documentation of this file.

/*  -*- C++ -*-
    This file is part of the KDE libraries
    Copyright (C) 2003 Jason Harris <kstars@30doradus.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KPLOTWIDGET_H
#define KPLOTWIDGET_H

#include <kdeui_export.h>

#include <QtGui/QFrame>
#include <QtCore/QList>

class KPlotAxis;
class KPlotObject;
class KPlotPoint;

class KDEUI_EXPORT KPlotWidget : public QFrame {
    Q_OBJECT
    Q_PROPERTY(int leftPadding READ leftPadding)
    Q_PROPERTY(int rightPadding READ rightPadding)
    Q_PROPERTY(int topPadding READ topPadding)
    Q_PROPERTY(int bottomPadding READ bottomPadding)
    Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
    Q_PROPERTY(QColor foregroundColor READ foregroundColor WRITE setForegroundColor)
    Q_PROPERTY(QColor gridColor READ gridColor WRITE setGridColor)
    Q_PROPERTY(bool grid READ isGridShown WRITE setShowGrid)
    Q_PROPERTY(bool objectToolTip READ isObjectToolTipShown WRITE setObjectToolTipShown)
public:
    explicit KPlotWidget( QWidget * parent = 0 );

    virtual ~KPlotWidget();

    enum Axis
    {
        LeftAxis = 0,  
        BottomAxis,    
        RightAxis,     
        TopAxis        
    };

    virtual QSize minimumSizeHint() const;

    virtual QSize sizeHint() const;

    void setLimits( double x1, double x2, double y1, double y2 );

    void setSecondaryLimits( double x1, double x2, double y1, double y2 );

    void clearSecondaryLimits();

    QRectF dataRect() const;

    QRectF secondaryDataRect() const;

    QRect pixRect() const;

    void addPlotObject( KPlotObject *object );

    void addPlotObjects( const QList< KPlotObject* >& objects );

    QList< KPlotObject* > plotObjects() const;

    void removeAllPlotObjects();

    void resetPlotMask();

    void resetPlot();

    void replacePlotObject( int i, KPlotObject *o );

    QColor backgroundColor() const;

    QColor foregroundColor() const;

    QColor gridColor() const;

    void setBackgroundColor( const QColor &bg );

    void setForegroundColor( const QColor &fg );

    void setGridColor( const QColor &gc );

    bool isGridShown() const;

    bool isObjectToolTipShown() const;

    bool antialiasing() const;

    void setAntialiasing( bool b );

    int leftPadding() const;

    int rightPadding() const;

    int topPadding() const;

    int bottomPadding() const;

    void setLeftPadding( int padding );

    void setRightPadding( int padding );

    void setTopPadding( int padding );

    void setBottomPadding( int padding );

    void setDefaultPaddings();

    QPointF mapToWidget( const QPointF& p ) const;

    void maskRect( const QRectF &r, float value=1.0 );

    void maskAlongLine( const QPointF &p1, const QPointF &p2, float value=1.0 );

    void placeLabel( QPainter *painter, KPlotPoint *pp );

    KPlotAxis* axis( Axis type );

    const KPlotAxis* axis( Axis type ) const;


public Q_SLOTS:
    void setShowGrid( bool show );

    void setObjectToolTipShown( bool show );

protected:
    virtual bool event( QEvent* );

    virtual void paintEvent( QPaintEvent* );

    virtual void resizeEvent( QResizeEvent* );

    virtual void drawAxes( QPainter *p );

    void setPixRect();

    QList<KPlotPoint*> pointsUnderPoint( const QPoint& p ) const;

private:
    class Private;
    Private * const d;

    Q_DISABLE_COPY( KPlotWidget )
};

#endif