Sends messages to the application's status bar. More...

#include <mitkStatusBar.h>

Inheritance diagram for mitk::StatusBar:

Collaboration diagram for mitk::StatusBar:

Public Member Functions
virtual const char *	GetClassName () const

void	DisplayText (const char *t)
	Send a string to the application's status bar. More...

void	DisplayText (const char *t, int ms)
	Send a string with a time delay to the application's status bar. More...

void	DisplayErrorText (const char *t)
	Display an error message in the status bar. More...

void	DisplayWarningText (const char *t)
	Display a warning message in the status bar. More...

void	DisplayWarningText (const char *t, int ms)
	Display a warning message with a time delay in the status bar. More...

void	DisplayGenericOutputText (const char *t)
	Display a generic output message in the status bar. More...

void	DisplayDebugText (const char *t)
	Display a debug message in the status bar. More...

void	DisplayGreyValueText (const char *t)
	Display a grey value text in the status bar. More...

void	DisplayRendererInfo (Point3D point, TimePointType time)
	Display position and time information for a renderer. More...

void	DisplayImageInfo (Point3D point, itk::Index< 3 > index, TimePointType time, ScalarType pixelValue)
	Display position, index, time and numeric pixel value. More...

void	DisplayImageInfo (Point3D point, itk::Index< 3 > index, TimePointType time, const char *pixelValue)
	Display position, index, time and custom pixel value string. More...

void	DisplayImageInfoInvalid ()
	Display placeholder text for invalid image information. More...

void	Clear ()
	Remove any temporary message being shown. More...

void	SetSizeGripEnabled (bool enable)
	Set the size grip of the window to enabled or disabled. More...

Static Public Member Functions
static StatusBar *	GetInstance ()
	Get the singleton StatusBar instance. More...

static void	SetImplementation (StatusBarImplementation *instance)
	Supply a GUI-dependent StatusBarImplementation. More...

Protected Member Functions
	StatusBar ()

	~StatusBar () override

Static Protected Attributes
static StatusBarImplementation *	m_Implementation

static StatusBar *	m_Instance

Detailed Description

Sends messages to the application's status bar.

Holds a GUI-dependent StatusBarImplementation and forwards text to it. Similar to itk::OutputWindow, but displays a single line of text with optional timed clearing. All MITK classes use this class to display text on the GUI status bar. The main application must set the internal StatusBarImplementation using SetImplementation().

Definition at line 35 of file mitkStatusBar.h.

Constructor & Destructor Documentation

◆ StatusBar()

mitk::StatusBar::StatusBar ( )

protected

◆ ~StatusBar()

mitk::StatusBar::~StatusBar ( )

overrideprotected

Member Function Documentation

◆ Clear()

void mitk::StatusBar::Clear ( )

Remove any temporary message being shown.

◆ DisplayDebugText()

void mitk::StatusBar::DisplayDebugText ( const char * t )

Display a debug message in the status bar.

Parameters

[in] t the debug text to display.

◆ DisplayErrorText()

void mitk::StatusBar::DisplayErrorText ( const char * t )

Display an error message in the status bar.

Parameters

[in] t the error text to display.

◆ DisplayGenericOutputText()

void mitk::StatusBar::DisplayGenericOutputText ( const char * t )

Display a generic output message in the status bar.

Parameters

[in] t the text to display.

◆ DisplayGreyValueText()

void mitk::StatusBar::DisplayGreyValueText ( const char * t )

Display a grey value text in the status bar.

Parameters

[in] t the grey value text to display.

◆ DisplayImageInfo() [1/2]

void mitk::StatusBar::DisplayImageInfo	(	Point3D	point,
		itk::Index< 3 >	index,
		TimePointType	time,
		const char *	pixelValue
	)

Display position, index, time and custom pixel value string.

Parameters

[in]	point	the 3D world position.
[in]	index	the voxel index in the image.
[in]	time	the current time point.
[in]	pixelValue	the pixel value as a formatted string.

◆ DisplayImageInfo() [2/2]

void mitk::StatusBar::DisplayImageInfo	(	Point3D	point,
		itk::Index< 3 >	index,
		TimePointType	time,
		ScalarType	pixelValue
	)

Display position, index, time and numeric pixel value.

Parameters

[in]	point	the 3D world position.
[in]	index	the voxel index in the image.
[in]	time	the current time point.
[in]	pixelValue	the numeric pixel value at the position.

◆ DisplayImageInfoInvalid()

void mitk::StatusBar::DisplayImageInfoInvalid ( )

Display placeholder text for invalid image information.

◆ DisplayRendererInfo()

void mitk::StatusBar::DisplayRendererInfo	(	Point3D	point,
		TimePointType	time
	)

Display position and time information for a renderer.

Parameters

[in]	point	the 3D world position.
[in]	time	the current time point.

◆ DisplayText() [1/2]

void mitk::StatusBar::DisplayText ( const char * t )

Send a string to the application's status bar.

Parameters

[in] t the text to display.

◆ DisplayText() [2/2]

void mitk::StatusBar::DisplayText	(	const char *	t,
		int	ms
	)

Send a string with a time delay to the application's status bar.

Parameters

[in]	t	the text to display.
[in]	ms	the time in milliseconds before the text is cleared.

◆ DisplayWarningText() [1/2]

void mitk::StatusBar::DisplayWarningText ( const char * t )

Display a warning message in the status bar.

Parameters

[in] t the warning text to display.

◆ DisplayWarningText() [2/2]

void mitk::StatusBar::DisplayWarningText	(	const char *	t,
		int	ms
	)

Display a warning message with a time delay in the status bar.

Parameters

[in]	t	the warning text to display.
[in]	ms	the time in milliseconds before the text is cleared.

◆ GetClassName()

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

virtual

◆ GetInstance()

static StatusBar* mitk::StatusBar::GetInstance ( )

static

Get the singleton StatusBar instance.

No reference counting due to decentralized static use.

Returns: Pointer to the StatusBar singleton.

◆ SetImplementation()

static void mitk::StatusBar::SetImplementation ( StatusBarImplementation * instance )

static

Supply a GUI-dependent StatusBarImplementation.

Must be set by the application to connect the application-dependent subclass of StatusBarImplementation. If you create an instance, then call ->Delete() on the supplied instance after setting it.

Parameters

[in] instance the GUI-dependent status bar implementation.

◆ SetSizeGripEnabled()

void mitk::StatusBar::SetSizeGripEnabled ( bool enable )

Set the size grip of the window to enabled or disabled.

The size grip is the triangle in the lower right window corner for changing the window size.

Parameters

[in] enable true to enable the size grip, false to disable it.

Member Data Documentation

◆ m_Implementation

StatusBarImplementation* mitk::StatusBar::m_Implementation

staticprotected

Definition at line 170 of file mitkStatusBar.h.

◆ m_Instance

StatusBar* mitk::StatusBar::m_Instance

staticprotected

Definition at line 171 of file mitkStatusBar.h.

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

mitkStatusBar.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StatusBar()

◆ ~StatusBar()

Member Function Documentation

◆ Clear()

◆ DisplayDebugText()

◆ DisplayErrorText()

◆ DisplayGenericOutputText()

◆ DisplayGreyValueText()

◆ DisplayImageInfo() [1/2]

◆ DisplayImageInfo() [2/2]

◆ DisplayImageInfoInvalid()

◆ DisplayRendererInfo()

◆ DisplayText() [1/2]

◆ DisplayText() [2/2]

◆ DisplayWarningText() [1/2]

◆ DisplayWarningText() [2/2]

◆ GetClassName()

◆ GetInstance()

◆ SetImplementation()

◆ SetSizeGripEnabled()

Member Data Documentation

◆ m_Implementation

◆ m_Instance