doubleSpinBox.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2016, Institut fuer Technische Optik (ITO),
    Universitaet Stuttgart, Germany

    This file is part of itom and its software development toolkit (SDK).

    itom is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public Licence as published by
    the Free Software Foundation; either version 2 of the Licence, or (at
    your option) any later version.
   
    In addition, as a special exception, the Institut fuer Technische
    Optik (ITO) gives you certain additional rights.
    These rights are described in the ITO LGPL Exception version 1.0,
    which can be found in the file LGPL_EXCEPTION.txt in this package.

    itom 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 Licence for more details.

    You should have received a copy of the GNU Library General Public License
    along with itom. If not, see <http://www.gnu.org/licenses/>.

    This file is a port and modified version of the 
    Common framework (http://www.commontk.org)
*********************************************************************** */

#ifndef DOUBLESPINBOX_H
#define DOUBLESPINBOX_H

// Qt includes
#include <QMetaType>
#include <QString>
#include <QWidget>

class QDoubleSpinBox;
class QEvent;
class QKeyEvent;
class QLineEdit;
class QObject;

#include "commonWidgets.h"

class DoubleSpinBoxPrivate;
class ValueProxy;

class ITOMWIDGETS_EXPORT DoubleSpinBox : public QWidget
{
  Q_OBJECT

#if QT_VERSION < 0x050500
  //for >= Qt 5.5.0 see Q_ENUM definition below
  Q_ENUMS(SetMode)
  Q_ENUMS(SizeHintPolicy)
  Q_FLAGS(DecimalsOption DecimalsOptions)
#endif

  Q_PROPERTY(Qt::Alignment alignment READ alignment WRITE setAlignment)
  Q_PROPERTY(bool frame READ hasFrame WRITE setFrame)
  Q_PROPERTY(QString prefix READ prefix WRITE setPrefix)
  Q_PROPERTY(QString suffix READ suffix WRITE setSuffix)
  Q_PROPERTY(QString cleanText READ cleanText)
  Q_PROPERTY(int decimals READ decimals WRITE setDecimals NOTIFY decimalsChanged)
  Q_PROPERTY(DecimalsOptions decimalsOption READ decimalsOption WRITE setDecimalsOption)
  Q_PROPERTY(double minimum READ minimum WRITE setMinimum)
  Q_PROPERTY(double maximum READ maximum WRITE setMaximum)
  Q_PROPERTY(double singleStep READ singleStep WRITE setSingleStep)
  Q_PROPERTY(double value READ value WRITE setValue NOTIFY valueChanged USER true)
  Q_PROPERTY(SetMode setMode READ setMode WRITE setSetMode)
  Q_PROPERTY(bool invertedControls READ invertedControls WRITE setInvertedControls)
  Q_PROPERTY(SizeHintPolicy sizeHintPolicy READ sizeHintPolicy WRITE setSizeHintPolicy)
  Q_PROPERTY(bool keyboardTracking READ keyboardTracking WRITE setKeyboardTracking)

public:

  enum SetMode
    {
    SetAlways,
    SetIfDifferent,
    };

  enum DecimalsOption
    {
    FixedDecimals = 0x000,
    DecimalsByShortcuts = 0x001,
    DecimalsByKey = 0x002,
    DecimalsByValue = 0x004,
    InsertDecimals = 0x008,
    ReplaceDecimals = 0x010,
    DecimalsAsMax = 0x020,
    DecimalsAsMin = 0x040,
    DecimalPointAlwaysVisible = 0x080
    };
  Q_DECLARE_FLAGS(DecimalsOptions, DecimalsOption)

  enum SizeHintPolicy
    {
    SizeHintByMinMax,
    SizeHintByValue
    };

#if QT_VERSION >= 0x050500
  //Q_ENUM exposes a meta object to the enumeration types, such that the key names for the enumeration
  //values are always accessible.
  Q_ENUM(SetMode)
  Q_ENUM(SizeHintPolicy)
  Q_FLAG(DecimalsOptions)
#endif

  typedef QWidget Superclass;

  explicit DoubleSpinBox(QWidget* parent = 0);
  explicit DoubleSpinBox(DoubleSpinBox::SetMode mode, QWidget* parent = 0);
  virtual ~DoubleSpinBox();

  double value() const;

  double displayedValue() const;

  void setDisplayedValue(double displayValue);

  QString text() const;

  QString cleanText() const;

  Qt::Alignment alignment () const;
  void setAlignment (Qt::Alignment flag);

  void setFrame(bool frame);
  bool hasFrame() const;

  QString prefix() const;
  void setPrefix(const QString &prefix);

  QString suffix() const;
  void setSuffix(const QString &suffix);

  double singleStep() const;
  void setSingleStep(double value);

  double minimum() const;
  void setMinimum(double min);
  double maximum() const;
  void setMaximum(double max);
  void setRange(double min, double max);

  int decimals() const;

  double round(double value) const;

  QDoubleSpinBox* spinBox() const;

  QLineEdit* lineEdit()const;

  DoubleSpinBox::SetMode setMode() const;
  void setSetMode(SetMode mode);

  DoubleSpinBox::DecimalsOptions decimalsOption();
  void setDecimalsOption(DoubleSpinBox::DecimalsOptions option);

  void setInvertedControls(bool invertedControls);
  bool invertedControls() const;

  void setSizeHintPolicy(SizeHintPolicy newSizeHintPolicy);
  SizeHintPolicy sizeHintPolicy()const;

  void setValueProxy(ValueProxy* proxy);
  ValueProxy* valueProxy() const;

  virtual QSize sizeHint()const;
  virtual QSize minimumSizeHint()const;

  void setKeyboardTracking(bool kt);
  bool keyboardTracking() const;

public slots:
  void setValue(double value);

  void setValueIfDifferent(double value);

  void setValueAlways(double value);

  void stepUp();
  void stepDown();

  void setDecimals(int decimal);

signals:
  void valueChanged(double);
  void valueChanged(const QString &);

  void editingFinished();

  void decimalsChanged(int);

protected:
  DoubleSpinBoxPrivate* const d_ptr;

  virtual void keyPressEvent(QKeyEvent* event);
  virtual bool eventFilter(QObject *obj, QEvent *event);

  friend class CoordinatesWidgetPrivate;
private:
  Q_DECLARE_PRIVATE(DoubleSpinBox);
  Q_DISABLE_COPY(DoubleSpinBox);
};

Q_DECLARE_METATYPE(DoubleSpinBox::SetMode)
Q_DECLARE_OPERATORS_FOR_FLAGS(DoubleSpinBox::DecimalsOptions)

#endif //__DoubleSpinBox_h