qSlicerSubjectHierarchyPluginLogic.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 __qSlicerSubjectHierarchyPluginLogic_h
#define __qSlicerSubjectHierarchyPluginLogic_h

// Slicer includes
#include "qSlicerObject.h"

// CTK includes
#include <ctkVTKObject.h>

// Qt includes
#include <QObject>

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

#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

class QAction;
class QMenu;
class qSlicerSubjectHierarchyPluginLogicPrivate;
class qSlicerSubjectHierarchyAbstractPlugin;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyPluginLogic :
  public QObject, public virtual qSlicerObject
{
  Q_OBJECT
  QVTK_OBJECT

  Q_PROPERTY(QStringList allowedViewContextMenuActionNames READ allowedViewContextMenuActionNames WRITE setAllowedViewContextMenuActionNames)
  Q_PROPERTY(QStringList registeredViewContextMenuActionNames READ registeredViewContextMenuActionNames)

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

public:
  void setMRMLScene(vtkMRMLScene* scene) override;

  Q_INVOKABLE qSlicerSubjectHierarchyAbstractPlugin* subjectHierarchyPluginByName(QString name)const;

  Q_INVOKABLE vtkIdType currentSubjectHierarchyItem()const;

  Q_INVOKABLE void setCurrentSubjectHierarchyItem(vtkIdType itemID);

  void registerCorePlugins();

  QStringList registeredViewContextMenuActionNames();

  void setAllowedViewContextMenuActionNames(QStringList actionObjectNames);

  QStringList allowedViewContextMenuActionNames() const;

  Q_INVOKABLE void setAllowedViewContextMenuActionNamesForItem(vtkIdType itemID, const QStringList& actionObjectNames);

  Q_INVOKABLE QStringList allowedViewContextMenuActionNamesForItem(vtkIdType itemID);

  static Q_INVOKABLE QString buildMenuFromActions(QMenu* menu, QList< QAction* > actions, const QStringList& allowedActions=QStringList());

protected:
  void observeNode(vtkMRMLNode* node);

  void addSupportedDataNodesToSubjectHierarchy();

  void registerViewContextMenuAction(QAction* action);

protected slots:
  void onNodeAdded(vtkObject* scene, vtkObject* nodeObject);
  void onNodeAboutToBeRemoved(vtkObject* scene, vtkObject* nodeObject);
  void onNodeRemoved(vtkObject* scene, vtkObject* nodeObject);
  void onSceneImportEnded(vtkObject* sceneObject);
  void onSceneCloseEnded(vtkObject* sceneObject);
  void onSceneRestoreEnded(vtkObject* sceneObject);
  void onSceneBatchProcessEnded(vtkObject* sceneObject);

  void onDisplayNodeModified(vtkObject*, vtkObject*);
  void onDisplayMenuEvent(vtkObject*, vtkObject*);
  void editProperties();

protected:
  QScopedPointer<qSlicerSubjectHierarchyPluginLogicPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerSubjectHierarchyPluginLogic);
  Q_DISABLE_COPY(qSlicerSubjectHierarchyPluginLogic);
  friend class qSlicerSubjectHierarchyPluginHandler;
};

#endif