qSlicerSubjectHierarchyAbstractPlugin.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 __qSlicerSubjectHierarchyAbstractPlugin_h
#define __qSlicerSubjectHierarchyAbstractPlugin_h

// Qt includes
#include <QObject>
#include <QMap>
#include <QStringList>
#include <QIcon>
#include <QVariant>

// MRML includes
#include <vtkMRMLSubjectHierarchyNode.h>

#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

class QStandardItem;
class QAction;
class QColor;
class qSlicerAbstractModuleWidget;
class vtkMRMLAbstractViewNode;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyAbstractPlugin : public QObject
{
  Q_OBJECT

  Q_PROPERTY(QString name READ name WRITE setName)

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

// Role-related virtual methods
// If the subclass plugin does not offer a role, these do not need to be overridden
public:
  Q_INVOKABLE virtual double canOwnSubjectHierarchyItem(vtkIdType itemID)const;

  Q_INVOKABLE virtual const QString roleForPlugin()const;

  virtual const QString helpText()const;

  virtual QIcon icon(vtkIdType itemID);

  Q_INVOKABLE virtual QIcon visibilityIcon(int visible);

  Q_INVOKABLE virtual void editProperties(vtkIdType itemID);

  virtual QString displayedItemName(vtkIdType itemID)const;

  Q_INVOKABLE virtual QString tooltip(vtkIdType itemID)const;

  Q_INVOKABLE virtual void setDisplayVisibility(vtkIdType itemID, int visible);

  Q_INVOKABLE virtual int getDisplayVisibility(vtkIdType itemID)const;

  Q_INVOKABLE virtual void setDisplayColor(vtkIdType itemID, QColor color, QMap<int, QVariant> terminologyMetaData);

  Q_INVOKABLE virtual QColor getDisplayColor(vtkIdType itemID, QMap<int, QVariant> &terminologyMetaData)const;

  // Function related virtual methods
public:
  Q_INVOKABLE virtual QList<QAction*> itemContextMenuActions()const;

  Q_INVOKABLE virtual QList<QAction*> sceneContextMenuActions()const;

  Q_INVOKABLE virtual void showContextMenuActionsForItem(vtkIdType itemID) { Q_UNUSED(itemID); };

  Q_INVOKABLE virtual QList<QAction*> visibilityContextMenuActions()const;

  Q_INVOKABLE virtual void showVisibilityContextMenuActionsForItem(vtkIdType itemID) { Q_UNUSED(itemID); };

  Q_INVOKABLE virtual QList<QAction*> viewContextMenuActions()const;

  Q_INVOKABLE virtual void showViewContextMenuActionsForItem(vtkIdType itemID, QVariantMap eventData) { Q_UNUSED(itemID); Q_UNUSED(eventData); };

// Parenting related virtual methods with default implementation
public:
  virtual double canAddNodeToSubjectHierarchy(
    vtkMRMLNode* node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID )const;

  virtual bool addNodeToSubjectHierarchy(vtkMRMLNode* node, vtkIdType parentItemID);

  virtual double canReparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID)const;

  virtual bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID);

  virtual bool showItemInView(vtkIdType itemID, vtkMRMLAbstractViewNode* viewNode, vtkIdList* allItemsToShow);

// Utility functions
public:
  Q_INVOKABLE bool isThisPluginOwnerOfItem(vtkIdType itemID)const;

  Q_INVOKABLE static qSlicerAbstractModuleWidget* switchToModule(QString moduleName);

public:
  virtual QString name()const;

  virtual void setName(QString name);

signals:
  void requestExpandItem(vtkIdType itemID);

  void requestInvalidateFilter()const;

protected:
  void hideAllContextMenuActions()const;

protected:
  QString m_Name;

private:
  qSlicerSubjectHierarchyAbstractPlugin(const qSlicerSubjectHierarchyAbstractPlugin&); // Not implemented
  void operator=(const qSlicerSubjectHierarchyAbstractPlugin&); // Not implemented
  friend class qMRMLSubjectHierarchyTreeView;
  friend class qSlicerSubjectHierarchyPluginLogic;
};

#endif