sliderWidget.h

/* ********************************************************************
    itom software
    URL: http://www.uni-stuttgart.de/ito
    Copyright (C) 2020, 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 SLIDERWIDGET_H
#define SLIDERWIDGET_H

// Qt includes
#include <QSlider>


#include "commonWidgets.h"

class DoubleSlider;
class PopupWidget;
class SliderWidgetPrivate;
class DoubleSpinBox;
class ValueProxy;

class ITOMWIDGETS_EXPORT SliderWidget : public QWidget
{
  Q_OBJECT
  Q_FLAGS(SynchronizeSiblings)

  
  Q_PROPERTY(int decimals READ decimals WRITE setDecimals NOTIFY decimalsChanged)
  Q_PROPERTY(double singleStep READ singleStep WRITE setSingleStep)
  Q_PROPERTY(double pageStep READ pageStep WRITE setPageStep)
  Q_PROPERTY(double minimum READ minimum WRITE setMinimum)
  Q_PROPERTY(double maximum READ maximum WRITE setMaximum)
  Q_PROPERTY(double value READ value WRITE setValue)
  Q_PROPERTY(QString prefix READ prefix WRITE setPrefix)
  Q_PROPERTY(QString suffix READ suffix WRITE setSuffix)
  Q_PROPERTY(double tickInterval READ tickInterval WRITE setTickInterval)
  Q_PROPERTY(QSlider::TickPosition tickPosition READ tickPosition WRITE setTickPosition)
  Q_PROPERTY(SynchronizeSiblings synchronizeSiblings READ synchronizeSiblings WRITE setSynchronizeSiblings)
  Q_PROPERTY(Qt::Alignment spinBoxAlignment READ spinBoxAlignment WRITE setSpinBoxAlignment)
  Q_PROPERTY(bool tracking READ hasTracking WRITE setTracking)
  Q_PROPERTY(bool spinBoxVisible READ isSpinBoxVisible WRITE setSpinBoxVisible);
  Q_PROPERTY(bool popupSlider READ hasPopupSlider WRITE setPopupSlider);
  Q_PROPERTY(bool invertedAppearance READ invertedAppearance WRITE setInvertedAppearance)
  Q_PROPERTY(bool invertedControls READ invertedControls WRITE setInvertedControls)

public:

  enum SynchronizeSibling
    {
    NoSynchronize = 0x000,
    SynchronizeWidth = 0x001,
    SynchronizeDecimals = 0x002,
    };
  Q_DECLARE_FLAGS(SynchronizeSiblings, SynchronizeSibling)

  
  typedef QWidget Superclass;

  explicit SliderWidget(QWidget* parent = 0);
  virtual ~SliderWidget();

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

  //double sliderPosition()const;
  //void setSliderPosition(double position);

  virtual double value()const;

  virtual double singleStep()const;
  virtual void setSingleStep(double step);

  virtual double pageStep()const;
  virtual void setPageStep(double step);

  virtual int decimals()const;

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

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

  virtual double tickInterval()const;
  virtual void setTickInterval(double tick);

  virtual void setTickPosition(QSlider::TickPosition position);
  virtual QSlider::TickPosition tickPosition()const;
  
  virtual void setSpinBoxAlignment(Qt::Alignment alignment);
  virtual Qt::Alignment spinBoxAlignment()const;

  virtual void setTracking(bool enable);
  virtual bool hasTracking()const;

  virtual SliderWidget::SynchronizeSiblings synchronizeSiblings() const;
  virtual void setSynchronizeSiblings(SliderWidget::SynchronizeSiblings options);

  virtual void setInvertedAppearance(bool invertedAppearance);
  virtual bool invertedAppearance()const;

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

  virtual bool isSpinBoxVisible()const;

  virtual bool hasPopupSlider()const;
  virtual void setPopupSlider(bool popup);

  virtual PopupWidget* popup()const;

  virtual DoubleSpinBox* spinBox();

  virtual DoubleSlider* slider();

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

public Q_SLOTS:
  virtual void reset();
  virtual void setValue(double value);
  virtual void setSpinBoxVisible(bool);

  virtual void setDecimals(int decimals);

Q_SIGNALS:
  void valueChanged(double value);

  void valueIsChanging(double value);

  void decimalsChanged(int decimals);

protected Q_SLOTS:

  virtual void startChanging();
  virtual void stopChanging();
  virtual void setSpinBoxValue(double sliderValue);
  virtual void setSliderValue(double spinBoxValue);
  virtual void onValueProxyAboutToBeModified();
  virtual void onValueProxyModified();

protected:
  virtual bool eventFilter(QObject *obj, QEvent *event);
  
protected:
  QScopedPointer<SliderWidgetPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(SliderWidget);
  Q_DISABLE_COPY(SliderWidget);

};

Q_DECLARE_OPERATORS_FOR_FLAGS(SliderWidget::SynchronizeSiblings);

#endif