Medical Imaging Interaction Toolkit  2021.02.99-4e0dbe47
Medical Imaging Interaction Toolkit
mitk::ProgressBar Class Reference

Sending a message to the applications 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)
 Supply a GUI- dependent ProgressBar. Has to be set by the application to connect the application dependent subclass of mitkProgressBar. More...
 
void UnregisterImplementationInstance (ProgressBarImplementation *implementation)
 
void AddStepsToDo (unsigned int steps)
 Adds steps to totalSteps. More...
 
void Reset ()
 Explicitly reset 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. More...
 

Static Public Member Functions

static ProgressBarGetInstance ()
 static method to get the GUI dependent ProgressBar-instance so the methods for steps to do and progress can be called No reference counting, cause of decentral static use! 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 ProgressBarm_Instance
 

Detailed Description

Sending a message to the applications ProgressBar.

Holds a GUI dependent ProgressBarImplementation and sends the progress further. All mitk-classes use this class to display progress on GUI-ProgressBar. The mainapplication has to set the internal held ProgressBarImplementation with SetImplementationInstance(..).

Definition at line 29 of file mitkProgressBar.h.

Member Typedef Documentation

◆ ProgressBarImplementationsList

Definition at line 65 of file mitkProgressBar.h.

◆ ProgressBarImplementationsListIterator

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

Definition at line 66 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 totalSteps.

◆ GetClassName()

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

◆ GetInstance()

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

static method to get the GUI dependent ProgressBar-instance so the methods for steps to do and progress can be called No reference counting, cause of decentral static use!

◆ Progress()

void mitk::ProgressBar::Progress ( unsigned int  steps = 1)

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

Parameters
stepsthe number of steps done since last Progress(int steps) call.

◆ RegisterImplementationInstance()

void mitk::ProgressBar::RegisterImplementationInstance ( ProgressBarImplementation implementation)

Supply a GUI- dependent ProgressBar. Has to be set by the application to connect the application dependent subclass of mitkProgressBar.

◆ Reset()

void mitk::ProgressBar::Reset ( )

Explicitly reset progress bar.

◆ SetPercentageVisible()

void mitk::ProgressBar::SetPercentageVisible ( bool  visible)

Sets whether the current progress value is displayed.

◆ UnregisterImplementationInstance()

void mitk::ProgressBar::UnregisterImplementationInstance ( ProgressBarImplementation implementation)

Member Data Documentation

◆ m_Implementations

ProgressBarImplementationsList mitk::ProgressBar::m_Implementations
protected

Definition at line 72 of file mitkProgressBar.h.

◆ m_Instance

ProgressBar* mitk::ProgressBar::m_Instance
staticprotected

Definition at line 74 of file mitkProgressBar.h.


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