mitk::DisplayActionEventHandlerSynchronized Class Reference
#include <mitkDisplayActionEventHandlerSynchronized.h>
Inheritance diagram for mitk::DisplayActionEventHandlerSynchronized:
Collaboration diagram for mitk::DisplayActionEventHandlerSynchronized:
Protected Member Functions | |
| void | InitActionsImpl () override |
| Initializes common synchronized display actions by using the synchronized display action event functions. More... | |
Additional Inherited Members | |
 Public Types inherited from mitk::DisplayActionEventHandler | |
| using | OberserverTagType = unsigned long |
| Public Member Functions inherited from mitk::DisplayActionEventHandler | |
| virtual | ~DisplayActionEventHandler () |
| void | SetObservableBroadcast (DisplayActionEventBroadcast *observableBroadcast) |
| Sets the display action event broadcast class that should be observed. This class receives events from the given broadcast class and triggers the "corresponding functions" to perform the custom actions. "Corresponding functions" are std::functions inside commands that observe the specific display action event. More... | |
| OberserverTagType | ConnectDisplayActionEvent (const DisplayActionEvent &displayActionEvent, const StdFunctionCommand::ActionFunction &actionFunction, const StdFunctionCommand::FilterFunction &filterFunction=[](const itk::EventObject &) { return true;}) |
| Uses the given std::functions to customize a command: The display action event is used to define on which event the command should react. The display action event broadcast class member is then observed by the newly created command. A tag for the command is returned and stored in a member vector. More... | |
| void | DisconnectObserver (OberserverTagType observerTag) |
| Uses the given observer tag to remove the corresponding custom command as an observer of the observed display action event broadcast class. If the given tag is not contained in the member vector of observer tags, nothing happens. More... | |
| const std::vector< OberserverTagType > & | GetAllObserverTags () |
| void | InitActions () |
| This function can be used by sub-classes to initialize a set of pre-defined DisplayActionEventFunctions and connect them to the observable broadcast member. In order to customize a sub-class behavior this function calls the virtual function InitActionsImpl. All currently connected display action events will be removed as observer from the broadcast instance. More... | |
| Protected Attributes inherited from mitk::DisplayActionEventHandler | |
| WeakPointer< DisplayActionEventBroadcast > | m_ObservableBroadcast |
| std::vector< OberserverTagType > | m_ObserverTags |
Detailed Description
Definition at line 23 of file mitkDisplayActionEventHandlerSynchronized.h.
Member Function Documentation
◆ InitActionsImpl()
|
overrideprotectedvirtual |
Initializes common synchronized display actions by using the synchronized display action event functions.
- Precondition
- The class' observable (the display action event broadcast) has to be set to connect display events.
- Exceptions
-
mitk::Exception,if the class' observable is null.
Reimplemented from mitk::DisplayActionEventHandler.
The documentation for this class was generated from the following file:
