spinbox.h

Go to the documentation of this file.

/*
 *  spinbox.h  -  spin box with shift-click step value and read-only option
 *  Program:  kalarm
 *  Copyright © 2002-2008 by David Jarvie <djarvie@kde.org>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, 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 SPINBOX_H
#define SPINBOX_H

#include <QSpinBox>
class QEvent;
class QStyleOptionSpinBox;


class SpinBox : public QSpinBox
{
        Q_OBJECT
    public:
        explicit SpinBox(QWidget* parent = 0);
        SpinBox(int minValue, int maxValue, QWidget* parent = 0);
        bool         isReadOnly() const                    { return mReadOnly; }
        virtual void setReadOnly(bool readOnly);
        bool         selectOnStep() const                  { return mSelectOnStep; }
        void         setSelectOnStep(bool sel)             { mSelectOnStep = sel; }
        void         addValue(int change)                  { addValue(change, false); }
        int          minimum() const                       { return mMinValue; }
        int          maximum() const                       { return mMaxValue; }
        void         setMinimum(int val);
        void         setMaximum(int val);
        void         setRange(int minValue, int maxValue)  { setMinimum(minValue);  setMaximum(maxValue); }
        int          bound(int val) const;
        virtual void stepBy(int steps);
        int          singleStep() const                    { return mLineStep; }
        void         setSingleStep(int step);
        int          singleShiftStep() const               { return mLineShiftStep; }
        void         setSingleShiftStep(int step);
        QRect        upRect() const;
        QRect        downRect() const;
        QRect        upDownRect() const;
        void         setUpDownOnly(bool only)              { mUpDownOnly = only; }
        void         initStyleOption(QStyleOptionSpinBox&) const;

    signals:
        void         stepped(int step);

    protected:
        virtual int  shiftStepAdjustment(int oldValue, int shiftStep);
        virtual bool eventFilter(QObject*, QEvent*);

        virtual void paintEvent(QPaintEvent*);
        virtual void focusOutEvent(QFocusEvent*);
        virtual void mousePressEvent(QMouseEvent*);
        virtual void mouseDoubleClickEvent(QMouseEvent*);
        virtual void mouseReleaseEvent(QMouseEvent*);
        virtual void mouseMoveEvent(QMouseEvent*);
        virtual void keyPressEvent(QKeyEvent*); 
        virtual void keyReleaseEvent(QKeyEvent*);
        virtual void wheelEvent(QWheelEvent*);

    private slots:
        void         textEdited();
        void         valueChange();
    private:
        void         init();
        void         addValue(int change, bool current);
        int          whichButton(const QPoint&);
        bool         setShiftStepping(bool, int currentButton);
        bool         clickEvent(QMouseEvent*);
        bool         keyEvent(QKeyEvent*);

        enum { NO_BUTTON, UP, DOWN };

        int          mMinValue;
        int          mMaxValue;
        int          mLineStep;         // step when spin arrows are pressed
        int          mLineShiftStep;    // step when spin arrows are pressed with shift key
        int          mCurrentButton;    // current spin widget button
        bool         mShiftMouse;       // true while left button is being held down with shift key
        bool         mShiftMinBound;    // true if a temporary minimum bound has been set during shift stepping
        bool         mShiftMaxBound;    // true if a temporary maximum bound has been set during shift stepping
        bool         mSelectOnStep;     // select the editor text whenever spin buttons are clicked (default)
        bool         mUpDownOnly;       // true if edit field isn't displayed
        bool         mReadOnly;         // value cannot be changed
        bool         mSuppressSignals;
        bool         mEdited;           // text field has been edited
};

#endif // SPINBOX_H

// vim: et sw=4: