Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
qSlicerSubjectHierarchyScriptedPlugin.h
Go to the documentation of this file.
1 /*==============================================================================
2 
3  Program: 3D Slicer
4 
5  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
6  Queen's University, Kingston, ON, Canada. All Rights Reserved.
7 
8  See COPYRIGHT.txt
9  or http://www.slicer.org/copyright/copyright.txt for details.
10 
11  Unless required by applicable law or agreed to in writing, software
12  distributed under the License is distributed on an "AS IS" BASIS,
13  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  See the License for the specific language governing permissions and
15  limitations under the License.
16 
17  This file was originally developed by Csaba Pinter, PerkLab, Queen's University
18  and was supported through the Applied Cancer Research Unit program of Cancer Care
19  Ontario with funds provided by the Ontario Ministry of Health and Long-Term Care
20 
21 ==============================================================================*/
22 
23 #ifndef __qSlicerSubjectHierarchyScriptedPlugin_h
24 #define __qSlicerSubjectHierarchyScriptedPlugin_h
25 
26 // SubjectHierarchy includes
28 
29 #include "qSlicerSubjectHierarchyModuleWidgetsExport.h"
30 
31 // Forward Declare PyObject*
32 #ifndef PyObject_HEAD
33 struct _object;
34 typedef _object PyObject;
35 #endif
36 class qSlicerSubjectHierarchyScriptedPluginPrivate;
37 
38 class vtkObject;
39 class QStandardItem;
40 class QAction;
42 
62 class Q_SLICER_MODULE_SUBJECTHIERARCHY_WIDGETS_EXPORT qSlicerSubjectHierarchyScriptedPlugin
64 {
65  Q_OBJECT
66 
67 public:
69  qSlicerSubjectHierarchyScriptedPlugin(QObject* parent = nullptr);
71 
72  Q_INVOKABLE QString pythonSource()const;
73 
76  Q_INVOKABLE bool setPythonSource(const QString newPythonSource);
77 
79  Q_INVOKABLE PyObject* self() const;
80 
83  void setName(QString name) override;
84 
85 // Role-related virtual methods
86 // If the subclass plugin does not offer a role, these do not need to be overridden
87 public:
94  double canOwnSubjectHierarchyItem(vtkIdType itemID)const override;
95 
98  const QString roleForPlugin()const override;
99 
101  const QString helpText()const override;
102 
105  QIcon icon(vtkIdType itemID) override;
106 
108  QIcon visibilityIcon(int visible) override;
109 
111  void editProperties(vtkIdType itemID) override;
112 
115  QString displayedItemName(vtkIdType itemID)const override;
116 
118  QString tooltip(vtkIdType itemID)const override;
119 
121  void setDisplayVisibility(vtkIdType itemID, int visible) override;
122 
125  int getDisplayVisibility(vtkIdType itemID)const override;
126 
127 // Function related virtual methods
128 public:
130  QList<QAction*> itemContextMenuActions()const override;
131 
133  QList<QAction*> viewContextMenuActions()const override;
134 
139 
142  void showContextMenuActionsForItem(vtkIdType itemID) override;
143 
147  void showViewContextMenuActionsForItem(vtkIdType itemID, QVariantMap eventData) override;
148 
149  // Parenting related virtual methods with default implementation
150 public:
161  vtkMRMLNode* node,
162  vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID )const override;
163 
172  double canReparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID)const override;
173 
176  bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID) override;
177 
178 protected:
179  QScopedPointer<qSlicerSubjectHierarchyScriptedPluginPrivate> d_ptr;
180 
181 private:
182  Q_DECLARE_PRIVATE(qSlicerSubjectHierarchyScriptedPlugin);
184 };
185 
186 #endif
virtual Q_INVOKABLE void setDisplayVisibility(vtkIdType itemID, int visible)
Set display visibility of an owned subject hierarchy item.
virtual QIcon icon(vtkIdType itemID)
virtual Q_INVOKABLE const QString roleForPlugin() const
virtual double canAddNodeToSubjectHierarchy(vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const
virtual Q_INVOKABLE QString tooltip(vtkIdType itemID) const
Generate tooltip for a owned subject hierarchy item.
QScopedPointer< qSlicerSubjectHierarchyScriptedPluginPrivate > d_ptr
Abstract plugin for handling Subject Hierarchy items.
virtual Q_INVOKABLE void editProperties(vtkIdType itemID)
Open module belonging to item and set inputs in opened module.
virtual double canReparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID) const
Scripted abstract plugin for handling subject hierarchy items or providing actions for items...
virtual Q_INVOKABLE int getDisplayVisibility(vtkIdType itemID) const
virtual Q_INVOKABLE void showContextMenuActionsForItem(vtkIdType itemID)
virtual Q_INVOKABLE QList< QAction * > sceneContextMenuActions() const
virtual Q_INVOKABLE void showViewContextMenuActionsForItem(vtkIdType itemID, QVariantMap eventData)
virtual Q_INVOKABLE QIcon visibilityIcon(int visible)
Get visibility icon for a visibility state.
virtual Q_INVOKABLE QList< QAction * > viewContextMenuActions() const
virtual void setName(QString name)
virtual const QString helpText() const
Get help text for plugin to be added in subject hierarchy module widget help box. ...
Abstract Superclass for all specific types of MRML nodes.
Definition: vtkMRMLNode.h:167
virtual QString displayedItemName(vtkIdType itemID) const
virtual Q_INVOKABLE double canOwnSubjectHierarchyItem(vtkIdType itemID) const
virtual bool reparentItemInsideSubjectHierarchy(vtkIdType itemID, vtkIdType parentItemID)
_object PyObject
virtual Q_INVOKABLE QList< QAction * > itemContextMenuActions() const