MITK-IGT
IGT Extension of MITK
Loading...
Searching...
No Matches
Public Types | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QmitkUpdateTimerWidget Class Reference

QmitkUpdateTimerWidget. More...

#include <QmitkUpdateTimerWidget.h>

Inheritance 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
 
 ~QmitkUpdateTimerWidget () override
 default destructor
 
unsigned int GetTimerInterval ()
 This method returns the timer's timeout interval in msec.
 
void SetTimerInterval (unsigned int msec)
 This method sets the timer's timeout interval in msec.
 
void StartTimer ()
 This method starts the timer if it is not already active.
 
void StopTimer ()
 This method stops the timer if it is active at the moment.
 
QTimer * GetUpdateTimer ()
 This method returns this object's timer.
 
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.
 
void HideFramerateSettings (bool hidden)
 This method hides the framerate settings spinbox and her labels in the view.
 
void SetIcon (WidgetButtons button, const QIcon &icon)
 This method sets the icon for a specific button of the widget.
 

Protected Slots

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

Protected Member Functions

void CreateConnections ()
 
void CreateQtPartControl (QWidget *parent)
 

Protected Attributes

Ui::QmitkUpdateTimerWidgetControls * m_Controls
 gui widgets
 

Detailed Description

QmitkUpdateTimerWidget.

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

Definition at line 26 of file QmitkUpdateTimerWidget.h.

Member Enumeration Documentation

◆ WidgetButtons

enum QmitkUpdateTimerWidget::WidgetButtons
Enumerator
StartButton 
StopButton 

Definition at line 32 of file QmitkUpdateTimerWidget.h.

Constructor & Destructor Documentation

◆ QmitkUpdateTimerWidget()

QmitkUpdateTimerWidget::QmitkUpdateTimerWidget ( QWidget * parent)

default constructor

Definition at line 25 of file QmitkUpdateTimerWidget.cpp.

◆ ~QmitkUpdateTimerWidget()

QmitkUpdateTimerWidget::~QmitkUpdateTimerWidget ( )
override

default destructor

Definition at line 40 of file QmitkUpdateTimerWidget.cpp.

Member Function Documentation

◆ CreateConnections()

void QmitkUpdateTimerWidget::CreateConnections ( )
protected

Definition at line 60 of file QmitkUpdateTimerWidget.cpp.

◆ CreateQtPartControl()

void QmitkUpdateTimerWidget::CreateQtPartControl ( QWidget * parent)
protected

Definition at line 48 of file QmitkUpdateTimerWidget.cpp.

◆ DisableWidget

void QmitkUpdateTimerWidget::DisableWidget ( )
slot

Definition at line 162 of file QmitkUpdateTimerWidget.cpp.

◆ EnableWidget

void QmitkUpdateTimerWidget::EnableWidget ( )
slot

Definition at line 157 of file QmitkUpdateTimerWidget.cpp.

◆ GetTimerInterval()

unsigned int QmitkUpdateTimerWidget::GetTimerInterval ( )

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

Definition at line 67 of file QmitkUpdateTimerWidget.cpp.

◆ GetUpdateTimer()

QTimer * QmitkUpdateTimerWidget::GetUpdateTimer ( )

This method returns this object's timer.

Definition at line 112 of file QmitkUpdateTimerWidget.cpp.

◆ HideFramerateSettings()

void QmitkUpdateTimerWidget::HideFramerateSettings ( bool hidden)

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

Definition at line 149 of file QmitkUpdateTimerWidget.cpp.

◆ OnChangeTimerInterval

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 72 of file QmitkUpdateTimerWidget.cpp.

◆ OnStartTimer

void QmitkUpdateTimerWidget::OnStartTimer ( )
protectedslot

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

Definition at line 117 of file QmitkUpdateTimerWidget.cpp.

◆ OnStopTimer

void QmitkUpdateTimerWidget::OnStopTimer ( )
protectedslot

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

Definition at line 122 of file QmitkUpdateTimerWidget.cpp.

◆ SetIcon()

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

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

Definition at line 170 of file QmitkUpdateTimerWidget.cpp.

◆ SetPurposeLabelText()

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 128 of file QmitkUpdateTimerWidget.cpp.

◆ SetTimerInterval()

void QmitkUpdateTimerWidget::SetTimerInterval ( unsigned int msec)

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

Definition at line 78 of file QmitkUpdateTimerWidget.cpp.

◆ Started

void QmitkUpdateTimerWidget::Started ( )
signal

◆ StartTimer()

void QmitkUpdateTimerWidget::StartTimer ( )

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

Definition at line 84 of file QmitkUpdateTimerWidget.cpp.

◆ Stopped

void QmitkUpdateTimerWidget::Stopped ( )
signal

◆ StopTimer()

void QmitkUpdateTimerWidget::StopTimer ( )

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

Definition at line 98 of file QmitkUpdateTimerWidget.cpp.

Member Data Documentation

◆ m_Controls

Ui::QmitkUpdateTimerWidgetControls* QmitkUpdateTimerWidget::m_Controls
protected

gui widgets

Definition at line 120 of file QmitkUpdateTimerWidget.h.

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