Base class for property observers providing callbacks for property changes and deletion. More...
#include <mitkPropertyObserver.h>
Public Member Functions | |
| PropertyObserver () | |
| Constructor. More... | |
| virtual | ~PropertyObserver () |
| Virtual destructor. More... | |
| virtual void | PropertyChanged ()=0 |
| Called when the observed property value has changed. More... | |
| virtual void | PropertyRemoved ()=0 |
| Called when the observed property is about to be deleted. More... | |
Protected Member Functions | |
| void | BeginModifyProperty () |
| Marks the beginning of a self-initiated property modification. More... | |
| void | EndModifyProperty () |
| Marks the end of a self-initiated property modification. More... | |
Protected Attributes | |
| unsigned long | m_ModifiedTag |
| ITK observer tag for the ModifiedEvent. More... | |
| unsigned long | m_DeleteTag |
| ITK observer tag for the DeleteEvent. More... | |
| bool | m_SelfCall |
| Guard flag to prevent re-entrant notification. More... | |
Detailed Description
Base class for property observers providing callbacks for property changes and deletion.
This class provides a guard mechanism (m_SelfCall) to prevent re-entrant notifications when the observer itself modifies the property.
- See also
- PropertyView
- PropertyEditor
- BaseProperty
Definition at line 45 of file mitkPropertyObserver.h.
Constructor & Destructor Documentation
◆ PropertyObserver()
| mitk::PropertyObserver::PropertyObserver | ( | ) |
Constructor.
◆ ~PropertyObserver()
|
virtual |
Virtual destructor.
Member Function Documentation
◆ BeginModifyProperty()
|
protected |
Marks the beginning of a self-initiated property modification.
Call this before modifying the observed property from within the observer to suppress recursive notification callbacks.
◆ EndModifyProperty()
|
protected |
Marks the end of a self-initiated property modification.
◆ PropertyChanged()
|
pure virtual |
Called when the observed property value has changed.
Implemented in QmitkStringPropertyView, QmitkStringPropertyOnDemandEdit, QmitkStringPropertyEditor, QmitkNumberPropertyView, QmitkNumberPropertyEditor, QmitkColorPropertyView, and QmitkBasePropertyView.
◆ PropertyRemoved()
|
pure virtual |
Called when the observed property is about to be deleted.
Implemented in QmitkStringPropertyView, QmitkStringPropertyOnDemandEdit, QmitkStringPropertyEditor, QmitkNumberPropertyView, QmitkNumberPropertyEditor, QmitkColorPropertyView, and QmitkBasePropertyView.
Member Data Documentation
◆ m_DeleteTag
|
protected |
ITK observer tag for the DeleteEvent.
Definition at line 72 of file mitkPropertyObserver.h.
◆ m_ModifiedTag
|
protected |
ITK observer tag for the ModifiedEvent.
Definition at line 71 of file mitkPropertyObserver.h.
◆ m_SelfCall
|
protected |
Guard flag to prevent re-entrant notification.
Definition at line 74 of file mitkPropertyObserver.h.
The documentation for this class was generated from the following file:
