qMRMLSubjectHierarchyTreeView.h

Go to the documentation of this file.

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

  Program: 3D Slicer

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.

  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 Csaba Pinter, PerkLab, Queen's University
  and was supported through the Applied Cancer Research Unit program of Cancer Care
  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care

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

#ifndef __qMRMLSubjectHierarchyTreeView_h
#define __qMRMLSubjectHierarchyTreeView_h

// Qt includes
#include <QTreeView>

// CTK includes
#include <ctkVTKObject.h>

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

class qMRMLSubjectHierarchyTreeViewPrivate;
class qMRMLSortFilterSubjectHierarchyProxyModel;
class qMRMLSubjectHierarchyModel;
class vtkMRMLNode;
class vtkMRMLScene;
class vtkMRMLSubjectHierarchyNode;
class vtkIdList;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qMRMLSubjectHierarchyTreeView : public QTreeView
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY(bool showRootItem READ showRootItem WRITE setShowRootItem)
  Q_PROPERTY(bool highlightReferencedItems READ highlightReferencedItems WRITE setHighlightReferencedItems)
  Q_PROPERTY(bool contextMenuEnabled READ contextMenuEnabled WRITE setContextMenuEnabled)
  Q_PROPERTY(bool editMenuActionVisible READ editMenuActionVisible WRITE setEditMenuActionVisible)
  Q_PROPERTY(bool selectRoleSubMenuVisible READ selectRoleSubMenuVisible WRITE setSelectRoleSubMenuVisible)
  Q_PROPERTY(bool multiSelection READ multiSelection WRITE setMultiSelection)
  Q_PROPERTY(QStringList levelFilter READ levelFilter WRITE setLevelFilter)
  Q_PROPERTY(QString nameFilter READ nameFilter WRITE setNameFilter)
  Q_PROPERTY(QStringList nodeTypes READ nodeTypes WRITE setNodeTypes)
  Q_PROPERTY(QStringList hideChildNodeTypes READ hideChildNodeTypes WRITE setHideChildNodeTypes)
  Q_PROPERTY(bool visibilityColumnVisible READ visibilityColumnVisible WRITE setVisibilityColumnVisible)
  Q_PROPERTY(bool idColumnVisible READ idColumnVisible WRITE setIdColumnVisible)
  Q_PROPERTY(bool colorColumnVisible READ colorColumnVisible WRITE setColorColumnVisible)
  Q_PROPERTY(bool transformColumnVisible READ transformColumnVisible WRITE setTransformColumnVisible)
  Q_PROPERTY(bool descriptionColumnVisible READ descriptionColumnVisible WRITE setDescriptionColumnVisible)

  Q_PROPERTY(bool noneEnabled READ noneEnabled WRITE setNoneEnabled)
  Q_PROPERTY(QString noneDisplay READ noneDisplay WRITE setNoneDisplay)

  Q_PROPERTY(QStringList includeItemAttributeNamesFilter READ includeItemAttributeNamesFilter WRITE setIncludeItemAttributeNamesFilter)
  Q_PROPERTY(QStringList includeNodeAttributeNamesFilter READ includeNodeAttributeNamesFilter WRITE setIncludeNodeAttributeNamesFilter)
  Q_PROPERTY(QStringList excludeItemAttributeNamesFilter READ excludeItemAttributeNamesFilter WRITE setExcludeItemAttributeNamesFilter)
  Q_PROPERTY(QStringList excludeNodeAttributeNamesFilter READ excludeNodeAttributeNamesFilter WRITE setExcludeNodeAttributeNamesFilter)

  Q_PROPERTY(QString attributeNameFilter READ attributeNameFilter WRITE setAttributeNameFilter)
  Q_PROPERTY(QString attributeValueFilter READ attributeValueFilter WRITE setAttributeValueFilter)

public:
  typedef QTreeView Superclass;
  qMRMLSubjectHierarchyTreeView(QWidget *parent=nullptr);
  ~qMRMLSubjectHierarchyTreeView() override;

public:
  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;
  Q_INVOKABLE vtkMRMLSubjectHierarchyNode* subjectHierarchyNode()const;

  Q_INVOKABLE vtkIdType currentItem()const;
  QList<vtkIdType> currentItems();
  Q_INVOKABLE void currentItems(vtkIdList* selectedItems);

  virtual vtkMRMLNode* currentNode()const;

  Q_INVOKABLE vtkIdType rootItem()const;
  bool showRootItem()const;

  bool multiSelection();

  QStringList includeItemAttributeNamesFilter()const;
  QStringList includeNodeAttributeNamesFilter()const;
  QStringList excludeItemAttributeNamesFilter()const;
  QStringList excludeNodeAttributeNamesFilter()const;
  QString attributeValueFilter()const;
  QString attributeNameFilter()const;
  Q_INVOKABLE void setAttributeFilter(const QString& attributeName, const QVariant& attributeValue=QVariant());
  Q_INVOKABLE void removeAttributeFilter();
  Q_INVOKABLE void addItemAttributeFilter(QString attributeName, QVariant attributeValue=QString(), bool include=true);
  Q_INVOKABLE void removeItemAttributeFilter(QString attributeName, QVariant attributeValue, bool include);
  Q_INVOKABLE void removeItemAttributeFilter(QString attributeName, bool include);
  Q_INVOKABLE void addNodeAttributeFilter(QString attributeName, QVariant attributeValue=QString(), bool include=true, QString className=QString());
  Q_INVOKABLE void removeNodeAttributeFilter(QString attributeName, QVariant attributeValue, bool include, QString className);
  Q_INVOKABLE void removeNodeAttributeFilter(QString attributeName, bool include);


  void setLevelFilter(QStringList &levelFilter);
  QStringList levelFilter()const;

  void setNameFilter(QString &nameFilter);
  QString nameFilter()const;

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

  void setHideChildNodeTypes(const QStringList& types);
  QStringList hideChildNodeTypes()const;

  Q_INVOKABLE qMRMLSortFilterSubjectHierarchyProxyModel* sortFilterProxyModel()const;
  Q_INVOKABLE qMRMLSubjectHierarchyModel* model()const;

  Q_INVOKABLE int displayedItemCount()const;

  bool highlightReferencedItems()const;
  bool contextMenuEnabled()const;
  bool editMenuActionVisible()const;
  bool selectRoleSubMenuVisible()const;
  bool noneEnabled()const;
  QString noneDisplay()const;

  void setVisibilityColumnVisible(bool visible);
  bool visibilityColumnVisible();
  void setIdColumnVisible(bool visible);
  bool idColumnVisible();
  void setColorColumnVisible(bool visible);
  bool colorColumnVisible();
  void setTransformColumnVisible(bool visible);
  bool transformColumnVisible();
  void setDescriptionColumnVisible(bool visible);
  bool descriptionColumnVisible();

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

  virtual void setCurrentItem(vtkIdType itemID);
  virtual void setCurrentItems(QList<vtkIdType> items);
  virtual void setCurrentItems(vtkIdList* items);
  virtual void setCurrentNode(vtkMRMLNode* node);

  virtual void setRootItem(vtkIdType itemID);
  void setShowRootItem(bool show);

  void renameCurrentItem();
  void deleteSelectedItems();
  void toggleVisibilityOfSelectedItems();
  virtual void editCurrentItem();

  virtual void expandItem(vtkIdType itemID);
  virtual void collapseItem(vtkIdType itemID);

  virtual void selectPluginForCurrentItem();

  virtual void updateSelectPluginActions();

  virtual void setMultiSelection(bool multiSelectionOn);

  void setPluginAllowlist(QStringList allowlist);
  void setPluginBlocklist(QStringList blocklist);
  void disablePlugin(QString plugin);

  void setPluginWhitelist(QStringList allowlist)
    {
    qWarning("qMRMLSubjectHierarchyTreeView::setPluginWhitelist is deprecated. Use setPluginAllowlist instead.");
    this->setPluginAllowlist(allowlist);
    }
  void setPluginBlacklist(QStringList blocklist)
    {
    qWarning("qMRMLSubjectHierarchyTreeView::setPluginBlacklist is deprecated. Use setPluginBlocklist instead.");
    this->setPluginBlocklist(blocklist);
    }

  bool showContextMenuHint(bool visibility=false);

  void setHighlightReferencedItems(bool highlightOn);
  void setContextMenuEnabled(bool enabled);
  void setEditMenuActionVisible(bool visible);
  void setSelectRoleSubMenuVisible(bool visible);
  void setNoneEnabled(bool enable);
  void setNoneDisplay(const QString& displayName);

  void resetColumnSizesToDefault();

  void setIncludeItemAttributeNamesFilter(QStringList filter);
  void setIncludeNodeAttributeNamesFilter(QStringList filter);
  void setExcludeItemAttributeNamesFilter(QStringList filter);
  void setExcludeNodeAttributeNamesFilter(QStringList filter);
  void setAttributeNameFilter(QString& filter);
  void setAttributeValueFilter(QString& filter);

signals:
  void currentItemChanged(vtkIdType);
  void currentItemsChanged(QList<vtkIdType>);
  void currentItemModified(vtkIdType);

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

  virtual void onItemExpanded(const QModelIndex &expandedItemIndex);
  virtual void onItemCollapsed(const QModelIndex &collapsedItemIndex);

  virtual void expandToDepthFromContextMenu();

  virtual void updateRootItem();

  virtual void onSubjectHierarchyItemModified(vtkObject *caller, void *callData);
  virtual void onSubjectHierarchyItemTransformModified(vtkObject *caller, void *callData);

  virtual void onMRMLSceneStartClose(vtkObject* sceneObject);
  virtual void onMRMLSceneEndClose(vtkObject* sceneObject);
  virtual void onMRMLSceneStartBatchProcess(vtkObject* sceneObject);
  virtual void onMRMLSceneEndBatchProcess(vtkObject* sceneObject);

  void onCustomContextMenu(const QPoint& point);

  virtual void onTransformActionSelected();
  virtual void onTransformInteractionInViewToggled(bool show);
  virtual void onTransformEditProperties();
  virtual void onCreateNewTransform();

protected:
  virtual void setSubjectHierarchyNode(vtkMRMLSubjectHierarchyNode* shNode);

  void toggleSubjectHierarchyItemVisibility(vtkIdType itemID);

  virtual void populateContextMenuForItem(vtkIdType itemID);
  virtual void populateVisibilityContextMenuForItem(vtkIdType itemID);
  virtual void populateTransformContextMenuForItem(vtkIdType itemID);

  virtual bool clickDecoration(QMouseEvent* e);
  void mousePressEvent(QMouseEvent* e) override;
  void keyPressEvent(QKeyEvent* e) override;

  void applyReferenceHighlightForItems(QList<vtkIdType> itemIDs);

  vtkIdType firstSelectedSubjectHierarchyItemInBranch(vtkIdType itemID);

  void changeEvent(QEvent* e) override;

protected:
  QScopedPointer<qMRMLSubjectHierarchyTreeViewPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qMRMLSubjectHierarchyTreeView);
  Q_DISABLE_COPY(qMRMLSubjectHierarchyTreeView);
  friend class qMRMLSubjectHierarchyComboBox;
};

#endif