qMRMLTreeView.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 __qMRMLTreeView_h
#define __qMRMLTreeView_h

// Qt includes
#include <QTreeView>
//#include <QStyledItemDelegate>
class QShowEvent;

// CTK includes
#include <ctkVTKObject.h>

// MRMLWidgets includes
#include "qMRMLSceneModel.h"
#include "qMRMLSortFilterProxyModel.h"
#include "qMRMLWidgetsExport.h"

class qMRMLTreeViewPrivate;
class vtkMRMLNode;
class vtkMRMLScene;

class QMRML_WIDGETS_EXPORT qMRMLTreeView : public QTreeView
{
  Q_OBJECT
  QVTK_OBJECT
  Q_PROPERTY(QString sceneModelType READ sceneModelType WRITE setSceneModelType)
  Q_PROPERTY(qMRMLSceneModel::NodeTypes listenNodeModifiedEvent READ listenNodeModifiedEvent WRITE setListenNodeModifiedEvent)
  Q_PROPERTY(QStringList nodeTypes READ nodeTypes WRITE setNodeTypes)
  Q_PROPERTY(bool fitSizeToVisibleIndexes READ fitSizeToVisibleIndexes WRITE setFitSizeToVisibleIndexes)
  Q_PROPERTY(QSize minSizeHint READ minSizeHint WRITE setMinSizeHint)
  Q_PROPERTY(bool renameMenuActionVisible READ isRenameMenuActionVisible WRITE setRenameMenuActionVisible)
  Q_PROPERTY(bool deleteMenuActionVisible READ isDeleteMenuActionVisible WRITE setDeleteMenuActionVisible)
  Q_PROPERTY(bool editMenuActionVisible READ isEditMenuActionVisible WRITE setEditMenuActionVisible)
  Q_PROPERTY(bool showHidden READ showHidden WRITE setShowHidden)
  Q_PROPERTY(bool showScene READ showScene WRITE setShowScene)
  Q_PROPERTY(bool showRootNode READ showRootNode WRITE setShowRootNode)

public:
  typedef QTreeView Superclass;

  qMRMLTreeView(QWidget *parent=nullptr);
  ~qMRMLTreeView() override;

  vtkMRMLScene* mrmlScene()const;

  vtkMRMLNode* currentNode()const;

  QString sceneModelType()const;

  void setListenNodeModifiedEvent(qMRMLSceneModel::NodeTypes listen);
  qMRMLSceneModel::NodeTypes listenNodeModifiedEvent()const;

  void setSceneModel(qMRMLSceneModel* newSceneModel, const QString& modelType);
  void setSortFilterProxyModel(qMRMLSortFilterProxyModel* newFilterModel);

  QStringList nodeTypes()const;
  void setNodeTypes(const QStringList& nodeTypes);

  bool isRenameMenuActionVisible()const;
  void setRenameMenuActionVisible(bool show);

  bool isDeleteMenuActionVisible()const;
  void setDeleteMenuActionVisible(bool show);

  bool isEditMenuActionVisible()const;
  void setEditMenuActionVisible(bool show);

  void appendNodeMenuAction(QAction* action);

  void prependNodeMenuAction(QAction* action);

  void appendSceneMenuAction(QAction* action);

  void prependSceneMenuAction(QAction* action);

  void removeNodeMenuAction(QAction* action);

  inline void setShowHidden(bool);
  inline bool showHidden()const;

  void setShowRootNode(bool show);
  bool showRootNode()const;

  void setShowScene(bool show);
  bool showScene()const;

  vtkMRMLNode* rootNode()const;

  Q_INVOKABLE qMRMLSortFilterProxyModel* sortFilterProxyModel()const;
  Q_INVOKABLE qMRMLSceneModel* sceneModel()const;

  void setFitSizeToVisibleIndexes(bool);
  bool fitSizeToVisibleIndexes()const;

  void setMinSizeHint(QSize min);
  QSize minSizeHint()const;

  static bool isAncestor(const QModelIndex& index, const QModelIndex& potentialAncestor);

  static QModelIndex findAncestor(const QModelIndex& index, const QModelIndexList& potentialAncestors);

  static QModelIndexList removeChildren(const QModelIndexList& indexes);

  QSize minimumSizeHint()const override;
  QSize sizeHint()const override;

  void showEvent(QShowEvent* show) override;
  bool eventFilter(QObject* object, QEvent* e) override;

  virtual bool clickDecoration(const QModelIndex& index);

  using QTreeView::scrollTo;

public slots:
  virtual void setMRMLScene(vtkMRMLScene* scene);

  void setSceneModelType(const QString& modelType);

  void setRootNode(vtkMRMLNode* root);

  void setCurrentNode(vtkMRMLNode* node);
  void deleteCurrentNode();
  void editCurrentNode();
  void renameCurrentNode();

  inline void setShowAll(bool);
  inline void setHideAll(bool);
  inline void setDontHideAll(bool);

  void scrollTo(const QString& displayName);
  void scrollToNext();

signals:
  void currentNodeChanged(vtkMRMLNode* node);
  void currentNodeDeleted(const QModelIndex& index);
  void currentNodeRenamed(const QString& newName);
  void editNodeRequested(vtkMRMLNode* node);
  void decorationClicked(const QModelIndex&);

protected slots:
  virtual void onSelectionChanged(const QItemSelection & selected,
                                  const QItemSelection & deselected);

  void onNumberOfVisibleIndexChanged();

  void updateRootNode(vtkObject* modifiedRootNode);

  void saveTreeExpandState();

  void loadTreeExpandState();

  void onCustomContextMenu(const QPoint& point);

protected:
  qMRMLTreeView(qMRMLTreeViewPrivate* pimpl, QWidget *parent=nullptr);

protected:
  QScopedPointer<qMRMLTreeViewPrivate> d_ptr;

  // reimplemented for performance issues
  void updateGeometries() override;
  void mousePressEvent(QMouseEvent* event) override;
  void mouseReleaseEvent(QMouseEvent* event) override;
  void keyPressEvent(QKeyEvent* event) override;

  virtual void toggleVisibility(const QModelIndex& index);

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

// --------------------------------------------------------------------------
void qMRMLTreeView::setShowHidden(bool enable)
{
  this->sortFilterProxyModel()->setShowHidden(enable);
}

// --------------------------------------------------------------------------
bool qMRMLTreeView::showHidden()const
{
  return this->sortFilterProxyModel()->showHidden();
}

// --------------------------------------------------------------------------
void qMRMLTreeView::setShowAll(bool show)
{
  this->sortFilterProxyModel()->setShowAll(show);
}

// --------------------------------------------------------------------------
void qMRMLTreeView::setHideAll(bool hide)
{
  this->sortFilterProxyModel()->setHideAll(hide);
}
#include <QDebug>
// --------------------------------------------------------------------------
void qMRMLTreeView::setDontHideAll(bool dontHide)
{
  qDebug() << "DontHide: " << dontHide;
  this->setHideAll(!dontHide);
}

#endif