Default Subject Hierarchy plugin to exercise features of the abstract plugin. This plugin must not be registered as this is the fall back plugin called when there is none found. More...

#include <Modules/Loadable/SubjectHierarchy/Widgets/qSlicerSubjectHierarchyDefaultPlugin.h>

Inheritance diagram for qSlicerSubjectHierarchyDefaultPlugin:

[legend]

Collaboration diagram for qSlicerSubjectHierarchyDefaultPlugin:

[legend]

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 Slots
void	hideAllChildren ()
	Hide all direct children of current item. More...

void	showAllChildren ()
	Show all direct children of current item. More...

void	toggleVisibility ()
	Toggle visibility for current item. More...

Public Member Functions
double	canOwnSubjectHierarchyItem (vtkIdType itemID) const override

const QString	helpText () const override
	Get help text for plugin to be added in subject hierarchy module widget help box. More...

QIcon	icon (vtkIdType itemID) override

	qSlicerSubjectHierarchyDefaultPlugin (QObject *parent=nullptr)

Q_INVOKABLE const QString	roleForPlugin () const override

void	setDefaultVisibilityIcons (QIcon visibleIcon, QIcon hiddenIcon, QIcon partiallyVisibleIcon)
	Set default visibility icons owned by the scene model so that the default plugin can set them. More...

void	showVisibilityContextMenuActionsForItem (vtkIdType itemID) override

QList< QAction * >	visibilityContextMenuActions () const override

QIcon	visibilityIcon (int visible) override
	Get visibility icon for a visibility state. More...

	~qSlicerSubjectHierarchyDefaultPlugin () override

Public Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
virtual bool	addNodeToSubjectHierarchy (vtkMRMLNode *node, vtkIdType parentItemID)

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

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

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 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 bool	showItemInView (vtkIdType itemID, vtkMRMLAbstractViewNode viewNode, vtkIdList allItemsToShow)

virtual Q_INVOKABLE void	showViewContextMenuActionsForItem (vtkIdType itemID, QVariantMap eventData)

virtual Q_INVOKABLE QString	tooltip (vtkIdType itemID) const
	Generate tooltip for a owned subject hierarchy item. More...

virtual Q_INVOKABLE QList< QAction * >	viewContextMenuActions () const

	~qSlicerSubjectHierarchyAbstractPlugin () override

Protected Attributes
QScopedPointer< qSlicerSubjectHierarchyDefaultPluginPrivate >	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)

Protected Member Functions inherited from qSlicerSubjectHierarchyAbstractPlugin
void	hideAllContextMenuActions () const

Detailed Description

Default Subject Hierarchy plugin to exercise features of the abstract plugin. This plugin must not be registered as this is the fall back plugin called when there is none found.

Definition at line 40 of file qSlicerSubjectHierarchyDefaultPlugin.h.

Member Typedef Documentation

◆ Superclass

typedef qSlicerSubjectHierarchyAbstractPlugin qSlicerSubjectHierarchyDefaultPlugin::Superclass

Definition at line 46 of file qSlicerSubjectHierarchyDefaultPlugin.h.

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyDefaultPlugin()

qSlicerSubjectHierarchyDefaultPlugin::qSlicerSubjectHierarchyDefaultPlugin ( QObject * parent = nullptr )

◆ ~qSlicerSubjectHierarchyDefaultPlugin()

qSlicerSubjectHierarchyDefaultPlugin::~qSlicerSubjectHierarchyDefaultPlugin ( )

override

Member Function Documentation

◆ canOwnSubjectHierarchyItem()

double qSlicerSubjectHierarchyDefaultPlugin::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.

◆ helpText()

const QString qSlicerSubjectHierarchyDefaultPlugin::helpText ( ) const

overridevirtual

Get help text for plugin to be added in subject hierarchy module widget help box.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ hideAllChildren

void qSlicerSubjectHierarchyDefaultPlugin::hideAllChildren ( )

slot

Hide all direct children of current item.

◆ icon()

QIcon qSlicerSubjectHierarchyDefaultPlugin::icon ( vtkIdType itemID )

overridevirtual

Get icon of an owned subject hierarchy item

Returns: Icon to set, nullptr if nothing to set

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ roleForPlugin()

Q_INVOKABLE const QString qSlicerSubjectHierarchyDefaultPlugin::roleForPlugin ( ) const

overridevirtual

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

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ setDefaultVisibilityIcons()

void qSlicerSubjectHierarchyDefaultPlugin::setDefaultVisibilityIcons	(	QIcon	visibleIcon,
		QIcon	hiddenIcon,
		QIcon	partiallyVisibleIcon
	)

Set default visibility icons owned by the scene model so that the default plugin can set them.

◆ showAllChildren

void qSlicerSubjectHierarchyDefaultPlugin::showAllChildren ( )

slot

Show all direct children of current item.

◆ showVisibilityContextMenuActionsForItem()

void qSlicerSubjectHierarchyDefaultPlugin::showVisibilityContextMenuActionsForItem ( vtkIdType itemID )

overridevirtual

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

Parameters

itemID Subject Hierarchy item to show the visibility context menu items for

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ toggleVisibility

void qSlicerSubjectHierarchyDefaultPlugin::toggleVisibility ( )

slot

Toggle visibility for current item.

◆ visibilityContextMenuActions()

QList<QAction*> qSlicerSubjectHierarchyDefaultPlugin::visibilityContextMenuActions ( ) const

overridevirtual

Get visibility context menu item actions to add to tree view. These item visibility context menu actions can be shown in the implementations of

See also: showVisibilityContextMenuActionsForItem

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

◆ visibilityIcon()

QIcon qSlicerSubjectHierarchyDefaultPlugin::visibilityIcon ( int visible )

overridevirtual

Get visibility icon for a visibility state.

Reimplemented from qSlicerSubjectHierarchyAbstractPlugin.

Member Data Documentation

◆ d_ptr

QScopedPointer<qSlicerSubjectHierarchyDefaultPluginPrivate> qSlicerSubjectHierarchyDefaultPlugin::d_ptr

protected

Definition at line 96 of file qSlicerSubjectHierarchyDefaultPlugin.h.

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

Modules/Loadable/SubjectHierarchy/Widgets/qSlicerSubjectHierarchyDefaultPlugin.h

Public Types

Public Slots

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ qSlicerSubjectHierarchyDefaultPlugin()

◆ ~qSlicerSubjectHierarchyDefaultPlugin()

Member Function Documentation

◆ canOwnSubjectHierarchyItem()

◆ helpText()

◆ hideAllChildren

◆ icon()

◆ roleForPlugin()

◆ setDefaultVisibilityIcons()

◆ showAllChildren

◆ showVisibilityContextMenuActionsForItem()

◆ toggleVisibility

◆ visibilityContextMenuActions()

◆ visibilityIcon()

Member Data Documentation

◆ d_ptr