qMRMLSpinBox.h

Go to the documentation of this file.

/*==============================================================================

  Program: 3D Slicer

  Copyright (c) Kitware Inc.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Johan Andruejol, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

==============================================================================*/

#ifndef __qMRMLSpinBox_h
#define __qMRMLSpinBox_h

// CTK includes
#include <ctkDoubleSpinBox.h>
#include <ctkVTKObject.h>

// qMRML includes
#include <qMRMLWidgetsExport.h>

// VTK includes
class vtkMRMLNode;
class vtkMRMLScene;

// qMRMLSpinBox includes
class qMRMLSpinBoxPrivate;

class QMRML_WIDGETS_EXPORT qMRMLSpinBox : public ctkDoubleSpinBox
{
  Q_OBJECT
  QVTK_OBJECT

  // \sa setQuantity(), quantity()
  // \sa setUnitAwareProperties(), unitAwareProperties()
  Q_PROPERTY(QString quantity READ quantity WRITE setQuantity)

  
  // \sa setUnitAwareProperties(), unitAwareProperties()
  Q_FLAGS(UnitAwareProperty UnitAwareProperties)
  Q_PROPERTY(UnitAwareProperties unitAwareProperties READ unitAwareProperties WRITE setUnitAwareProperties)

public:
  typedef ctkDoubleSpinBox Superclass;

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

  enum UnitAwareProperty
    {
    None = 0x00,
    Prefix = 0x01,
    Suffix = 0x02,
    Precision = 0x04,
    MinimumValue = 0x08,
    MaximumValue = 0x10,
    Scaling = 0x20,
    };
  Q_DECLARE_FLAGS(UnitAwareProperties, UnitAwareProperty)

  
  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;

  QString quantity()const;

  UnitAwareProperties unitAwareProperties()const;

public slots:
  void setQuantity(const QString& baseName);

  virtual void setMRMLScene(vtkMRMLScene* scene);

  void setUnitAwareProperties(UnitAwareProperties flags);

protected slots:
  void updateWidgetFromUnitNode();

protected:
  QScopedPointer<qMRMLSpinBoxPrivate> d_ptr;

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

Q_DECLARE_OPERATORS_FOR_FLAGS(qMRMLSpinBox::UnitAwareProperties)

#endif