qSlicerSubjectHierarchyPlotsPlugin Class Reference

#include <Modules/Loadable/Plots/SubjectHierarchyPlugins/qSlicerSubjectHierarchyPlotsPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyPlotsPlugin:

Collaboration diagram for qSlicerSubjectHierarchyPlotsPlugin:

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
int	getDisplayVisibility (vtkIdType itemID) const override
QIcon	icon (vtkIdType itemID) override
	qSlicerSubjectHierarchyPlotsPlugin (QObject *parent=nullptr)
Q_INVOKABLE const QString	roleForPlugin () const override
void	setDisplayVisibility (vtkIdType itemID, int visible) override
	Set display visibility of a owned subject hierarchy item. More...
void	setPlotsLogic (vtkSlicerPlotsLogic *plotsLogic)
	Set plots module logic. Required for switching layouts and showing plot in layout. More...
QIcon	visibilityIcon (int visible) override
	Get visibility icon for a visibility state. More...
	~qSlicerSubjectHierarchyPlotsPlugin () 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 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=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 void	setName (QString name)
virtual Q_INVOKABLE void	showContextMenuActionsForItem (vtkIdType itemID)
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
	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Member Functions
vtkMRMLPlotViewNode *	getPlotViewNode () const
	Return the chart view node object from the layout. More...
Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void	hideAllContextMenuActions () const

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyPlotsPluginPrivate >	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 qSlicerAbstractModuleWidget *	switchToModule (QString moduleName)

Detailed Description

Definition at line 34 of file qSlicerSubjectHierarchyPlotsPlugin.h.

Member Typedef Documentation

Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyPlotsPlugin::Superclass

Definition at line 40 of file qSlicerSubjectHierarchyPlotsPlugin.h.

Constructor & Destructor Documentation

qSlicerSubjectHierarchyPlotsPlugin()

qSlicerSubjectHierarchyPlotsPlugin::qSlicerSubjectHierarchyPlotsPlugin

(

QObject *

parent = nullptr

)

~qSlicerSubjectHierarchyPlotsPlugin()

qSlicerSubjectHierarchyPlotsPlugin::~qSlicerSubjectHierarchyPlotsPlugin ( )

override

Member Function Documentation

canAddNodeToSubjectHierarchy()

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

overridevirtual

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

double qSlicerSubjectHierarchyPlotsPlugin::canOwnSubjectHierarchyItem ( vtkIdType  itemID ) const

overridevirtual

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.

getDisplayVisibility()

int qSlicerSubjectHierarchyPlotsPlugin::getDisplayVisibility ( vtkIdType  itemID ) const

overridevirtual

Get display visibility of a owned subject hierarchy item

Returns

Display visibility (0: hidden, 1: shown, 2: partially shown)

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

getPlotViewNode()

vtkMRMLPlotViewNode* qSlicerSubjectHierarchyPlotsPlugin::getPlotViewNode ( ) const

protected

Return the chart view node object from the layout.

icon()

QIcon qSlicerSubjectHierarchyPlotsPlugin::icon ( vtkIdType  itemID )

overridevirtual

Get icon of an owned subject hierarchy item

Returns

Icon to set, empty icon if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

roleForPlugin()

Q_INVOKABLE const QString qSlicerSubjectHierarchyPlotsPlugin::roleForPlugin ( ) const

overridevirtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

setDisplayVisibility()

void qSlicerSubjectHierarchyPlotsPlugin::setDisplayVisibility ( vtkIdType  itemID, int  visible  )

overridevirtual

Set display visibility of a owned subject hierarchy item.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

setPlotsLogic()

void qSlicerSubjectHierarchyPlotsPlugin::setPlotsLogic

(

vtkSlicerPlotsLogic *

plotsLogic

)

Set plots module logic. Required for switching layouts and showing plot in layout.

visibilityIcon()

QIcon qSlicerSubjectHierarchyPlotsPlugin::visibilityIcon ( int  visible )

overridevirtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

d_ptr

QScopedPointer<qSlicerSubjectHierarchyPlotsPluginPrivate> qSlicerSubjectHierarchyPlotsPlugin::d_ptr

protected

Definition at line 91 of file qSlicerSubjectHierarchyPlotsPlugin.h.

---

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

• Modules/Loadable/Plots/SubjectHierarchyPlugins/qSlicerSubjectHierarchyPlotsPlugin.h