rangeSlider.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 RANGESLIDER_H
#define RANGESLIDER_H

#include <QSlider>

#include "commonWidgets.h"


class QStylePainter;
class RangeSliderPrivate;

namespace ito {
    class IntervalMeta; //forward declaration
}

class ITOMWIDGETS_EXPORT RangeSlider : public QSlider
{
  Q_OBJECT
  Q_PROPERTY(int minimumValue READ minimumValue WRITE setMinimumValue)
  Q_PROPERTY(int maximumValue READ maximumValue WRITE setMaximumValue)
  Q_PROPERTY(int minimumPosition READ minimumPosition WRITE setMinimumPosition)
  Q_PROPERTY(int maximumPosition READ maximumPosition WRITE setMaximumPosition)
  Q_PROPERTY(uint stepSizePosition READ stepSizePosition WRITE setStepSizePosition)
  Q_PROPERTY(uint minimumRange READ minimumRange WRITE setMinimumRange)
  Q_PROPERTY(uint maximumRange READ maximumRange WRITE setMaximumRange)
  Q_PROPERTY(uint stepSizeRange READ stepSizeRange WRITE setStepSizeRange)
  Q_PROPERTY(bool rangeIncludeLimits READ rangeIncludeLimits WRITE setRangeIncludeLimits)
  Q_PROPERTY(bool symmetricMoves READ symmetricMoves WRITE setSymmetricMoves)
  Q_PROPERTY(QString handleToolTip READ handleToolTip WRITE setHandleToolTip)
  Q_PROPERTY(bool useStyleSheets READ useStyleSheets WRITE setUseStyleSheets) // special property to allow a basic support for style sheets (else one handle is not displayed among others)
  Q_PROPERTY(float handleBorderRadius READ handleBorderRadius WRITE setHandleBorderRadius) // special property to indicate the border radius of the handles (only if useStyleSheets is true) 

public:
  // Superclass typedef
  typedef QSlider Superclass;
  explicit RangeSlider( Qt::Orientation o, QWidget* par= 0 );
  explicit RangeSlider( QWidget* par = 0 );
  virtual ~RangeSlider();

  int minimumValue() const;

  int maximumValue() const;

  int minimumPosition() const;
  void setMinimumPosition(int min);

  int maximumPosition() const;
  void setMaximumPosition(int max);

  uint stepSizePosition() const;
  void setStepSizePosition(uint stepSize);
  
  uint minimumRange() const;
  void setMinimumRange(uint min);
  
  uint maximumRange() const;
  void setMaximumRange(uint max);
  
  uint stepSizeRange() const;
  void setStepSizeRange(uint stepSize);
  
  bool rangeIncludeLimits() const;
  void setRangeIncludeLimits(bool include);

  void setPositions(int min, int max);
  
  bool symmetricMoves()const; 
  void setSymmetricMoves(bool symmetry);

  bool useStyleSheets()const;
  void setUseStyleSheets(bool useStyleSheets);

  float handleBorderRadius()const;
  void setHandleBorderRadius(float radius);
  
  QString handleToolTip()const;
  void setHandleToolTip(const QString& toolTip);

  bool isMinimumSliderDown()const;
  bool isMaximumSliderDown()const;

  void setLimitsFromIntervalMeta(const ito::IntervalMeta &intervalMeta);

signals:
  void minimumValueChanged(int min);
  void maximumValueChanged(int max);
  void valuesChanged(int min, int max);

  void minimumPositionChanged(int min);

  void maximumPositionChanged(int max);

  void positionsChanged(int min, int max);

public slots:
  void setMinimumValue(int min);

  void setMaximumValue(int max);

  void setValues(int min, int max);

protected slots:
  void onRangeChanged(int minimum, int maximum);

protected:
  RangeSlider( RangeSliderPrivate* impl, Qt::Orientation o, QWidget* par= 0 );
  RangeSlider( RangeSliderPrivate* impl, QWidget* par = 0 );

  // Description:
  // Standard Qt UI events
  virtual void mousePressEvent(QMouseEvent* ev);
  virtual void mouseMoveEvent(QMouseEvent* ev);
  virtual void mouseReleaseEvent(QMouseEvent* ev);

  virtual void keyPressEvent(QKeyEvent* ev);

  // Description:
  // Rendering is done here.
  virtual void paintEvent(QPaintEvent* ev);
  virtual void initMinimumSliderStyleOption(QStyleOptionSlider* option) const;
  virtual void initMaximumSliderStyleOption(QStyleOptionSlider* option) const;

  // Description:
  // Reimplemented for the tooltips
  virtual bool event(QEvent* event);

protected:
  QScopedPointer<RangeSliderPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(RangeSlider);
  Q_DISABLE_COPY(RangeSlider);
};

#endif