Slicer  5.3
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Protected Slots | Protected Attributes
qSlicerSubjectHierarchySceneViewsPlugin Class Reference

#include <Modules/Loadable/SceneViews/SubjectHierarchyPlugins/qSlicerSubjectHierarchySceneViewsPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchySceneViewsPlugin:
Inheritance graph
Collaboration diagram for qSlicerSubjectHierarchySceneViewsPlugin:
Collaboration graph

Public Types

typedef qSlicerSubjectHierarchyAbstractPlugin Superclass
- Public Types inherited from qSlicerSubjectHierarchyAbstractPlugin
enum  ActionSectionType {
  SectionTop = -400, SectionInteraction = -300, SectionComponent = -200, SectionNode = -100,
  SectionDefault = 0, SectionFolder = 100, SectionBottom = 200
typedef QObject Superclass

Public Member Functions

double canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const override
double canOwnSubjectHierarchyItem (vtkIdType itemID) const override
QIcon icon (vtkIdType itemID) override
QList< QAction * > itemContextMenuActions () const override
 Get item context menu item actions to add to tree view. More...
 qSlicerSubjectHierarchySceneViewsPlugin (QObject *parent=nullptr)
Q_INVOKABLE const QString roleForPlugin () const override
void showContextMenuActionsForItem (vtkIdType itemID) override
 ~qSlicerSubjectHierarchySceneViewsPlugin () override
- Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
virtual Q_INVOKABLE bool canEditProperties (vtkIdType itemID)
 Returns true if the module can edit properties of this item using editProperties. More...
virtual double canReparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID) const
virtual QString displayedItemName (vtkIdType itemID) const
virtual Q_INVOKABLE void editProperties (vtkIdType itemID)
 Open module belonging to item and set inputs in opened module. More...
virtual Q_INVOKABLE QColor getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) const
virtual Q_INVOKABLE int getDisplayVisibility (vtkIdType itemID) const
virtual const QString helpText () const
 Get help text for plugin to be added in subject hierarchy module widget help box. More...
Q_INVOKABLE bool isThisPluginOwnerOfItem (vtkIdType itemID) const
 Determines if the item is owned by this plugin. More...
virtual QString name () const
 Get the name of the plugin. More...
 qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=nullptr)
virtual bool reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)
virtual Q_INVOKABLE QList< QAction * > sceneContextMenuActions () const
virtual Q_INVOKABLE void setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData)
virtual Q_INVOKABLE void setDisplayVisibility (vtkIdType itemID, int visible)
 Set display visibility of an owned subject hierarchy item. More...
virtual void setName (QString name)
virtual bool showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode *viewNode, vtkIdList *allItemsToShow)
virtual Q_INVOKABLE void showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData)
virtual Q_INVOKABLE void showVisibilityContextMenuActionsForItem (vtkIdType itemID)
virtual Q_INVOKABLE QString tooltip (vtkIdType itemID) const
 Generate tooltip for a owned subject hierarchy item. More...
virtual Q_INVOKABLE QList< QAction * > viewContextMenuActions () const
virtual Q_INVOKABLE QList< QAction * > visibilityContextMenuActions () const
virtual Q_INVOKABLE QIcon visibilityIcon (int visible)
 Get visibility icon for a visibility state. More...
 ~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Slots

void restoreCurrentSceneView () const
 Restore scene view. More...

Protected Attributes

QScopedPointer< qSlicerSubjectHierarchySceneViewsPluginPrivate > d_ptr
- Protected Attributes inherited from qSlicerSubjectHierarchyAbstractPlugin
QString m_Name
 Name of the plugin. More...

Additional Inherited Members

- Properties inherited from qSlicerSubjectHierarchyAbstractPlugin
QString name
- Signals inherited from qSlicerSubjectHierarchyAbstractPlugin
void requestExpandItem (vtkIdType itemID)
 Signal requesting expanding of the subject hierarchy tree item belonging to an item. More...
void requestInvalidateFilter () const
- Static Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
static Q_INVOKABLE void setActionPosition (QAction *action, int section, int weight=0, double weightAdjustment=0.0)
static Q_INVOKABLE qSlicerAbstractModuleWidgetswitchToModule (QString moduleName)
- Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void hideAllContextMenuActions () const

Detailed Description

Definition at line 36 of file qSlicerSubjectHierarchySceneViewsPlugin.h.

Member Typedef Documentation

◆ Superclass

Definition at line 42 of file qSlicerSubjectHierarchySceneViewsPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchySceneViewsPlugin()

qSlicerSubjectHierarchySceneViewsPlugin::qSlicerSubjectHierarchySceneViewsPlugin ( QObject *  parent = nullptr)

◆ ~qSlicerSubjectHierarchySceneViewsPlugin()

qSlicerSubjectHierarchySceneViewsPlugin::~qSlicerSubjectHierarchySceneViewsPlugin ( )

Member Function Documentation

◆ canAddNodeToSubjectHierarchy()

double qSlicerSubjectHierarchySceneViewsPlugin::canAddNodeToSubjectHierarchy ( vtkMRMLNode node,
vtkIdType  parentItemID = vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID 
) const

Determines if a data node can be placed in the hierarchy using the actual plugin, and gets a confidence value for a certain MRML node (usually the type and possibly attributes are checked).

nodeNode to be added to the hierarchy
parentItemIDProspective parent of the node to add. Default value is invalid. In that case the parent will be ignored, the confidence numbers are got based on the to-be child node alone.
Floating point confidence number between 0 and 1, where 0 means that the plugin cannot handle the node, and 1 means that the plugin is the only one that can handle the node (by node type or identifier attribute)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ canOwnSubjectHierarchyItem()

double qSlicerSubjectHierarchySceneViewsPlugin::canOwnSubjectHierarchyItem ( vtkIdType  itemID) const

Determines if the actual plugin can handle a subject hierarchy item. The plugin with the highest confidence number will "own" the item in the subject hierarchy (set icon, tooltip, set context menu etc.)

itemItem to handle in the subject hierarchy tree
Floating point confidence number between 0 and 1, where 0 means that the plugin cannot handle the item, and 1 means that the plugin is the only one that can handle the item (by node type or identifier attribute)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ icon()

QIcon qSlicerSubjectHierarchySceneViewsPlugin::icon ( vtkIdType  itemID)

Get icon of an owned subject hierarchy item

Icon to set, empty icon if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ itemContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchySceneViewsPlugin::itemContextMenuActions ( ) const

Get item context menu item actions to add to tree view.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ restoreCurrentSceneView

void qSlicerSubjectHierarchySceneViewsPlugin::restoreCurrentSceneView ( ) const

Restore scene view.

◆ roleForPlugin()

Q_INVOKABLE const QString qSlicerSubjectHierarchySceneViewsPlugin::roleForPlugin ( ) const

Get role that the plugin assigns to the subject hierarchy item. Each plugin should provide only one role.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ showContextMenuActionsForItem()

void qSlicerSubjectHierarchySceneViewsPlugin::showContextMenuActionsForItem ( vtkIdType  itemID)

Show context menu actions valid for a given subject hierarchy item.

itemIDSubject Hierarchy item to show the context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchySceneViewsPluginPrivate> qSlicerSubjectHierarchySceneViewsPlugin::d_ptr

Definition at line 86 of file qSlicerSubjectHierarchySceneViewsPlugin.h.

The documentation for this class was generated from the following file: