qSlicerSubjectHierarchyScriptedPlugin.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 __qSlicerSubjectHierarchyScriptedPlugin_h
#define __qSlicerSubjectHierarchyScriptedPlugin_h

// SubjectHierarchy includes
#include "qSlicerSubjectHierarchyAbstractPlugin.h"

#include "qSlicerSubjectHierarchyModuleWidgetsExport.h"

// Forward Declare PyObject*
#ifndef PyObject_HEAD
struct _object;
typedef _object PyObject;
#endif
class qSlicerSubjectHierarchyScriptedPluginPrivate;

class vtkObject;
class QStandardItem;
class QAction;
class qSlicerAbstractModuleWidget;

class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyScriptedPlugin
  : public qSlicerSubjectHierarchyAbstractPlugin
{
  Q_OBJECT

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

  Q_INVOKABLE QString pythonSource()const;

  Q_INVOKABLE bool setPythonSource(const QString newPythonSource);

  Q_INVOKABLE PyObject* self() const;

  void setName(QString name) override;

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

  const QString roleForPlugin()const override;

  const QString helpText()const override;

  QIcon icon(vtkIdType itemID) override;

  QIcon visibilityIcon(int visible) override;

  void editProperties(vtkIdType itemID) override;

  QString displayedItemName(vtkIdType itemID)const override;

  QString tooltip(vtkIdType itemID)const override;

  void setDisplayVisibility(vtkIdType itemID, int visible) override;

  int getDisplayVisibility(vtkIdType itemID)const override;

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

  QList<QAction*> viewContextMenuActions()const override;

  QList<QAction*> sceneContextMenuActions()const override;

  void showContextMenuActionsForItem(vtkIdType itemID) override;

  void showViewContextMenuActionsForItem(vtkIdType itemID, QVariantMap eventData) override;

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

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

  bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID) override;

protected:
  QScopedPointer<qSlicerSubjectHierarchyScriptedPluginPrivate> d_ptr;

private:
  Q_DECLARE_PRIVATE(qSlicerSubjectHierarchyScriptedPlugin);
  Q_DISABLE_COPY(qSlicerSubjectHierarchyScriptedPlugin);
};

#endif