#include <QmitkMultiWidgetDecorationManager.h>

Public Types
enum	Colormap { Colormap::BlackAndWhite }

Public Member Functions
	QmitkMultiWidgetDecorationManager (QmitkAbstractMultiWidget *multiWidget)

void	DecorationPreferencesChanged (const berry::IBerryPreferences *preferences)

void	ShowDecorations (bool show, const QStringList &decorations)
	Show or hide decorations like like colored borders or background, logos, menu widgets, logos and text annotations. More...

bool	IsDecorationVisible (const QString &decoration) const
	Return if a specific decoration is visible. More...

QStringList	GetDecorations () const

void	SetupLogo (const char *path)

void	ShowLogo (bool show)

bool	IsLogoVisible () const

void	SetColormap (Colormap colormap)

void	SetDecorationColor (const QString &widgetID, const mitk::Color &color)

void	SetAllDecorationColors (const mitk::Color &color)

mitk::Color	GetDecorationColor (const QString &widgetID) const

void	ShowColoredRectangle (const QString &widgetID, bool show)

void	ShowAllColoredRectangles (bool show)

bool	IsColoredRectangleVisible (const QString &widgetID) const

bool	AreAllColoredRectanglesVisible () const

void	SetGradientBackgroundColors (const mitk::Color &upper, const mitk::Color &lower, const QString &widgetID)
	Set a background color gradient for a specific render window. More...

void	SetAllGradientBackgroundColors (const mitk::Color &upper, const mitk::Color &lower)
	Set a background color gradient for all available render windows. More...

void	FillAllGradientBackgroundColorsWithBlack ()

void	ShowGradientBackground (const QString &widgetID, bool show)

void	ShowAllGradientBackgrounds (bool show)

std::pair< mitk::Color, mitk::Color >	GetGradientBackgroundColors (const QString &widgetID) const

bool	IsGradientBackgroundOn (const QString &widgetID) const

bool	AreAllGradientBackgroundsOn () const

void	SetCornerAnnotationText (const QString &widgetID, const std::string &cornerAnnotation)

std::string	GetCornerAnnotationText (const QString &widgetID) const

void	ShowCornerAnnotation (const QString &widgetID, bool show)

void	ShowAllCornerAnnotations (bool show)

bool	IsCornerAnnotationVisible (const QString &widgetID) const

bool	AreAllCornerAnnotationsVisible () const

Detailed Description

Definition at line 43 of file QmitkMultiWidgetDecorationManager.h.

Member Enumeration Documentation

◆ Colormap

enum QmitkMultiWidgetDecorationManager::Colormap

strong

Enumerator
BlackAndWhite

Definition at line 50 of file QmitkMultiWidgetDecorationManager.h.

Constructor & Destructor Documentation

◆ QmitkMultiWidgetDecorationManager()

QmitkMultiWidgetDecorationManager::QmitkMultiWidgetDecorationManager ( QmitkAbstractMultiWidget * multiWidget )

Definition at line 30 of file QmitkMultiWidgetDecorationManager.cpp.

Member Function Documentation

◆ AreAllColoredRectanglesVisible()

bool QmitkMultiWidgetDecorationManager::AreAllColoredRectanglesVisible ( ) const

Definition at line 268 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by IsDecorationVisible().

◆ AreAllCornerAnnotationsVisible()

bool QmitkMultiWidgetDecorationManager::AreAllCornerAnnotationsVisible ( ) const

Definition at line 422 of file QmitkMultiWidgetDecorationManager.cpp.

References mitk::ManualPlacementAnnotationRenderer::AddAnnotation(), mitk::BaseRenderer::GetInstance(), QmitkAbstractMultiWidget::GetLastRenderWindowWidget(), QmitkAbstractMultiWidget::GetRenderWindowWidgets(), and MITK_ERROR.

Referenced by IsDecorationVisible().

◆ AreAllGradientBackgroundsOn()

bool QmitkMultiWidgetDecorationManager::AreAllGradientBackgroundsOn ( ) const

Definition at line 353 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by IsDecorationVisible().

◆ DecorationPreferencesChanged()

void QmitkMultiWidgetDecorationManager::DecorationPreferencesChanged ( const berry::IBerryPreferences * preferences )

Definition at line 37 of file QmitkMultiWidgetDecorationManager.cpp.

References berry::IPreferences::Get(), berry::SmartPointer< TObjectType >::GetPointer(), berry::IPreferences::Keys(), berry::IPreferences::Parent(), SetupLogo(), ShowAllColoredRectangles(), ShowAllCornerAnnotations(), ShowAllGradientBackgrounds(), and ShowLogo().

◆ FillAllGradientBackgroundColorsWithBlack()

void QmitkMultiWidgetDecorationManager::FillAllGradientBackgroundColorsWithBlack ( )

Definition at line 301 of file QmitkMultiWidgetDecorationManager.cpp.

References SetAllGradientBackgroundColors().

Referenced by SetColormap().

◆ GetCornerAnnotationText()

std::string QmitkMultiWidgetDecorationManager::GetCornerAnnotationText ( const QString & widgetID ) const

Definition at line 377 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ GetDecorationColor()

mitk::Color QmitkMultiWidgetDecorationManager::GetDecorationColor ( const QString & widgetID ) const

Definition at line 222 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ GetDecorations()

QStringList QmitkMultiWidgetDecorationManager::GetDecorations ( ) const

Definition at line 147 of file QmitkMultiWidgetDecorationManager.cpp.

References mitk::IRenderWindowPart::DECORATION_BACKGROUND, mitk::IRenderWindowPart::DECORATION_BORDER, mitk::IRenderWindowPart::DECORATION_CORNER_ANNOTATION, mitk::IRenderWindowPart::DECORATION_LOGO, and mitk::IRenderWindowPart::DECORATION_MENU.

◆ GetGradientBackgroundColors()

std::pair< mitk::Color, mitk::Color > QmitkMultiWidgetDecorationManager::GetGradientBackgroundColors ( const QString & widgetID ) const

Return a render window (widget) specific background color gradient

Parameters

widgetID The widget identifier.

Returns: A color gradient as a pair of colors. First entry: upper color value Second entry: lower color value

Definition at line 328 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ IsColoredRectangleVisible()

bool QmitkMultiWidgetDecorationManager::IsColoredRectangleVisible ( const QString & widgetID ) const

Definition at line 256 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ IsCornerAnnotationVisible()

bool QmitkMultiWidgetDecorationManager::IsCornerAnnotationVisible ( const QString & widgetID ) const

Definition at line 410 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ IsDecorationVisible()

bool QmitkMultiWidgetDecorationManager::IsDecorationVisible ( const QString & decoration ) const

Return if a specific decoration is visible.

Returns: True, if the specified decoration is shown, false if not.

Definition at line 121 of file QmitkMultiWidgetDecorationManager.cpp.

References AreAllColoredRectanglesVisible(), AreAllCornerAnnotationsVisible(), AreAllGradientBackgroundsOn(), mitk::IRenderWindowPart::DECORATION_BACKGROUND, mitk::IRenderWindowPart::DECORATION_BORDER, mitk::IRenderWindowPart::DECORATION_CORNER_ANNOTATION, mitk::IRenderWindowPart::DECORATION_LOGO, mitk::IRenderWindowPart::DECORATION_MENU, and IsLogoVisible().

◆ IsGradientBackgroundOn()

bool QmitkMultiWidgetDecorationManager::IsGradientBackgroundOn ( const QString & widgetID ) const

Definition at line 341 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ IsLogoVisible()

bool QmitkMultiWidgetDecorationManager::IsLogoVisible ( ) const

Definition at line 182 of file QmitkMultiWidgetDecorationManager.cpp.

Referenced by IsDecorationVisible().

◆ SetAllDecorationColors()

void QmitkMultiWidgetDecorationManager::SetAllDecorationColors ( const mitk::Color & color )

Definition at line 213 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by SetColormap().

◆ SetAllGradientBackgroundColors()

void QmitkMultiWidgetDecorationManager::SetAllGradientBackgroundColors	(	const mitk::Color &	upper,
		const mitk::Color &	lower
	)

Set a background color gradient for all available render windows.

If two different input colors are used, a gradient background is generated.

Parameters

upper	The color of the gradient background.
lower	The color of the gradient background.

Definition at line 292 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by FillAllGradientBackgroundColorsWithBlack().

◆ SetColormap()

void QmitkMultiWidgetDecorationManager::SetColormap ( QmitkMultiWidgetDecorationManager::Colormap colormap )

Definition at line 187 of file QmitkMultiWidgetDecorationManager.cpp.

References BlackAndWhite, FillAllGradientBackgroundColorsWithBlack(), and SetAllDecorationColors().

◆ SetCornerAnnotationText()

void QmitkMultiWidgetDecorationManager::SetCornerAnnotationText	(	const QString &	widgetID,
		const std::string &	cornerAnnotation
	)

Definition at line 365 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ SetDecorationColor()

void QmitkMultiWidgetDecorationManager::SetDecorationColor	(	const QString &	widgetID,
		const mitk::Color &	color
	)

Definition at line 201 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ SetGradientBackgroundColors()

void QmitkMultiWidgetDecorationManager::SetGradientBackgroundColors	(	const mitk::Color &	upper,
		const mitk::Color &	lower,
		const QString &	widgetID
	)

Set a background color gradient for a specific render window.

If two different input colors are used, a gradient background is generated.

Parameters

upper	The color of the gradient background.
lower	The color of the gradient background.
widgetID	The widget identifier.

Definition at line 280 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ SetupLogo()

void QmitkMultiWidgetDecorationManager::SetupLogo ( const char * path )

Definition at line 156 of file QmitkMultiWidgetDecorationManager.cpp.

References offset.

Referenced by DecorationPreferencesChanged().

◆ ShowAllColoredRectangles()

void QmitkMultiWidgetDecorationManager::ShowAllColoredRectangles ( bool show )

Definition at line 247 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by DecorationPreferencesChanged(), and ShowDecorations().

◆ ShowAllCornerAnnotations()

void QmitkMultiWidgetDecorationManager::ShowAllCornerAnnotations ( bool show )

Definition at line 401 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by DecorationPreferencesChanged(), and ShowDecorations().

◆ ShowAllGradientBackgrounds()

void QmitkMultiWidgetDecorationManager::ShowAllGradientBackgrounds ( bool show )

Definition at line 319 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidgets().

Referenced by DecorationPreferencesChanged(), and ShowDecorations().

◆ ShowColoredRectangle()

void QmitkMultiWidgetDecorationManager::ShowColoredRectangle	(	const QString &	widgetID,
		bool	show
	)

Definition at line 235 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ ShowCornerAnnotation()

void QmitkMultiWidgetDecorationManager::ShowCornerAnnotation	(	const QString &	widgetID,
		bool	show
	)

Definition at line 389 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ ShowDecorations()

void QmitkMultiWidgetDecorationManager::ShowDecorations	(	bool	show,
		const QStringList &	decorations
	)

Show or hide decorations like like colored borders or background, logos, menu widgets, logos and text annotations.

@par Show the decorations specified in decorations if true. Hide them, if not. @par A list of decoration names. If empty, all supported decorations are affected.

Definition at line 92 of file QmitkMultiWidgetDecorationManager.cpp.

References mitk::IRenderWindowPart::DECORATION_BACKGROUND, mitk::IRenderWindowPart::DECORATION_BORDER, mitk::IRenderWindowPart::DECORATION_CORNER_ANNOTATION, mitk::IRenderWindowPart::DECORATION_LOGO, mitk::IRenderWindowPart::DECORATION_MENU, ShowAllColoredRectangles(), ShowAllCornerAnnotations(), ShowAllGradientBackgrounds(), and ShowLogo().

◆ ShowGradientBackground()

void QmitkMultiWidgetDecorationManager::ShowGradientBackground	(	const QString &	widgetID,
		bool	show
	)

Definition at line 307 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetRenderWindowWidget(), and MITK_ERROR.

◆ ShowLogo()

void QmitkMultiWidgetDecorationManager::ShowLogo ( bool show )

Definition at line 169 of file QmitkMultiWidgetDecorationManager.cpp.

References QmitkAbstractMultiWidget::GetLastRenderWindowWidget(), and MITK_ERROR.

Referenced by DecorationPreferencesChanged(), and ShowDecorations().

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ Colormap

Constructor & Destructor Documentation

◆ QmitkMultiWidgetDecorationManager()

Member Function Documentation

◆ AreAllColoredRectanglesVisible()

◆ AreAllCornerAnnotationsVisible()

◆ AreAllGradientBackgroundsOn()

◆ DecorationPreferencesChanged()

◆ FillAllGradientBackgroundColorsWithBlack()

◆ GetCornerAnnotationText()

◆ GetDecorationColor()

◆ GetDecorations()

◆ GetGradientBackgroundColors()

◆ IsColoredRectangleVisible()

◆ IsCornerAnnotationVisible()

◆ IsDecorationVisible()

◆ IsGradientBackgroundOn()

◆ IsLogoVisible()

◆ SetAllDecorationColors()

◆ SetAllGradientBackgroundColors()

◆ SetColormap()

◆ SetCornerAnnotationText()

◆ SetDecorationColor()

◆ SetGradientBackgroundColors()

◆ SetupLogo()

◆ ShowAllColoredRectangles()

◆ ShowAllCornerAnnotations()

◆ ShowAllGradientBackgrounds()

◆ ShowColoredRectangle()

◆ ShowCornerAnnotation()

◆ ShowDecorations()

◆ ShowGradientBackground()

◆ ShowLogo()