Medical Imaging Interaction Toolkit  2021.10.99-1c4db16f
Medical Imaging Interaction Toolkit
QmitkMultiWidgetDecorationManager Class Reference

#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::ColorGetGradientBackgroundColors (const QString &widgetID) const
 Return a render window (widget) specific background color gradient. More...
 
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

Enumerator
BlackAndWhite 

Definition at line 50 of file QmitkMultiWidgetDecorationManager.h.

Constructor & Destructor Documentation

◆ QmitkMultiWidgetDecorationManager()

QmitkMultiWidgetDecorationManager::QmitkMultiWidgetDecorationManager ( QmitkAbstractMultiWidget multiWidget)

Member Function Documentation

◆ AreAllColoredRectanglesVisible()

bool QmitkMultiWidgetDecorationManager::AreAllColoredRectanglesVisible ( ) const

◆ AreAllCornerAnnotationsVisible()

bool QmitkMultiWidgetDecorationManager::AreAllCornerAnnotationsVisible ( ) const

◆ AreAllGradientBackgroundsOn()

bool QmitkMultiWidgetDecorationManager::AreAllGradientBackgroundsOn ( ) const

◆ DecorationPreferencesChanged()

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

◆ FillAllGradientBackgroundColorsWithBlack()

void QmitkMultiWidgetDecorationManager::FillAllGradientBackgroundColorsWithBlack ( )

◆ GetCornerAnnotationText()

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

◆ GetDecorationColor()

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

◆ GetDecorations()

QStringList QmitkMultiWidgetDecorationManager::GetDecorations ( ) const

◆ GetGradientBackgroundColors()

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

Return a render window (widget) specific background color gradient.

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

◆ IsColoredRectangleVisible()

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

◆ IsCornerAnnotationVisible()

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

◆ 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.

◆ IsGradientBackgroundOn()

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

◆ IsLogoVisible()

bool QmitkMultiWidgetDecorationManager::IsLogoVisible ( ) const

◆ SetAllDecorationColors()

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

◆ 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
upperThe color of the gradient background.
lowerThe color of the gradient background.

◆ SetColormap()

void QmitkMultiWidgetDecorationManager::SetColormap ( Colormap  colormap)

◆ SetCornerAnnotationText()

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

◆ SetDecorationColor()

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

◆ 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
upperThe color of the gradient background.
lowerThe color of the gradient background.
widgetIDThe widget identifier.

◆ SetupLogo()

void QmitkMultiWidgetDecorationManager::SetupLogo ( const char *  path)

◆ ShowAllColoredRectangles()

void QmitkMultiWidgetDecorationManager::ShowAllColoredRectangles ( bool  show)

◆ ShowAllCornerAnnotations()

void QmitkMultiWidgetDecorationManager::ShowAllCornerAnnotations ( bool  show)

◆ ShowAllGradientBackgrounds()

void QmitkMultiWidgetDecorationManager::ShowAllGradientBackgrounds ( bool  show)

◆ ShowColoredRectangle()

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

◆ ShowCornerAnnotation()

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

◆ 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.

◆ ShowGradientBackground()

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

◆ ShowLogo()

void QmitkMultiWidgetDecorationManager::ShowLogo ( bool  show)

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