signalplotter.h

Go to the documentation of this file.

/*
 *   KSysGuard, the KDE System Guard
 *
 *   Copyright 1999 - 2001 Chris Schlaeger <cs@kde.org>
 *
 *   This program 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, or
 *   (at your option) any later version.

 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef PLASMA_SIGNALPLOTTER_H
#define PLASMA_SIGNALPLOTTER_H

#include <QtGui/QFont>
#include <QtGui/QGraphicsWidget>
#include <plasma/plasma_export.h>

namespace Plasma
{

class SignalPlotterPrivate;

struct PlotColor
{
    QColor color;
    QColor darkColor;
};

class PLASMA_EXPORT SignalPlotter : public QGraphicsWidget
{
    Q_OBJECT
    Q_PROPERTY(QString title READ title WRITE setTitle)
    Q_PROPERTY(QString unit READ unit WRITE setUnit)
    Q_PROPERTY(qreal scale READ scaledBy WRITE scale) // Note: The naming of the functions here is poor
    Q_PROPERTY(bool useAutoRange READ useAutoRange WRITE setUseAutoRange)
    Q_PROPERTY(uint horizontalScale READ horizontalScale WRITE setHorizontalScale)
    Q_PROPERTY(bool showVerticalLines READ showVerticalLines WRITE setShowVerticalLines)
    Q_PROPERTY(QColor verticalLinesColor READ verticalLinesColor WRITE setVerticalLinesColor)
    Q_PROPERTY(uint verticalLinesDistance READ verticalLinesDistance WRITE setVerticalLinesDistance)
    Q_PROPERTY(bool verticalLinesScroll READ verticalLinesScroll WRITE setVerticalLinesScroll)
    Q_PROPERTY(bool showHorizontalLines READ showHorizontalLines WRITE setShowHorizontalLines)
    Q_PROPERTY(QColor horizontalLinesColor READ horizontalLinesColor WRITE setHorizontalLinesColor)
    Q_PROPERTY(QColor fontColor READ fontColor WRITE setFontColor)
    Q_PROPERTY(QFont font READ font WRITE setFont)
    Q_PROPERTY(uint horizontalLinesCount READ horizontalLinesCount WRITE setHorizontalLinesCount)
    Q_PROPERTY(bool showLabels READ showLabels WRITE setShowLabels)
    Q_PROPERTY(bool showTopBar READ showTopBar WRITE setShowTopBar)
    Q_PROPERTY(QColor backgroundColor READ backgroundColor WRITE setBackgroundColor)
    Q_PROPERTY(QString svgBackground READ svgBackground WRITE setSvgBackground)
    Q_PROPERTY(bool thinFrame READ thinFrame WRITE setThinFrame)
    Q_PROPERTY(bool stackPlots READ stackPlots WRITE setStackPlots)

public:
    SignalPlotter(QGraphicsItem *parent = 0);
    ~SignalPlotter();

    Q_INVOKABLE void addPlot(const QColor &color);

    Q_INVOKABLE void addSample(const QList<double> &samples);

    Q_INVOKABLE void reorderPlots(const QList<uint>& newOrder);

    Q_INVOKABLE void removePlot(uint pos);

    QList<PlotColor> &plotColors();

    void setTitle(const QString &title);

    QString title() const;

    void setUnit(const QString &unit);

    QString unit() const;

    void scale(qreal delta);

    qreal scaledBy() const;

    void setUseAutoRange(bool value);

    bool useAutoRange() const;

    void setVerticalRange(double min, double max);

    double verticalMinValue() const;

    double verticalMaxValue() const;

    void setHorizontalScale(uint scale);

    uint horizontalScale() const;

    void setShowVerticalLines(bool value);

    bool showVerticalLines() const;

    void setVerticalLinesColor(const QColor &color);

    QColor verticalLinesColor() const;

    void setVerticalLinesDistance(uint distance);

    uint verticalLinesDistance() const;

    void setVerticalLinesScroll(bool value);

    bool verticalLinesScroll() const;

    void setShowHorizontalLines(bool value);
    bool showHorizontalLines() const;

    void setHorizontalLinesColor(const QColor &color);

    QColor horizontalLinesColor() const;

    void setFontColor(const QColor &color);

    QColor fontColor() const;

    void setFont(const QFont &font);

    QFont font() const;

    void setHorizontalLinesCount(uint count);

    uint horizontalLinesCount() const;

    void setShowLabels(bool value);

    bool showLabels() const;

    void setShowTopBar(bool value);

    bool showTopBar() const;

    void setBackgroundColor(const QColor &color);

    QColor backgroundColor() const;

    void setSvgBackground(const QString &filename);

    QString svgBackground();

    double lastValue(uint i) const;

    QString lastValueAsString(uint i) const;

    void setThinFrame(bool set);

    bool thinFrame() const;

    void setStackPlots(bool stack);

    bool stackPlots() const;

    QPixmap getSnapshotImage(uint width, uint height);

    virtual void setGeometry(const QRectF &geometry);

protected:
    void updateDataBuffers();
    void calculateNiceRange();

    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget);

    void drawWidget(QPainter *p, uint w, uint height, int horizontalScale);
    void drawBackground(QPainter *p, int w, int h);
    void drawThinFrame(QPainter *p, int w, int h);
    void drawTopBarFrame(QPainter *p, int separatorX, int height);
    void drawTopBarContents(QPainter *p, int x, int width, int height);
    void drawVerticalLines(QPainter *p, int top, int w, int h);
    void drawPlots(QPainter *p, int top, int w, int h, int horizontalScale);
    void drawAxisText(QPainter *p, int top, int h);
    void drawHorizontalLines(QPainter *p, int top, int w, int h);

private:
    SignalPlotterPrivate *const d;
    Q_PRIVATE_SLOT(d, void themeChanged())
};

} // Plasma namespace

#endif