qMRMLSceneAnnotationModel.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 Julien Finet, Kitware Inc.
  and was partially funded by NIH grant 3P41RR013218-12S1

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

#ifndef __qMRMLSceneAnnotationModel_h
#define __qMRMLSceneAnnotationModel_h

// qMRML includes
#include "qMRMLSceneDisplayableModel.h"

// Annotations includes
#include "qSlicerAnnotationsModuleWidgetsExport.h"
class qMRMLSceneAnnotationModelPrivate;

// Logic includes
class vtkSlicerAnnotationModuleLogic;

// MRML includes
class vtkMRMLNode;

class Q_SLICER_MODULE_ANNOTATIONS_WIDGETS_EXPORT qMRMLSceneAnnotationModel
  : public qMRMLSceneDisplayableModel
{
  Q_OBJECT
  Q_PROPERTY(bool annotationsAreParent READ areAnnotationsParent WRITE setAnnotationsAreParent)

  
  Q_PROPERTY (int lockColumn READ lockColumn WRITE setLockColumn)
  Q_PROPERTY (int editColumn READ editColumn WRITE setEditColumn)
  Q_PROPERTY (int valueColumn READ valueColumn WRITE setValueColumn)
  Q_PROPERTY (int textColumn READ textColumn WRITE setTextColumn)

public:
  typedef qMRMLSceneDisplayableModel Superclass;
  qMRMLSceneAnnotationModel(QObject *parent=nullptr);
  ~qMRMLSceneAnnotationModel() override;

  // Register the logic
  void setLogic(vtkSlicerAnnotationModuleLogic* logic);

  bool areAnnotationsParent()const;
  void setAnnotationsAreParent(bool parentable);

  int lockColumn()const;
  void setLockColumn(int column);

  int editColumn()const;
  void setEditColumn(int column);

  int valueColumn()const;
  void setValueColumn(int column);

  int textColumn()const;
  void setTextColumn(int column);

  virtual vtkMRMLNode* activeHierarchyNode(vtkMRMLNode* mrmlNode)const;
  vtkMRMLNode* parentNode(vtkMRMLNode* node)const override;
  bool canBeAParent(vtkMRMLNode* node)const override;

protected:
  qMRMLSceneAnnotationModel(qMRMLSceneAnnotationModelPrivate* pimpl,
                             QObject *parent=nullptr);

  void updateItemDataFromNode(QStandardItem* item, vtkMRMLNode* node, int column) override;

  void updateNodeFromItemData(vtkMRMLNode* node, QStandardItem* item) override;

  QFlags<Qt::ItemFlag> nodeFlags(vtkMRMLNode* node, int column)const override;
  int maxColumnId()const override;

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

#endif