Bar.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2012  Florian Pose <fp@igh-essen.com>
 *
 * This file is part of the QtPdWidgets library.
 *
 * The QtPdWidgets library is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the License,
 * or (at your option) any later version.
 *
 * The QtPdWidgets 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 Lesser
 * General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with the QtPdWidgets Library. If not, see
 * <http://www.gnu.org/licenses/>.
 *
 ****************************************************************************/

#ifndef PD_BAR_H
#define PD_BAR_H

#include <QWidget>
#include <QPixmap>

#include "Export.h"

#include <QtPdCom1/ScalarSubscriber.h>
#include <QtPdCom1/Transmission.h>

#include <QScopedPointer>

namespace Pd {

class BarPrivate;

/****************************************************************************/

class PD_PUBLIC Bar: public QWidget
{
    Q_OBJECT
    Q_ENUMS(Orientation Style Origin)
    Q_PROPERTY(Orientation orientation
            READ getOrientation WRITE setOrientation RESET resetOrientation)
    Q_PROPERTY(Style style
            READ getStyle WRITE setStyle RESET resetStyle)
    Q_PROPERTY(bool showScale
            READ getShowScale WRITE setShowScale RESET resetShowScale)
    Q_PROPERTY(double scaleMin
            READ getScaleMin WRITE setScaleMin RESET resetScaleMin)
    Q_PROPERTY(double scaleMax
            READ getScaleMax WRITE setScaleMax RESET resetScaleMax)
    Q_PROPERTY(Origin origin
            READ getOrigin WRITE setOrigin RESET resetOrigin)
    Q_PROPERTY(int borderWidth
            READ getBorderWidth WRITE setBorderWidth RESET resetBorderWidth)
    Q_PROPERTY(QColor backgroundColor
            READ getBackgroundColor WRITE setBackgroundColor
            RESET resetBackgroundColor)
    Q_PROPERTY(bool autoBarWidth
            READ getAutoBarWidth WRITE setAutoBarWidth
            RESET resetAutoBarWidth)

    public:
        Bar(QWidget *parent = 0);
        virtual ~Bar();

        enum Orientation  {
            Vertical, 
            Horizontal 
        };
        Orientation getOrientation() const;
        void setOrientation(Orientation);
        void resetOrientation();

        enum Style  {
            ColorBar, 
            Arrow, 
            MultiColorBar 
        };
        Style getStyle() const;
        void setStyle(Style);
        void resetStyle();

        bool getShowScale() const;
        void setShowScale(bool);
        void resetShowScale();

        double getScaleMin() const;
        void setScaleMin(double);
        void resetScaleMin();

        double getScaleMax() const;
        void setScaleMax(double);
        void resetScaleMax();

        enum Origin {
            OriginZero, 
            OriginMinimum, 
            OriginMaximum, 
        };
        Origin getOrigin() const;
        void setOrigin(Origin);
        void resetOrigin();

        int getBorderWidth() const;
        void setBorderWidth(int);
        void resetBorderWidth();

        QColor getBackgroundColor() const;
        void setBackgroundColor(QColor);
        void resetBackgroundColor();

        bool getAutoBarWidth() const;
        void setAutoBarWidth(bool);
        void resetAutoBarWidth();

        QSize sizeHint() const override;

        void addVariable(
                PdCom::Variable pv, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );
        void addVariable(
                PdCom::Process *process, 
                const QString &path, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );

        void addStackedVariable(
                PdCom::Variable pv, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );
        void addStackedVariable(
                PdCom::Process *process, 
                const QString &path, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );

        void clearVariables();

        void setVariable(
                PdCom::Variable pv, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );
        void setVariable(
                PdCom::Process *process, 
                const QString &path, 
                const PdCom::Selector &selector = {}, 
                const QtPdCom::Transmission & = QtPdCom::event_mode, 
                double scale = 1.0, 
                double offset = 0.0, 
                double tau = 0.0, 
                QColor color = Qt::blue 
                );
        void clearData();

        void setGradientStops(const QGradientStops &);
        const QPair<double, double> getGradientLimits() const;

    protected:
        bool event(QEvent *) override;
        void resizeEvent(QResizeEvent *) override;
        void paintEvent(QPaintEvent *event) override;

    private:
        Q_DECLARE_PRIVATE(Bar)

        QScopedPointer<BarPrivate> const d_ptr;
};

/****************************************************************************/


} // namespace Pd

#endif