MITK-IGT
IGT Extension of MITK
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
QmitkUSNavigationAbstractSettingsWidget Class Referenceabstract

Abstract class of settings widgets used by the QmitkUSNavigationProcessWidget. This class handles the emitting of Saved(), Canceled() and SettingsChanged() signals and provides slots for save and cancel buttons. More...

#include <QmitkUSNavigationAbstractSettingsWidget.h>

Inheritance diagram for QmitkUSNavigationAbstractSettingsWidget:
QmitkUSNavigationCombinedSettingsWidget

Signals

void Saved ()
 
void Canceled ()
 
void SettingsChanged (itk::SmartPointer< mitk::DataNode >)
 

Public Member Functions

 QmitkUSNavigationAbstractSettingsWidget (QWidget *parent=nullptr)
 
 ~QmitkUSNavigationAbstractSettingsWidget () override
 
void LoadSettings ()
 Loads the settings. The actual loading is done by calling the OnLoadSettingsProcessing() method.
 
void SetSettingsNode (itk::SmartPointer< mitk::DataNode > settingsNode, bool overwriteValues=false)
 Setter for the data node in which the settings are loaded. The settings are made available as properties of this data node.
 
itk::SmartPointer< mitk::DataNode > GetSettingsNode ()
 

Protected Slots

void OnSave ()
 Triggers the saving of the current settings. OnSaveProcessing() is called and the Saved() signal is emitted afterwards.
 
void OnCancel ()
 Ends the settings changing process without saving the changes. OnCancelProcessing() is called and the Canceled() signal is emitted afterwards.
 

Protected Member Functions

virtual void OnSetSettingsNode (itk::SmartPointer< mitk::DataNode > settingsNode, bool overwriteValues)=0
 Method for handling the setting of a new settings node. This method has to be implemented by a concrete subclass.
 
virtual void OnSaveProcessing ()=0
 Method for actually saving the settings. This method has to be implemented by a concrete subclass.
 
virtual void OnCancelProcessing ()
 Method for handling the cancel process. This method can be implemented by a concrete subclass. An empty default implementation exists.
 
virtual void OnLoadSettingsProcessing ()=0
 Method for actually loading the settings. This method has to be implemented by a concrete subclass.
 

Detailed Description

Abstract class of settings widgets used by the QmitkUSNavigationProcessWidget. This class handles the emitting of Saved(), Canceled() and SettingsChanged() signals and provides slots for save and cancel buttons.

The actual saving and loading of settings is delegated to concrete subclasses which should therefore implement OnSetSettingsNode(), OnSaveProcessing(), OnCancelProcessing(), OnLoadSettingsProcessing().

Definition at line 28 of file QmitkUSNavigationAbstractSettingsWidget.h.

Constructor & Destructor Documentation

◆ QmitkUSNavigationAbstractSettingsWidget()

QmitkUSNavigationAbstractSettingsWidget::QmitkUSNavigationAbstractSettingsWidget ( QWidget * parent = nullptr)
explicit

Definition at line 21 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ ~QmitkUSNavigationAbstractSettingsWidget()

QmitkUSNavigationAbstractSettingsWidget::~QmitkUSNavigationAbstractSettingsWidget ( )
override

Definition at line 26 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

Member Function Documentation

◆ Canceled

void QmitkUSNavigationAbstractSettingsWidget::Canceled ( )
signal

◆ GetSettingsNode()

itk::SmartPointer< mitk::DataNode > QmitkUSNavigationAbstractSettingsWidget::GetSettingsNode ( )

Definition at line 44 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ LoadSettings()

void QmitkUSNavigationAbstractSettingsWidget::LoadSettings ( )

Loads the settings. The actual loading is done by calling the OnLoadSettingsProcessing() method.

Definition at line 30 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ OnCancel

void QmitkUSNavigationAbstractSettingsWidget::OnCancel ( )
protectedslot

Ends the settings changing process without saving the changes. OnCancelProcessing() is called and the Canceled() signal is emitted afterwards.

Definition at line 57 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ OnCancelProcessing()

virtual void QmitkUSNavigationAbstractSettingsWidget::OnCancelProcessing ( )
inlineprotectedvirtual

Method for handling the cancel process. This method can be implemented by a concrete subclass. An empty default implementation exists.

Definition at line 87 of file QmitkUSNavigationAbstractSettingsWidget.h.

◆ OnLoadSettingsProcessing()

virtual void QmitkUSNavigationAbstractSettingsWidget::OnLoadSettingsProcessing ( )
protectedpure virtual

Method for actually loading the settings. This method has to be implemented by a concrete subclass.

Implemented in QmitkUSNavigationCombinedSettingsWidget.

◆ OnSave

void QmitkUSNavigationAbstractSettingsWidget::OnSave ( )
protectedslot

Triggers the saving of the current settings. OnSaveProcessing() is called and the Saved() signal is emitted afterwards.

Definition at line 49 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ OnSaveProcessing()

virtual void QmitkUSNavigationAbstractSettingsWidget::OnSaveProcessing ( )
protectedpure virtual

Method for actually saving the settings. This method has to be implemented by a concrete subclass.

Implemented in QmitkUSNavigationCombinedSettingsWidget.

◆ OnSetSettingsNode()

virtual void QmitkUSNavigationAbstractSettingsWidget::OnSetSettingsNode ( itk::SmartPointer< mitk::DataNode > settingsNode,
bool overwriteValues )
protectedpure virtual

Method for handling the setting of a new settings node. This method has to be implemented by a concrete subclass.

Implemented in QmitkUSNavigationCombinedSettingsWidget.

◆ Saved

void QmitkUSNavigationAbstractSettingsWidget::Saved ( )
signal

◆ SetSettingsNode()

void QmitkUSNavigationAbstractSettingsWidget::SetSettingsNode ( itk::SmartPointer< mitk::DataNode > settingsNode,
bool overwriteValues = false )

Setter for the data node in which the settings are loaded. The settings are made available as properties of this data node.

Definition at line 35 of file QmitkUSNavigationAbstractSettingsWidget.cpp.

◆ SettingsChanged

void QmitkUSNavigationAbstractSettingsWidget::SettingsChanged ( itk::SmartPointer< mitk::DataNode > )
signal

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