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 = NULL);
  virtual ~qSlicerSubjectHierarchyScriptedPlugin();

  Q_INVOKABLE QString pythonSource()const;

  Q_INVOKABLE bool setPythonSource(const QString newPythonSource);

  Q_INVOKABLE PyObject* self() const;

  virtual void setName(QString name);

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

  virtual const QString roleForPlugin()const;

  virtual const QString helpText()const;

  virtual QIcon icon(vtkIdType itemID);

  virtual QIcon visibilityIcon(int visible);

  virtual void editProperties(vtkIdType itemID);

  virtual QString displayedItemName(vtkIdType itemID)const;

  virtual QString tooltip(vtkIdType itemID)const;

  virtual void setDisplayVisibility(vtkIdType itemID, int visible);

  virtual int getDisplayVisibility(vtkIdType itemID)const;

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

  virtual QList<QAction*> sceneContextMenuActions()const;

  virtual void showContextMenuActionsForItem(vtkIdType itemID);

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

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

  virtual bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID);

protected:
  QScopedPointer<qSlicerSubjectHierarchyScriptedPluginPrivate> d_ptr;

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

#endif