qSlicerSubjectHierarchyMarkupsPlugin Class Reference

#include <Modules/Loadable/Markups/SubjectHierarchyPlugins/qSlicerSubjectHierarchyMarkupsPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyMarkupsPlugin:

Collaboration diagram for qSlicerSubjectHierarchyMarkupsPlugin:

Public Types
typedef qSlicerSubjectHierarchyAbstractPlugin	Superclass
Public Types inherited from qSlicerSubjectHierarchyAbstractPlugin
typedef QObject	Superclass

Public Member Functions
virtual double	canAddNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID=vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID) const
virtual double	canOwnSubjectHierarchyItem (vtkIdType itemID) const
virtual QColor	getDisplayColor (vtkIdType itemID, QMap< int, QVariant > &terminologyMetaData) const
virtual QIcon	icon (vtkIdType itemID)
	qSlicerSubjectHierarchyMarkupsPlugin (QObject *parent=NULL)
virtual Q_INVOKABLE const QString	roleForPlugin () const
virtual void	setDisplayColor (vtkIdType itemID, QColor color, QMap< int, QVariant > terminologyMetaData)
virtual QIcon	visibilityIcon (int visible)
	Get visibility icon for a visibility state. More...
virtual	~qSlicerSubjectHierarchyMarkupsPlugin ()
Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool	addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)
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 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 Q_INVOKABLE QList< QAction * >	itemContextMenuActions () const
virtual QString	name () const
	Get the name of the plugin. More...
	qSlicerSubjectHierarchyAbstractPlugin (QObject *parent=NULL)
virtual bool	reparentItemInsideSubjectHierarchy (vtkIdType itemID, vtkIdType parentItemID)
virtual Q_INVOKABLE QList< QAction * >	sceneContextMenuActions () const
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 Q_INVOKABLE void	showContextMenuActionsForItem (vtkIdType itemID)
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 * >	visibilityContextMenuActions () const
virtual	~qSlicerSubjectHierarchyAbstractPlugin ()

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyMarkupsPluginPrivate >	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 qSlicerAbstractModuleWidget *	switchToModule (QString moduleName)
Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void	hideAllContextMenuActions () const

Detailed Description

Definition at line 40 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

Member Typedef Documentation

Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyMarkupsPlugin::Superclass

Definition at line 46 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

Constructor & Destructor Documentation

qSlicerSubjectHierarchyMarkupsPlugin()

qSlicerSubjectHierarchyMarkupsPlugin::qSlicerSubjectHierarchyMarkupsPlugin

(

QObject *

parent = NULL

)

~qSlicerSubjectHierarchyMarkupsPlugin()

virtual qSlicerSubjectHierarchyMarkupsPlugin::~qSlicerSubjectHierarchyMarkupsPlugin ( )

virtual

Member Function Documentation

canAddNodeToSubjectHierarchy()

virtual double qSlicerSubjectHierarchyMarkupsPlugin::canAddNodeToSubjectHierarchy ( vtkMRMLNode *  node, vtkIdType  parentItemID = vtkMRMLSubjectHierarchyNode::INVALID_ITEM_ID  ) const

virtual

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).

Parameters

node	Node to be added to the hierarchy
parentItemID	Prospective 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.

Returns

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()

virtual double qSlicerSubjectHierarchyMarkupsPlugin::canOwnSubjectHierarchyItem ( vtkIdType  itemID ) const

virtual

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.)

Parameters

item	Item to handle in the subject hierarchy tree

Returns

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.

getDisplayColor()

virtual QColor qSlicerSubjectHierarchyMarkupsPlugin::getDisplayColor ( vtkIdType  itemID, QMap< int, QVariant > &  terminologyMetaData  ) const

virtual

Get display color of an owned subject hierarchy item

Parameters

terminologyMetaData

Output map containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

icon()

virtual QIcon qSlicerSubjectHierarchyMarkupsPlugin::icon ( vtkIdType  itemID )

virtual

Get icon of an owned subject hierarchy item

Returns

Icon to set, empty icon if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

roleForPlugin()

virtual Q_INVOKABLE const QString qSlicerSubjectHierarchyMarkupsPlugin::roleForPlugin ( ) const

virtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

setDisplayColor()

virtual void qSlicerSubjectHierarchyMarkupsPlugin::setDisplayColor ( vtkIdType  itemID, QColor  color, QMap< int, QVariant >  terminologyMetaData  )

virtual

Set display color of an owned subject hierarchy item

Parameters

color	Display color to set
terminologyMetaData	Map containing terminology meta data. Contents: qSlicerTerminologyItemDelegate::TerminologyRole : string qSlicerTerminologyItemDelegate::NameRole : string qSlicerTerminologyItemDelegate::NameAutoGeneratedRole : bool qSlicerTerminologyItemDelegate::ColorAutoGeneratedRole : bool

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

visibilityIcon()

virtual QIcon qSlicerSubjectHierarchyMarkupsPlugin::visibilityIcon ( int  visible )

virtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerSubjectHierarchyMarkupsPluginPrivate> qSlicerSubjectHierarchyMarkupsPlugin::d_ptr

protected

Definition at line 99 of file qSlicerSubjectHierarchyMarkupsPlugin.h.

---

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

• Modules/Loadable/Markups/SubjectHierarchyPlugins/qSlicerSubjectHierarchyMarkupsPlugin.h