Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
QmitkUpdateTimerWidget Class Reference

QmitkUpdateTimerWidget. More...

#include <QmitkUpdateTimerWidget.h>

Inheritance diagram for QmitkUpdateTimerWidget:
Collaboration diagram for QmitkUpdateTimerWidget:

Public Types

enum  WidgetButtons { StartButton, StopButton }
 

Public Slots

void EnableWidget ()
 
void DisableWidget ()
 

Signals

void Started ()
 
void Stopped ()
 

Public Member Functions

 QmitkUpdateTimerWidget (QWidget *parent)
 default constructor More...
 
virtual ~QmitkUpdateTimerWidget ()
 default destructor More...
 
unsigned int GetTimerInterval ()
 This method returns the timer's timeout interval in msec. More...
 
void SetTimerInterval (unsigned int msec)
 This method sets the timer's timeout interval in msec. More...
 
void StartTimer ()
 This method starts the timer if it is not already active. More...
 
void StopTimer ()
 This method stops the timer if it is active at the moment. More...
 
QTimer * GetUpdateTimer ()
 This method returns this object's timer. More...
 
void SetPurposeLabelText (QString text)
 This method sets the given QString for the purpose of this update timer e.g. if "Navigation" is given, the start and stop button will be labeled "Start Navigation" and "Stop Navigation". Furthermore the purpose description is used for the timer status label: "Navigation started ... " in this case. More...
 
void HideFramerateSettings (bool hidden)
 This method hides the framerate settings spinbox and her labels in the view. More...
 
void SetIcon (WidgetButtons button, const QIcon &icon)
 This method sets the icon for a specific button of the widget. More...
 

Protected Slots

void OnStartTimer ()
 This method is called when the start button is pressed. It starts the timer using StartTimer(). More...
 
void OnStopTimer ()
 This method is called when the stop button is pressed. It stops the timer using StopTimer(). More...
 
void OnChangeTimerInterval (int interval)
 This method is called when the value in the spinbox is changed. It updates the timer interval using SetTimerInterval( ). More...
 

Protected Member Functions

void CreateConnections ()
 
void CreateQtPartControl (QWidget *parent)
 

Protected Attributes

Ui::QmitkUpdateTimerWidgetControls * m_Controls
 gui widgets More...
 

Detailed Description

QmitkUpdateTimerWidget.

Widget for setting up and controlling an update timer in an IGT-Pipeline.

Definition at line 30 of file QmitkUpdateTimerWidget.h.

Member Enumeration Documentation

Enumerator
StartButton 
StopButton 

Definition at line 36 of file QmitkUpdateTimerWidget.h.

Constructor & Destructor Documentation

QmitkUpdateTimerWidget::QmitkUpdateTimerWidget ( QWidget *  parent)
QmitkUpdateTimerWidget::~QmitkUpdateTimerWidget ( )
virtual

default destructor

Definition at line 44 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

Member Function Documentation

void QmitkUpdateTimerWidget::CreateConnections ( )
protected
void QmitkUpdateTimerWidget::CreateQtPartControl ( QWidget *  parent)
protected

Definition at line 52 of file QmitkUpdateTimerWidget.cpp.

References CreateConnections(), and m_Controls.

Referenced by QmitkUpdateTimerWidget().

void QmitkUpdateTimerWidget::DisableWidget ( )
slot

Definition at line 166 of file QmitkUpdateTimerWidget.cpp.

References StopTimer().

Referenced by QmitkUpdateTimerWidget().

void QmitkUpdateTimerWidget::EnableWidget ( )
slot

Definition at line 161 of file QmitkUpdateTimerWidget.cpp.

unsigned int QmitkUpdateTimerWidget::GetTimerInterval ( )

This method returns the timer's timeout interval in msec.

Definition at line 71 of file QmitkUpdateTimerWidget.cpp.

QTimer * QmitkUpdateTimerWidget::GetUpdateTimer ( )

This method returns this object's timer.

Definition at line 116 of file QmitkUpdateTimerWidget.cpp.

void QmitkUpdateTimerWidget::HideFramerateSettings ( bool  hidden)

This method hides the framerate settings spinbox and her labels in the view.

Definition at line 153 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

void QmitkUpdateTimerWidget::OnChangeTimerInterval ( int  interval)
protectedslot

This method is called when the value in the spinbox is changed. It updates the timer interval using SetTimerInterval( ).

Definition at line 76 of file QmitkUpdateTimerWidget.cpp.

References SetTimerInterval().

Referenced by CreateConnections().

void QmitkUpdateTimerWidget::OnStartTimer ( )
protectedslot

This method is called when the start button is pressed. It starts the timer using StartTimer().

Definition at line 121 of file QmitkUpdateTimerWidget.cpp.

References StartTimer().

Referenced by CreateConnections().

void QmitkUpdateTimerWidget::OnStopTimer ( )
protectedslot

This method is called when the stop button is pressed. It stops the timer using StopTimer().

Definition at line 126 of file QmitkUpdateTimerWidget.cpp.

References StopTimer().

Referenced by CreateConnections().

void QmitkUpdateTimerWidget::SetIcon ( WidgetButtons  button,
const QIcon &  icon 
)

This method sets the icon for a specific button of the widget.

Definition at line 174 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, StartButton, and StopButton.

void QmitkUpdateTimerWidget::SetPurposeLabelText ( QString  text)

This method sets the given QString for the purpose of this update timer e.g. if "Navigation" is given, the start and stop button will be labeled "Start Navigation" and "Stop Navigation". Furthermore the purpose description is used for the timer status label: "Navigation started ... " in this case.

Definition at line 132 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

void QmitkUpdateTimerWidget::SetTimerInterval ( unsigned int  msec)

This method sets the timer's timeout interval in msec.

Definition at line 82 of file QmitkUpdateTimerWidget.cpp.

References m_Controls.

Referenced by OnChangeTimerInterval().

void QmitkUpdateTimerWidget::Started ( )
signal

Referenced by StartTimer().

void QmitkUpdateTimerWidget::StartTimer ( )

This method starts the timer if it is not already active.

Definition at line 88 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, and Started().

Referenced by OnStartTimer().

void QmitkUpdateTimerWidget::Stopped ( )
signal

Referenced by StopTimer().

void QmitkUpdateTimerWidget::StopTimer ( )

This method stops the timer if it is active at the moment.

Definition at line 102 of file QmitkUpdateTimerWidget.cpp.

References m_Controls, and Stopped().

Referenced by DisableWidget(), and OnStopTimer().

Member Data Documentation

Ui::QmitkUpdateTimerWidgetControls* QmitkUpdateTimerWidget::m_Controls
protected

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