qMRMLSubjectHierarchyComboBox Class Reference

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

Inheritance diagram for qMRMLSubjectHierarchyComboBox:

Collaboration diagram for qMRMLSubjectHierarchyComboBox:

Public Types
typedef ctkComboBox	Superclass

Properties
bool	alignPopupVertically
bool	highlightReferencedItems
int	maximumNumberOfShownItems
	Property determining the maximum number of items (rows) shown in the popup tree. More...
bool	showRootItem

Public Slots
virtual void	setCurrentItem (vtkIdType itemID)
	Set current (=selected) subject hierarchy item. More...
virtual void	setMRMLScene (vtkMRMLScene *scene)
	Set MRML scene. More...
virtual void	setRootItem (vtkIdType itemID)
	Set subject hierarchy item to be the root in the shown tree. More...

Signals
void	currentItemChanged (vtkIdType)
void	currentItemModified (vtkIdType)

Public Member Functions
bool	alignPopupVertically () const
Q_INVOKABLE void	clearSelection ()
Q_INVOKABLE vtkIdType	currentItem () const
bool	highlightReferencedItems () const
int	maximumNumberOfShownItems () const
Q_INVOKABLE qMRMLSubjectHierarchyModel *	model () const
Q_INVOKABLE vtkMRMLScene *	mrmlScene () const
	qMRMLSubjectHierarchyComboBox (QWidget *parent=0)
Q_INVOKABLE void	removeAttributeFilter ()
	Remove item attribute filtering. More...
Q_INVOKABLE vtkIdType	rootItem () const
void	setAlignPopupVertically (bool align)
Q_INVOKABLE void	setAttributeFilter (const QString &attributeName, const QVariant &attributeValue=QVariant())
void	setHighlightReferencedItems (bool highlightOn)
Q_INVOKABLE void	setLevelFilter (QString &levelFilter)
	Set level filter that allows showing only items at a specified level and their parents. Show all items if empty. More...
void	setMaximumNumberOfShownItems (int maxNumberOfShownItems)
void	setShowRootItem (bool show)
virtual void	showPopup ()
	Provides customized popup window for the tree view. More...
bool	showRootItem () const
Q_INVOKABLE qMRMLSortFilterSubjectHierarchyProxyModel *	sortFilterProxyModel () const
Q_INVOKABLE vtkMRMLSubjectHierarchyNode *	subjectHierarchyNode () const
virtual	~qMRMLSubjectHierarchyComboBox ()

Protected Slots
void	updateComboBoxTitleAndIcon (vtkIdType selectedShItemID)

Protected Member Functions
virtual void	mousePressEvent (QMouseEvent *event)
	Handle mouse press event (disable context menu) More...

Protected Attributes
QScopedPointer< qMRMLSubjectHierarchyComboBoxPrivate >	d_ptr

Detailed Description

Definition at line 40 of file qMRMLSubjectHierarchyComboBox.h.

Member Typedef Documentation

Superclass

typedef ctkComboBox qMRMLSubjectHierarchyComboBox::Superclass

Definition at line 61 of file qMRMLSubjectHierarchyComboBox.h.

Property Documentation

alignPopupVertically

bool qMRMLSubjectHierarchyComboBox::alignPopupVertically

readwrite

Property determining the vertical alignement of the popup tree with the combobox. If aligned, the popup will shift vertically so that the selected item overlays above the combobox. Else, the popup tree appears below the combobox, like for a qMRMLNodeComboBox.

Definition at line 58 of file qMRMLSubjectHierarchyComboBox.h.

highlightReferencedItems

bool qMRMLSubjectHierarchyComboBox::highlightReferencedItems

readwrite

Flag determining whether to highlight items referenced by DICOM. Storing DICOM references: Referenced SOP instance UIDs (in attribute named vtkMRMLSubjectHierarchyConstants::GetDICOMReferencedInstanceUIDsAttributeName()) -> SH item instance UIDs (serialized string lists in subject hierarchy UID vtkMRMLSubjectHierarchyConstants::GetDICOMInstanceUIDName())

Definition at line 52 of file qMRMLSubjectHierarchyComboBox.h.

maximumNumberOfShownItems

int qMRMLSubjectHierarchyComboBox::maximumNumberOfShownItems

readwrite

Property determining the maximum number of items (rows) shown in the popup tree.

Definition at line 54 of file qMRMLSubjectHierarchyComboBox.h.

showRootItem

bool qMRMLSubjectHierarchyComboBox::showRootItem

readwrite

This property controls whether the root item (folder, an item for a data node, or the scene itself), if any is visible. When the root item is visible, it appears as a top-level item, if it is hidden only its children are top-level items. It doesn't have any effect if rootItem() is invalid. Shown by default.

See also

setShowRootItem(), showRootItem(), setRootItem(), setRootIndex()

Definition at line 48 of file qMRMLSubjectHierarchyComboBox.h.

Constructor & Destructor Documentation

qMRMLSubjectHierarchyComboBox()

qMRMLSubjectHierarchyComboBox::qMRMLSubjectHierarchyComboBox

(

QWidget *

parent = 0

)

~qMRMLSubjectHierarchyComboBox()

virtual qMRMLSubjectHierarchyComboBox::~qMRMLSubjectHierarchyComboBox ( )

virtual

Member Function Documentation

alignPopupVertically()

bool qMRMLSubjectHierarchyComboBox::alignPopupVertically

(

)

const

clearSelection()

Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::clearSelection

(

)

currentItem()

Q_INVOKABLE vtkIdType qMRMLSubjectHierarchyComboBox::currentItem

(

)

const

currentItemChanged

void qMRMLSubjectHierarchyComboBox::currentItemChanged ( vtkIdType  )

signal

currentItemModified

void qMRMLSubjectHierarchyComboBox::currentItemModified ( vtkIdType  )

signal

highlightReferencedItems()

bool qMRMLSubjectHierarchyComboBox::highlightReferencedItems

(

)

const

maximumNumberOfShownItems()

int qMRMLSubjectHierarchyComboBox::maximumNumberOfShownItems

(

)

const

model()

Q_INVOKABLE qMRMLSubjectHierarchyModel* qMRMLSubjectHierarchyComboBox::model

(

)

const

mousePressEvent()

virtual void qMRMLSubjectHierarchyComboBox::mousePressEvent ( QMouseEvent *  event )

protectedvirtual

Handle mouse press event (disable context menu)

mrmlScene()

Q_INVOKABLE vtkMRMLScene* qMRMLSubjectHierarchyComboBox::mrmlScene

(

)

const

removeAttributeFilter()

Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::removeAttributeFilter

(

)

Remove item attribute filtering.

See also

setAttribute

rootItem()

Q_INVOKABLE vtkIdType qMRMLSubjectHierarchyComboBox::rootItem

(

)

const

setAlignPopupVertically()

void qMRMLSubjectHierarchyComboBox::setAlignPopupVertically

(

bool

align

)

setAttributeFilter()

Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::setAttributeFilter	(	const QString &	attributeName,
		const QVariant &	attributeValue = QVariant()
	)

Set attribute filter that allows showing only items that have the specified attribute and their parents.

Parameters

attributeName	Name of the attribute by which the items are filtered
attributeValue	Value of the specified attribute that needs to match this given value in order for it to be shown. If empty, then existence of the attribute is enough to show. Empty by default

setCurrentItem

virtual void qMRMLSubjectHierarchyComboBox::setCurrentItem ( vtkIdType  itemID )

virtualslot

Set current (=selected) subject hierarchy item.

setHighlightReferencedItems()

void qMRMLSubjectHierarchyComboBox::setHighlightReferencedItems

(

bool

highlightOn

)

setLevelFilter()

Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::setLevelFilter

(

QString &

levelFilter

)

Set level filter that allows showing only items at a specified level and their parents. Show all items if empty.

setMaximumNumberOfShownItems()

void qMRMLSubjectHierarchyComboBox::setMaximumNumberOfShownItems

(

int

maxNumberOfShownItems

)

setMRMLScene

virtual void qMRMLSubjectHierarchyComboBox::setMRMLScene ( vtkMRMLScene *  scene )

virtualslot

Set MRML scene.

setRootItem

virtual void qMRMLSubjectHierarchyComboBox::setRootItem ( vtkIdType  itemID )

virtualslot

Set subject hierarchy item to be the root in the shown tree.

setShowRootItem()

void qMRMLSubjectHierarchyComboBox::setShowRootItem

(

bool

show

)

showPopup()

virtual void qMRMLSubjectHierarchyComboBox::showPopup ( )

virtual

Provides customized popup window for the tree view.

showRootItem()

bool qMRMLSubjectHierarchyComboBox::showRootItem

(

)

const

sortFilterProxyModel()

Q_INVOKABLE qMRMLSortFilterSubjectHierarchyProxyModel* qMRMLSubjectHierarchyComboBox::sortFilterProxyModel

(

)

const

subjectHierarchyNode()

Q_INVOKABLE vtkMRMLSubjectHierarchyNode* qMRMLSubjectHierarchyComboBox::subjectHierarchyNode

(

)

const

updateComboBoxTitleAndIcon

void qMRMLSubjectHierarchyComboBox::updateComboBoxTitleAndIcon ( vtkIdType  selectedShItemID )

protectedslot

Member Data Documentation

d_ptr

QScopedPointer<qMRMLSubjectHierarchyComboBoxPrivate> qMRMLSubjectHierarchyComboBox::d_ptr

protected

Definition at line 125 of file qMRMLSubjectHierarchyComboBox.h.

---

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

• Modules/Loadable/SubjectHierarchy/Widgets/qMRMLSubjectHierarchyComboBox.h