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)

public:
  typedef QTreeView Superclass;
  qMRMLSubjectHierarchyTreeView(QWidget *parent=0);
  virtual ~qMRMLSubjectHierarchyTreeView();

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);

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

  bool multiSelection();

  Q_INVOKABLE void setAttributeFilter(const QString& attributeName, const QVariant& attributeValue=QVariant());
  Q_INVOKABLE void removeAttributeFilter();

  Q_INVOKABLE void setLevelFilter(QString &levelFilter);
  Q_INVOKABLE void setNameFilter(QString &nameFilter);
  Q_INVOKABLE void setNodeTypes(const QStringList& types);
  Q_INVOKABLE void setHideChildNodeTypes(const QStringList& types);

  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;

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 setPluginWhitelist(QStringList whitelist);
  void setPluginBlacklist(QStringList blacklist);
  void disablePlugin(QString plugin);

  bool showContextMenuHint(bool visibility=false);

  void setHighlightReferencedItems(bool highlightOn);
  void setContextMenuEnabled(bool enabled);
  void setEditMenuActionVisible(bool visible);
  void setSelectRoleSubMenuVisible(bool visible);

signals:
  void currentItemChanged(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 onMRMLSceneCloseEnded(vtkObject* sceneObject);
  virtual void onMRMLSceneStartBatchProcess(vtkObject* sceneObject);
  virtual void onMRMLSceneEndBatchProcess(vtkObject* sceneObject);

protected:
  virtual void setSubjectHierarchyNode(vtkMRMLSubjectHierarchyNode* shNode);

  void toggleSubjectHierarchyItemVisibility(vtkIdType itemID);

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

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

  void applyReferenceHighlightForItems(QList<vtkIdType> itemIDs);

  vtkIdType firstSelectedSubjectHierarchyItemInBranch(vtkIdType itemID);

protected:
  QScopedPointer<qMRMLSubjectHierarchyTreeViewPrivate> d_ptr;

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

#endif