QmitkDataStorageTreeModel.h

Go to the documentation of this file.

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

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center,
Division of Medical and Biological Informatics.
All rights reserved.

This software is distributed WITHOUT ANY WARRANTY; without
even the implied warranty of MERCHANTABILITY or FITNESS FOR
A PARTICULAR PURPOSE.

See LICENSE.txt or http://www.mitk.org for details.

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

#ifndef QMITKDATASTORAGETREEMODEL_H_
#define QMITKDATASTORAGETREEMODEL_H_

#include <MitkQtWidgetsExports.h>

#include <mitkDataStorage.h>
#include <mitkNodePredicateBase.h>
#include <mitkWeakPointer.h>

#include <QAbstractListModel>

#include "QmitkCustomVariants.h"
#include "QmitkEnums.h"

#include <QList>
#include <string>
#include <vector>

class MITKQTWIDGETS_EXPORT QmitkDataStorageTreeModel : public QAbstractItemModel
{
  //# CONSTANTS,TYPEDEFS
public:
  static const std::string COLUMN_NAME;
  static const std::string COLUMN_TYPE;
  static const std::string COLUMN_VISIBILITY;

  //# CTORS,DTOR
public:
  QmitkDataStorageTreeModel(mitk::DataStorage *_DataStorage, bool _PlaceNewNodesOnTop = false, QObject *parent = 0);
  ~QmitkDataStorageTreeModel();

  //# GETTER
public:
  mitk::DataNode::Pointer GetNode(const QModelIndex &index) const;
  virtual QList<mitk::DataNode::Pointer> GetNodeSet() const;
  const mitk::DataStorage::Pointer GetDataStorage() const;

  bool GetPlaceNewNodesOnTopFlag() { return m_PlaceNewNodesOnTop; }
  void SetPlaceNewNodesOnTop(bool _PlaceNewNodesOnTop);

  //# (Re-)implemented from QAbstractItemModel
  //# Read model
  Qt::ItemFlags flags(const QModelIndex &index) const override;
  QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override;
  QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;
  int rowCount(const QModelIndex &parent = QModelIndex()) const override;
  int columnCount(const QModelIndex &parent = QModelIndex()) const override;
  //# hierarchical model
  QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const override;
  QModelIndex parent(const QModelIndex &index) const override;
  //# editable model
  bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) override;
  bool setHeaderData(int section, Qt::Orientation orientation, const QVariant &value, int role = Qt::EditRole) override;
  bool dropMimeData(
    const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) override;
  Qt::DropActions supportedDropActions() const override;
  Qt::DropActions supportedDragActions() const override;
  QStringList mimeTypes() const override;
  QMimeData *mimeData(const QModelIndexList &indexes) const override;

  static QMimeData *mimeDataFromModelIndexList(const QModelIndexList &indexes);

  //# End of QAbstractItemModel

  //# SETTER
public:
  void SetDataStorage(mitk::DataStorage *_DataStorage);
  void SetDataStorageDeleted(const itk::Object *_DataStorage);
  virtual void AddNode(const mitk::DataNode *node);
  virtual void RemoveNode(const mitk::DataNode *node);
  virtual void SetNodeModified(const mitk::DataNode *node);

  QModelIndex GetIndex(const mitk::DataNode *) const;

  void SetAllowHierarchyChange(bool allowHierarchyChange);

  //# MISC
protected:
  class TreeItem
  {
  public:
    TreeItem(mitk::DataNode *_DataNode, TreeItem *_Parent = 0);
    virtual ~TreeItem();
    int IndexOfChild(const TreeItem *item) const;
    TreeItem *GetChild(int index) const;
    TreeItem *Find(const mitk::DataNode *_DataNode) const;
    int GetChildCount() const;
    int GetIndex() const;
    TreeItem *GetParent() const;
    mitk::DataNode::Pointer GetDataNode() const;
    std::vector<TreeItem *> GetChildren() const;

    void AddChild(TreeItem *item);
    void RemoveChild(TreeItem *item);
    void InsertChild(TreeItem *item, int index = -1);
    void SetParent(TreeItem *_Parent);
    void Delete();

  protected:
    TreeItem *m_Parent;
    std::vector<TreeItem *> m_Children;
    mitk::DataNode::Pointer m_DataNode;
  };

  QList<TreeItem *> ToTreeItemPtrList(const QMimeData *mimeData);
  QList<TreeItem *> ToTreeItemPtrList(const QByteArray &ba);

  void AdjustLayerProperty();
  TreeItem *TreeItemFromIndex(const QModelIndex &index) const;
  QModelIndex IndexFromTreeItem(TreeItem *) const;
  mitk::DataNode *GetParentNode(const mitk::DataNode *node) const;
  void TreeToVector(TreeItem *parent, std::vector<TreeItem *> &vec) const;
  void TreeToNodeSet(TreeItem *parent, QList<mitk::DataNode::Pointer> &vec) const;
  void Update();

  //# ATTRIBUTES
protected:
  mitk::WeakPointer<mitk::DataStorage> m_DataStorage;
  mitk::NodePredicateBase::Pointer m_Predicate;
  bool m_PlaceNewNodesOnTop;
  TreeItem *m_Root;

  bool m_BlockDataStorageEvents;

  bool m_AllowHierarchyChange;

private:
  void AddNodeInternal(const mitk::DataNode *);
  void RemoveNodeInternal(const mitk::DataNode *);
  bool DicomPropertiesExists(const mitk::DataNode &) const;
};

#endif /* QMITKDATASTORAGETREEMODEL_H_ */