QmitkProgressBar Class Reference

Qt implementation of the MITK progress bar interface. More...

#include <QmitkProgressBar.h>

Inheritance diagram for QmitkProgressBar:

Collaboration diagram for QmitkProgressBar:

Signals
void	SignalAddStepsToDo (unsigned int steps)
	Internal signal to dispatch AddStepsToDo to the GUI thread. More...
void	SignalProgress (unsigned int steps)
	Internal signal to dispatch Progress to the GUI thread. More...
void	SignalSetPercentageVisible (bool visible)
	Internal signal to dispatch SetPercentageVisible to the GUI thread. More...

Public Member Functions
	QmitkProgressBar (QWidget *parent=nullptr, const char *name=nullptr)
	Constructs the progress bar and registers it with mitk::ProgressBar. More...
	~QmitkProgressBar () override
void	SetPercentageVisible (bool visible) override
	Sets whether the percentage text is displayed on the progress bar. More...
void	AddStepsToDo (unsigned int steps) override
	Adds the given number of steps to the total step count. More...
void	Progress (unsigned int steps) override
	Advances the progress by the given number of steps. More...
Public Member Functions inherited from mitk::ProgressBarImplementation
	ProgressBarImplementation ()
	Constructor. More...
virtual	~ProgressBarImplementation ()
	Destructor. More...

Protected Slots
virtual void	SlotAddStepsToDo (unsigned int steps)
virtual void	SlotProgress (unsigned int steps)
virtual void	SlotSetPercentageVisible (bool visible)

Detailed Description

Qt implementation of the MITK progress bar interface.

This class provides a Qt QProgressBar that implements the mitk::ProgressBarImplementation interface. It registers itself with mitk::ProgressBar so that all MITK classes can report progress through mitk::ProgressBar::GetInstance().

Thread safety is achieved by using signal/slot connections: the public interface methods emit signals that are dispatched to the GUI thread.

See also

mitk::ProgressBar

mitk::ProgressBarImplementation

Definition at line 36 of file QmitkProgressBar.h.

Constructor & Destructor Documentation

QmitkProgressBar()

QmitkProgressBar::QmitkProgressBar	(	QWidget *	parent = nullptr,
		const char *	name = nullptr
	)

Constructs the progress bar and registers it with mitk::ProgressBar.

Parameters

[in]	parent	Optional parent widget.
[in]	name	Optional object name (unused, kept for compatibility).

~QmitkProgressBar()

QmitkProgressBar::~QmitkProgressBar ( )

override

Member Function Documentation

AddStepsToDo()

void QmitkProgressBar::AddStepsToDo ( unsigned int  steps )

overridevirtual

Adds the given number of steps to the total step count.

Parameters

[in]

steps

The number of steps to add.

Implements mitk::ProgressBarImplementation.

Progress()

void QmitkProgressBar::Progress ( unsigned int  steps )

overridevirtual

Advances the progress by the given number of steps.

When the progress reaches the total, the bar is automatically reset.

Parameters

[in]

steps

The number of steps completed since the last call.

Implements mitk::ProgressBarImplementation.

SetPercentageVisible()

void QmitkProgressBar::SetPercentageVisible ( bool  visible )

overridevirtual

Sets whether the percentage text is displayed on the progress bar.

Parameters

[in]

visible

True to show percentage, false to hide it.

Implements mitk::ProgressBarImplementation.

SignalAddStepsToDo

void QmitkProgressBar::SignalAddStepsToDo ( unsigned int  steps )

signal

Internal signal to dispatch AddStepsToDo to the GUI thread.

SignalProgress

void QmitkProgressBar::SignalProgress ( unsigned int  steps )

signal

Internal signal to dispatch Progress to the GUI thread.

SignalSetPercentageVisible

void QmitkProgressBar::SignalSetPercentageVisible ( bool  visible )

signal

Internal signal to dispatch SetPercentageVisible to the GUI thread.

SlotAddStepsToDo

virtual void QmitkProgressBar::SlotAddStepsToDo ( unsigned int  steps )

protectedvirtualslot

SlotProgress

virtual void QmitkProgressBar::SlotProgress ( unsigned int  steps )

protectedvirtualslot

SlotSetPercentageVisible

virtual void QmitkProgressBar::SlotSetPercentageVisible ( bool  visible )

protectedvirtualslot

---

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

• QmitkProgressBar.h