mitk::ProgressBar Class Reference

Sending a message to the application's ProgressBar. More...

#include <mitkProgressBar.h>

Inheritance diagram for mitk::ProgressBar:

Collaboration diagram for mitk::ProgressBar:

Public Member Functions
virtual const char *	GetClassName () const
void	RegisterImplementationInstance (ProgressBarImplementation *implementation)
	Register a GUI-dependent ProgressBar implementation. More...
void	UnregisterImplementationInstance (ProgressBarImplementation *implementation)
	Unregister a previously registered ProgressBar implementation. More...
void	AddStepsToDo (unsigned int steps)
	Adds steps to the total number of steps to do. More...
void	Reset ()
	Explicitly reset the progress bar. More...
void	Progress (unsigned int steps=1)
	Sets the current amount of progress to current progress + steps. More...
void	SetPercentageVisible (bool visible)
	Sets whether the current progress value is displayed as a percentage. More...

Static Public Member Functions
static ProgressBar *	GetInstance ()
	Static method to get the singleton ProgressBar instance. More...

Protected Types
typedef std::vector< ProgressBarImplementation * >	ProgressBarImplementationsList
typedef ProgressBarImplementationsList::iterator	ProgressBarImplementationsListIterator

Protected Member Functions
	ProgressBar ()
	~ProgressBar () override

Protected Attributes
ProgressBarImplementationsList	m_Implementations

Static Protected Attributes
static ProgressBar *	m_Instance

Detailed Description

Sending a message to the application's ProgressBar.

Holds a GUI-dependent ProgressBarImplementation and forwards progress updates to all registered implementations. All MITK classes use this class to display progress on the GUI ProgressBar. The main application has to register a ProgressBarImplementation with RegisterImplementationInstance().

Definition at line 31 of file mitkProgressBar.h.

Member Typedef Documentation

ProgressBarImplementationsList

typedef std::vector<ProgressBarImplementation *> mitk::ProgressBar::ProgressBarImplementationsList

protected

Definition at line 81 of file mitkProgressBar.h.

ProgressBarImplementationsListIterator

typedef ProgressBarImplementationsList::iterator mitk::ProgressBar::ProgressBarImplementationsListIterator

protected

Definition at line 82 of file mitkProgressBar.h.

Constructor & Destructor Documentation

ProgressBar()

mitk::ProgressBar::ProgressBar ( )

protected

~ProgressBar()

mitk::ProgressBar::~ProgressBar ( )

overrideprotected

Member Function Documentation

AddStepsToDo()

void mitk::ProgressBar::AddStepsToDo

(

unsigned int

steps

)

Adds steps to the total number of steps to do.

Parameters

steps

Number of steps to add.

GetClassName()

virtual const char* mitk::ProgressBar::GetClassName ( ) const

virtual

GetInstance()

static ProgressBar* mitk::ProgressBar::GetInstance ( )

static

Static method to get the singleton ProgressBar instance.

No reference counting, due to decentralized static use.

Returns

Pointer to the singleton ProgressBar instance.

Progress()

void mitk::ProgressBar::Progress

(

unsigned int

steps = 1

)

Sets the current amount of progress to current progress + steps.

Parameters

steps

The number of steps done since the last Progress() call.

RegisterImplementationInstance()

void mitk::ProgressBar::RegisterImplementationInstance

(

ProgressBarImplementation *

implementation

)

Register a GUI-dependent ProgressBar implementation.

Must be called by the application to connect the application-dependent subclass of ProgressBarImplementation.

Parameters

implementation

The ProgressBarImplementation to register.

Reset()

void mitk::ProgressBar::Reset

(

)

Explicitly reset the progress bar.

SetPercentageVisible()

void mitk::ProgressBar::SetPercentageVisible

(

bool

visible

)

Sets whether the current progress value is displayed as a percentage.

Parameters

visible

If true, the percentage is displayed.

UnregisterImplementationInstance()

void mitk::ProgressBar::UnregisterImplementationInstance

(

ProgressBarImplementation *

implementation

)

Unregister a previously registered ProgressBar implementation.

Parameters

implementation

The ProgressBarImplementation to unregister.

Member Data Documentation

m_Implementations

ProgressBarImplementationsList mitk::ProgressBar::m_Implementations

protected

Definition at line 88 of file mitkProgressBar.h.

m_Instance

ProgressBar* mitk::ProgressBar::m_Instance

staticprotected

Definition at line 90 of file mitkProgressBar.h.

---

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

• mitkProgressBar.h