qSlicerSubjectHierarchyPluginHandler.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 __qSlicerSubjectHierarchyPluginHandler_h
#define __qSlicerSubjectHierarchyPluginHandler_h

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

// MRML includes
#include <vtkMRMLScene.h>
#include <vtkMRMLSubjectHierarchyNode.h>

// VTK includes
#include <vtkSmartPointer.h>
#include <vtkWeakPointer.h>

// Qt includes
#include <QDateTime>
#include <QList>
#include <QObject>
#include <QString>

class vtkMRMLScene;
class vtkCallbackCommand;
class qSlicerSubjectHierarchyPluginLogic;
class qSlicerSubjectHierarchyAbstractPlugin;
class qSlicerSubjectHierarchyDefaultPlugin;
class qSlicerSubjectHierarchyPluginHandlerCleanup;


class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyPluginHandler : public QObject
{
  Q_OBJECT

  Q_PROPERTY (bool autoDeleteSubjectHierarchyChildren READ autoDeleteSubjectHierarchyChildren WRITE setAutoDeleteSubjectHierarchyChildren)
  Q_PROPERTY (bool displayPatientIDInSubjectHierarchyItemName READ displayPatientIDInSubjectHierarchyItemName WRITE setDisplayPatientIDInSubjectHierarchyItemName)
  Q_PROPERTY (bool displayPatientBirthDateInSubjectHierarchyItemName READ displayPatientBirthDateInSubjectHierarchyItemName WRITE setDisplayPatientBirthDateInSubjectHierarchyItemName)
  Q_PROPERTY (bool displayStudyIDInSubjectHierarchyItemName READ displayStudyIDInSubjectHierarchyItemName WRITE setDisplayStudyIDInSubjectHierarchyItemName)
  Q_PROPERTY (bool displayStudyDateInSubjectHierarchyItemName READ displayStudyDateInSubjectHierarchyItemName WRITE setDisplayStudyDateInSubjectHierarchyItemName)

public:
  Q_INVOKABLE static qSlicerSubjectHierarchyPluginHandler* instance();

  Q_INVOKABLE vtkMRMLSubjectHierarchyNode* subjectHierarchyNode()const;
  void setMRMLScene(vtkMRMLScene* scene);
  Q_INVOKABLE vtkMRMLScene* mrmlScene()const;

  Q_INVOKABLE qSlicerSubjectHierarchyPluginLogic* pluginLogic();
  Q_INVOKABLE void setPluginLogic(qSlicerSubjectHierarchyPluginLogic* pluginLogic);

  Q_INVOKABLE void setCurrentItem(vtkIdType itemID);

  Q_INVOKABLE vtkIdType currentItem();

  Q_INVOKABLE void setCurrentItems(QList<vtkIdType> items);

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

  Q_INVOKABLE bool autoDeleteSubjectHierarchyChildren()const;
  Q_INVOKABLE void setAutoDeleteSubjectHierarchyChildren(bool flag);
  Q_INVOKABLE bool displayPatientIDInSubjectHierarchyItemName()const;
  Q_INVOKABLE void setDisplayPatientIDInSubjectHierarchyItemName(bool on);
  Q_INVOKABLE bool displayPatientBirthDateInSubjectHierarchyItemName()const;
  Q_INVOKABLE void setDisplayPatientBirthDateInSubjectHierarchyItemName(bool on);
  Q_INVOKABLE bool displayStudyIDInSubjectHierarchyItemName()const;
  Q_INVOKABLE void setDisplayStudyIDInSubjectHierarchyItemName(bool on);
  Q_INVOKABLE bool displayStudyDateInSubjectHierarchyItemName()const;
  Q_INVOKABLE void setDisplayStudyDateInSubjectHierarchyItemName(bool on);

public:
  Q_INVOKABLE bool registerPlugin(qSlicerSubjectHierarchyAbstractPlugin* plugin);

  Q_INVOKABLE QList<qSlicerSubjectHierarchyAbstractPlugin*> registeredPlugins() { return m_RegisteredPlugins; };

  Q_INVOKABLE qSlicerSubjectHierarchyDefaultPlugin* defaultPlugin();

  Q_INVOKABLE QList<qSlicerSubjectHierarchyAbstractPlugin*> allPlugins();

  Q_INVOKABLE qSlicerSubjectHierarchyAbstractPlugin* pluginByName(QString name);

  QList<qSlicerSubjectHierarchyAbstractPlugin*> pluginsForAddingNodeToSubjectHierarchy(
    vtkMRMLNode* node,
    vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID );

  QList<qSlicerSubjectHierarchyAbstractPlugin*> pluginsForReparentingItemInSubjectHierarchy(
    vtkIdType itemID, vtkIdType parentItemID );

  qSlicerSubjectHierarchyAbstractPlugin* findOwnerPluginForSubjectHierarchyItem(vtkIdType itemID);

  qSlicerSubjectHierarchyAbstractPlugin* findAndSetOwnerPluginForSubjectHierarchyItem(vtkIdType itemID);

  Q_INVOKABLE qSlicerSubjectHierarchyAbstractPlugin* getOwnerPluginForSubjectHierarchyItem(vtkIdType itemID);

  qSlicerSubjectHierarchyAbstractPlugin* selectPluginFromDialog(QString textToDisplay, QList<qSlicerSubjectHierarchyAbstractPlugin*> candidatePlugins);

  void observeSubjectHierarchyNode(vtkMRMLSubjectHierarchyNode* shNode);

  Q_INVOKABLE void showItemsInView(vtkIdList* itemIDsToShow, vtkMRMLAbstractViewNode* viewNode);

  Q_INVOKABLE QString dumpContextMenuActions();

protected:
  static void onSubjectHierarchyNodeEvent(vtkObject* caller, unsigned long event, void* clientData, void* callData);

protected:
  QList<qSlicerSubjectHierarchyAbstractPlugin*> m_RegisteredPlugins;

  qSlicerSubjectHierarchyDefaultPlugin* m_DefaultPlugin;

  QList<vtkIdType> m_CurrentItems;

  vtkWeakPointer<vtkMRMLScene> m_MRMLScene;

  qSlicerSubjectHierarchyPluginLogic* m_PluginLogic{nullptr};

  vtkSmartPointer<vtkCallbackCommand> m_CallBack;

public:
  QDateTime LastPluginRegistrationTime;

private:
  static void cleanup();

private:
  qSlicerSubjectHierarchyPluginHandler(QObject* parent=nullptr);
  ~qSlicerSubjectHierarchyPluginHandler() override;

  Q_DISABLE_COPY(qSlicerSubjectHierarchyPluginHandler);
  friend class qSlicerSubjectHierarchyPluginHandlerCleanup;
  friend class PythonQtWrapper_qSlicerSubjectHierarchyPluginHandler; // Allow Python wrapping without enabling direct instantiation

private:
  static qSlicerSubjectHierarchyPluginHandler* m_Instance;
};

#endif