Slicer
5.1
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
|
#include <Modules/Loadable/SubjectHierarchy/Widgets/qMRMLSubjectHierarchyComboBox.h>
Public Types | |
typedef ctkComboBox | Superclass |
Properties | |
bool | alignPopupVertically |
QString | attributeNameFilter |
QString | attributeValueFilter |
QStringList | excludeItemAttributeNamesFilter |
QStringList | excludeNodeAttributeNamesFilter |
bool | highlightReferencedItems |
QStringList | includeItemAttributeNamesFilter |
Filter to show only items that contain any of the given attributes with this name. Empty by default. More... | |
QStringList | includeNodeAttributeNamesFilter |
Filter to show only items for data nodes that contain any of the given attributes with this name. Empty by default. More... | |
int | maximumNumberOfShownItems |
Property determining the maximum number of items (rows) shown in the popup tree. More... | |
QString | noneDisplay |
bool | noneEnabled |
bool | showCurrentItemParents |
bool | showEmptyHierarchyItems |
bool | showRootItem |
Public Slots | |
void | disablePlugin (QString plugin) |
void | setAttributeNameFilter (QString &filter) |
void | setAttributeValueFilter (QString &filter) |
virtual void | setCurrentItem (vtkIdType itemID) |
Set current (=selected) subject hierarchy item. More... | |
void | setExcludeItemAttributeNamesFilter (QStringList filter) |
void | setExcludeNodeAttributeNamesFilter (QStringList filter) |
void | setIncludeItemAttributeNamesFilter (QStringList filter) |
void | setIncludeNodeAttributeNamesFilter (QStringList filter) |
virtual void | setMRMLScene (vtkMRMLScene *scene) |
Set MRML scene. More... | |
void | setPluginBlacklist (QStringList blacklist) |
void | setPluginWhitelist (QStringList whitelist) |
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 | |
Q_INVOKABLE void | addItemAttributeFilter (QString attributeName, QVariant attributeValue=QString(), bool include=true) |
Q_INVOKABLE void | addNodeAttributeFilter (QString attributeName, QVariant attributeValue=QString(), bool include=true, QString className=QString()) |
bool | alignPopupVertically () const |
QString | attributeNameFilter () const |
QString | attributeValueFilter () const |
Q_INVOKABLE void | clearSelection () |
Q_INVOKABLE vtkIdType | currentItem () const |
QStringList | excludeItemAttributeNamesFilter () const |
QStringList | excludeNodeAttributeNamesFilter () const |
bool | highlightReferencedItems () const |
QStringList | includeItemAttributeNamesFilter () const |
QStringList | includeNodeAttributeNamesFilter () const |
int | maximumNumberOfShownItems () const |
Q_INVOKABLE qMRMLSubjectHierarchyModel * | model () const |
Q_INVOKABLE vtkMRMLScene * | mrmlScene () const |
QString | noneDisplay () const |
bool | noneEnabled () const |
qMRMLSubjectHierarchyComboBox (QWidget *parent=nullptr) | |
Q_INVOKABLE void | removeItemAttributeFilter (QString attributeName, QVariant attributeValue, bool include) |
Remove single item attribute filter specifying each attribute. More... | |
Q_INVOKABLE void | removeItemAttributeFilter (QString attributeName, bool include) |
Remove all item attribute filters specifying a given attribute name and include flag. More... | |
Q_INVOKABLE void | removeNodeAttributeFilter (QString attributeName, QVariant attributeValue, bool include, QString className) |
Remove single node attribute filter specifying each attribute. More... | |
Q_INVOKABLE void | removeNodeAttributeFilter (QString attributeName, bool include) |
Remove all node attribute filters specifying a given attribute name and include flag. More... | |
Q_INVOKABLE vtkIdType | rootItem () const |
void | setAlignPopupVertically (bool align) |
Q_INVOKABLE void | setHideChildNodeTypes (const QStringList &types) |
void | setHighlightReferencedItems (bool highlightOn) |
Q_INVOKABLE void | setLevelFilter (QStringList &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) |
Q_INVOKABLE void | setNodeTypes (const QStringList &types) |
Set node type filter that allows showing only data nodes of a certain type. Show all data nodes if empty. More... | |
void | setNoneDisplay (const QString &displayName) |
void | setNoneEnabled (bool enable) |
void | setShowCurrentItemParents (bool enable) |
void | setShowEmptyHierarchyItems (bool show) |
void | setShowRootItem (bool show) |
bool | showCurrentItemParents () const |
bool | showEmptyHierarchyItems () const |
void | showPopup () override |
Provides customized popup window for the tree view. More... | |
bool | showRootItem () const |
Q_INVOKABLE qMRMLSortFilterSubjectHierarchyProxyModel * | sortFilterProxyModel () const |
Q_INVOKABLE vtkMRMLSubjectHierarchyNode * | subjectHierarchyNode () const |
~qMRMLSubjectHierarchyComboBox () override | |
Protected Slots | |
void | hidePopup () override |
virtual void | onMRMLSceneCloseEnded (vtkObject *sceneObject) |
void | updateComboBoxTitleAndIcon (vtkIdType selectedShItemID) |
Protected Member Functions | |
void | mousePressEvent (QMouseEvent *event) override |
Handle mouse press event (disable context menu) More... | |
Protected Attributes | |
QScopedPointer< qMRMLSubjectHierarchyComboBoxPrivate > | d_ptr |
Definition at line 41 of file qMRMLSubjectHierarchyComboBox.h.
typedef ctkComboBox qMRMLSubjectHierarchyComboBox::Superclass |
Definition at line 99 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Property determining the vertical alignment 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 60 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to show only items that contain an attribute with this name. Empty by default Note: Deprecated, kept only for backwards compatibility. Sets and returns the first attribute in
Definition at line 91 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to show only items that contain any attribute given in
Definition at line 96 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to hide items that contain any of the given attributes with this name. Empty by default Overrides
Definition at line 84 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to hide items for data nodes that contain any of the given attributes with this name. Empty by default Overrides
Definition at line 87 of file qMRMLSubjectHierarchyComboBox.h.
|
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 54 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to show only items that contain any of the given attributes with this name. Empty by default.
Definition at line 79 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Filter to show only items for data nodes that contain any of the given attributes with this name. Empty by default.
Definition at line 81 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Property determining the maximum number of items (rows) shown in the popup tree.
Definition at line 56 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
This property controls the name that is displayed for the None item. "None" by default.
Definition at line 67 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
This property controls whether an extra item is added before any subject hierarchy item under the scene item for indicating 'None' selection.
Definition at line 63 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
This property controls whether hierarchy information is included in the current item text (showed when collapsed). If enabled (which is the default), then the text looks like "[ParentName] / [ParentName] / [SelectedItemName]". If disabled, the title will only be "[SelectedItemName]".
Definition at line 71 of file qMRMLSubjectHierarchyComboBox.h.
|
readwrite |
Show hierarchy items (items without data node such as patient/study/folder) that have no children to show according to the filters. This is most useful to in off state keep combobox content reasonable size for selecting data nodes. True by default.
Definition at line 76 of file qMRMLSubjectHierarchyComboBox.h.
|
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.
Definition at line 50 of file qMRMLSubjectHierarchyComboBox.h.
qMRMLSubjectHierarchyComboBox::qMRMLSubjectHierarchyComboBox | ( | QWidget * | parent = nullptr | ) |
|
override |
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::addItemAttributeFilter | ( | QString | attributeName, |
QVariant | attributeValue = QString() , |
||
bool | include = true |
||
) |
Add single item attribute filter specifying attribute name, value, include/exclude, and class name
attributeName | Name of the item attribute to filter |
attributeValue | Value of the item attribute to filter |
include | Flag indicating whether this is an include filter or exclude filter.
|
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::addNodeAttributeFilter | ( | QString | attributeName, |
QVariant | attributeValue = QString() , |
||
bool | include = true , |
||
QString | className = QString() |
||
) |
Add single node attribute filter specifying attribute name, value, include/exclude, and class name
attributeName | Name of the node attribute to filter |
attributeValue | Value of the node attribute to filter |
include | Flag indicating whether this is an include filter or exclude filter.
|
className | Only filter attributes on a certain type. Empty by default (i.e. allow all classes) |
bool qMRMLSubjectHierarchyComboBox::alignPopupVertically | ( | ) | const |
QString qMRMLSubjectHierarchyComboBox::attributeNameFilter | ( | ) | const |
QString qMRMLSubjectHierarchyComboBox::attributeValueFilter | ( | ) | const |
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::clearSelection | ( | ) |
Q_INVOKABLE vtkIdType qMRMLSubjectHierarchyComboBox::currentItem | ( | ) | const |
|
signal |
|
signal |
|
slot |
Disable subject hierarchy plugin by adding it to the blacklist
plugin | Name of the plugin to disable |
QStringList qMRMLSubjectHierarchyComboBox::excludeItemAttributeNamesFilter | ( | ) | const |
QStringList qMRMLSubjectHierarchyComboBox::excludeNodeAttributeNamesFilter | ( | ) | const |
|
overrideprotectedslot |
bool qMRMLSubjectHierarchyComboBox::highlightReferencedItems | ( | ) | const |
QStringList qMRMLSubjectHierarchyComboBox::includeItemAttributeNamesFilter | ( | ) | const |
QStringList qMRMLSubjectHierarchyComboBox::includeNodeAttributeNamesFilter | ( | ) | const |
int qMRMLSubjectHierarchyComboBox::maximumNumberOfShownItems | ( | ) | const |
Q_INVOKABLE qMRMLSubjectHierarchyModel* qMRMLSubjectHierarchyComboBox::model | ( | ) | const |
|
overrideprotected |
Handle mouse press event (disable context menu)
Q_INVOKABLE vtkMRMLScene* qMRMLSubjectHierarchyComboBox::mrmlScene | ( | ) | const |
QString qMRMLSubjectHierarchyComboBox::noneDisplay | ( | ) | const |
bool qMRMLSubjectHierarchyComboBox::noneEnabled | ( | ) | const |
|
protectedvirtualslot |
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::removeItemAttributeFilter | ( | QString | attributeName, |
QVariant | attributeValue, | ||
bool | include | ||
) |
Remove single item attribute filter specifying each attribute.
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::removeItemAttributeFilter | ( | QString | attributeName, |
bool | include | ||
) |
Remove all item attribute filters specifying a given attribute name and include flag.
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::removeNodeAttributeFilter | ( | QString | attributeName, |
QVariant | attributeValue, | ||
bool | include, | ||
QString | className | ||
) |
Remove single node attribute filter specifying each attribute.
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::removeNodeAttributeFilter | ( | QString | attributeName, |
bool | include | ||
) |
Remove all node attribute filters specifying a given attribute name and include flag.
Q_INVOKABLE vtkIdType qMRMLSubjectHierarchyComboBox::rootItem | ( | ) | const |
void qMRMLSubjectHierarchyComboBox::setAlignPopupVertically | ( | bool | align | ) |
|
slot |
|
slot |
|
virtualslot |
Set current (=selected) subject hierarchy item.
|
slot |
|
slot |
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::setHideChildNodeTypes | ( | const QStringList & | types | ) |
Set child node types filter that allows hiding certain data node subclasses that would otherwise be accepted by the data node type filter. Show all data nodes if empty
void qMRMLSubjectHierarchyComboBox::setHighlightReferencedItems | ( | bool | highlightOn | ) |
|
slot |
|
slot |
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::setLevelFilter | ( | QStringList & | levelFilter | ) |
Set level filter that allows showing only items at a specified level and their parents. Show all items if empty.
void qMRMLSubjectHierarchyComboBox::setMaximumNumberOfShownItems | ( | int | maxNumberOfShownItems | ) |
|
virtualslot |
Set MRML scene.
Q_INVOKABLE void qMRMLSubjectHierarchyComboBox::setNodeTypes | ( | const QStringList & | types | ) |
Set node type filter that allows showing only data nodes of a certain type. Show all data nodes if empty.
void qMRMLSubjectHierarchyComboBox::setNoneDisplay | ( | const QString & | displayName | ) |
void qMRMLSubjectHierarchyComboBox::setNoneEnabled | ( | bool | enable | ) |
|
slot |
Set list of subject hierarchy plugins that are disabled.
blacklist | List of blacklisted subject hierarchy plugin names. Empty blacklist means all plugins are enabled. That is the default. |
|
slot |
Set list of subject hierarchy plugins that are enabled.
whitelist | List of whitelisted subject hierarchy plugin names. Empty whitelist means all plugins are enabled. That is the default. |
|
virtualslot |
Set subject hierarchy item to be the root in the shown tree.
void qMRMLSubjectHierarchyComboBox::setShowCurrentItemParents | ( | bool | enable | ) |
void qMRMLSubjectHierarchyComboBox::setShowEmptyHierarchyItems | ( | bool | show | ) |
void qMRMLSubjectHierarchyComboBox::setShowRootItem | ( | bool | show | ) |
bool qMRMLSubjectHierarchyComboBox::showCurrentItemParents | ( | ) | const |
bool qMRMLSubjectHierarchyComboBox::showEmptyHierarchyItems | ( | ) | const |
|
override |
Provides customized popup window for the tree view.
bool qMRMLSubjectHierarchyComboBox::showRootItem | ( | ) | const |
Q_INVOKABLE qMRMLSortFilterSubjectHierarchyProxyModel* qMRMLSubjectHierarchyComboBox::sortFilterProxyModel | ( | ) | const |
Q_INVOKABLE vtkMRMLSubjectHierarchyNode* qMRMLSubjectHierarchyComboBox::subjectHierarchyNode | ( | ) | const |
|
protectedslot |
|
protected |
Definition at line 228 of file qMRMLSubjectHierarchyComboBox.h.