MeVisLab Scripting Reference
MLABNetworkModelItemGroup Class Reference

#include <mlabNetworkModelItemGroup.h>

Inherits MLABNetworkModelItem.

Scripting methods

QString groupName () const
 
bool setGroupName (const QString &name)
 
QColor backgroundColor () const
 
void setBackgroundColor (const QColor &color)
 
void remove ()
 
void rename ()
 
QList< MLABModule * > modules ()
 

Additional Inherited Members

- Public Slots inherited from MLABNetworkModelItem
virtual void translateFrame (const QPoint &delta, bool notifyParent=true)
 
void translateChildrenFrames (const QPoint &delta, bool selectedOnly, bool notifyParent=true)
 
virtual void setFrame (const QRect &frame, bool notifyParent=true)
 
virtual QRect frame () const
 
- Public Member Functions inherited from MLABNetworkModelItem
void addNetworkModelItemListener (MLABNetworkModelItemListener *listener)
 
void removeNetworkModelItemListener (MLABNetworkModelItemListener *listener)
 
MLABNetworkModelItemgetChildItemByUniqueId (const unsigned long uniqueId) const
 
void visitChildren (MLABNetworkModelItemVisitor *visitor)
 
template<typename T >
bool containsItemType ()
 
void getChildrenInFrame (QList< MLABNetworkModelItem * > &items, const QRect &frame, bool recursive) const
 
QRect getMinimumFrameOverChildren (bool selectedChildrenOnly, bool excludeUncountedItems=true) const
 
unsigned int numberOfChildItems () const
 
void updateChildrenFrames ()
 
virtual void snapToGrid ()
 
void snapSelectedChildrenToGrid ()
 
void invertSelection (bool noParentHasSelectedChildUpdate=false)
 
void invertChildrenSelection ()
 
bool isSelected () const
 
bool hasSelectedChild () const
 
void setChildrenSelected (bool selected, bool recursive=false)
 
void getSelectedChildren (QList< MLABNetworkModelItem * > &selectedChildren, bool recursive) const
 
MLABNetworkModelItemgetSingleSelectedChild () const
 
void setChildrenInFrameSelected (const QRect &frame, bool selected, bool recursive, bool toggle)
 
void getItemsInFrame (const QRect &frame, QList< MLABNetworkModelItem * > &items)
 
bool isSelectableByRectangularRegion () const
 
void removeSelectedChildItems (bool undoable)
 
bool hasChildItems () const
 
const QList< MLABNetworkModelItem * > & getChildItems () const
 
MLABNetworkModelItemparentItem () const
 
void setParentItem (MLABNetworkModelItem *parentItem)
 
MLABNetworkModelItemgetChildItemAt (const QPoint &position, bool recursive) const
 
void transferChildItemsToParent (bool undoable)
 
virtual void removeFromParentItemUndoable ()
 
virtual void storeToTree (MLABTree *treePtr, bool onlySelectedItems) const
 
virtual void storeChildItemsToTree (MLABTree *treePtr, bool selectedChildItemsOnly) const
 
virtual void loadFromTree (MLABTree *treePtr)
 
void setUniqueId (const unsigned long &id)
 
const unsigned long & uniqueId () const
 
const unsigned long & uniqueParentIdForLoading () const
 
bool isHighlighted () const
 
bool isSourceModule () const
 
bool isDestinationModule () const
 
void setIsHighlighted (bool highlighted, bool isSourceItem, bool isDestinationItem)
 
virtual bool isMouseOver () const
 
virtual void setIsMouseOver (bool mouseOver)
 
void unsetAllModuleHighlights ()
 
void unsetAllMouseOver ()
 
virtual MLABNetworkModel * networkModel () const
 
bool isGroupable () const
 
bool isFreeFromVisual ()
 
virtual bool isNote ()
 
bool hasChildFrameChanged ()
 
QRgb getHaloColor ()
 
virtual void updateAllVisuals ()
 
- Protected Member Functions inherited from MLABNetworkModelItem
void notifyListenersVisibilityChanged (bool isVisible)
 
void updateHasSelectedChild ()
 
- Protected Attributes inherited from MLABNetworkModelItem
QRect _frame
 
MLABNetworkModel * _networkModel
 
bool _isSelected
 
MLABNetworkModelItemList _childrenList
 
MLABNetworkModelItem_parentItem
 
unsigned long _uniqueId
 
unsigned long _parentUniqueIDForLoading
 
bool _hasSelectedChild
 
bool _isSelectableByRectangularRegion
 
bool _isGroupable
 
bool _isHighlighted
 
bool _isSourceItem
 
bool _isDestinationItem
 
bool _isMouseOver
 
bool _isFreeFromVisual
 
bool _childFrameHasChanged
 
QList< MLABNetworkModelItemListener * > _networkModelItemListenerList
 

Detailed Description

This class groups groupable network model items.

Member Function Documentation

◆ backgroundColor

QColor MLABNetworkModelItemGroup::backgroundColor ( ) const
inlineslot

Returns the group color.

◆ groupName

QString MLABNetworkModelItemGroup::groupName ( ) const
inlineslot

Returns the name of the group.

◆ modules

QList< MLABModule * > MLABNetworkModelItemGroup::modules ( )
slot

Returns the modules that are in this group.

◆ remove

void MLABNetworkModelItemGroup::remove ( )
slot

Removes the group (and put the modules/items to the main network).

◆ rename

void MLABNetworkModelItemGroup::rename ( )
slot

Renames the group with a dialog.

◆ setBackgroundColor

void MLABNetworkModelItemGroup::setBackgroundColor ( const QColor &  color)
inlineslot

Sets the group color.

◆ setGroupName

bool MLABNetworkModelItemGroup::setGroupName ( const QString &  name)
slot

Sets a new name for the group (returns false if the name is already used by another group and keeps the previous name).