Scale.h

Go to the documentation of this file.

/*****************************************************************************
 *
 * Copyright (C) 2009  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_SCALE_H
#define PD_SCALE_H

#include <QRect>
#include <QWidget>

namespace Pd {

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

class Scale
{
    public:
                enum Orientation {
            Vertical, 
            Horizontal 
        };

        Scale(QWidget *, Orientation = Vertical);

        Orientation getOrientation() const;
        void setOrientation(Orientation);
        double getMin() const;
        void setMin(double);
        double getMax() const;
        void setMax(double);
        int getLength() const;
        void setLength(int);
        const QString &getSuffix() const;
        void setSuffix(const QString&);
        void resetSuffix();

        void update();

        double range() const;
        int getOuterLength() const;

        void draw(QPainter &, const QRect &, const QColor &, int = 0) const;

    private:
        const QWidget * const parent; 
        Orientation orientation; 
        double min; 
        double max; 
        int length; 
        QString suffix; 
        int outerLength; 
        double majorStep; 
        unsigned int minorDiv; 
        int decade; 
        Scale();
        QString formatValue(double) const;
};

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

inline Scale::Orientation Scale::getOrientation() const
{
    return orientation;
}

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

inline double Scale::getMin() const
{
    return min;
}

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

inline double Scale::getMax() const
{
    return max;
}

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

inline int Scale::getLength() const
{
    return length;
}

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

inline const QString &Scale::getSuffix() const
{
    return suffix;
}

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

inline double Scale::range() const
{
    return max - min;
}

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

inline int Scale::getOuterLength() const
{
    return outerLength;
}

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

} // namespace Pd

#endif