Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
QmitkCustomWidgetOverlay Class Reference

object representing a custom widget that is handled and positioned as an overlay. More...

#include <QmitkCustomWidgetOverlay.h>

Inheritance diagram for QmitkCustomWidgetOverlay:
Collaboration diagram for QmitkCustomWidgetOverlay:

Public Member Functions

 QmitkCustomWidgetOverlay (const char *id)
 Default Constructor. More...
 
 ~QmitkCustomWidgetOverlay () override
 Default Destructor. More...
 
void SetWidget (QWidget *widget)
 
QSize GetNeededSize () override
 
- Public Member Functions inherited from QmitkOverlay
 QmitkOverlay (const char *id)
 Constructor with string ID. More...
 
 ~QmitkOverlay () override
 Default Destructor. More...
 
virtual void SetPosition (DisplayPosition)
 setter for the display-position
More...
 
virtual DisplayPosition GetPosition ()
 getter for the display-position
More...
 
virtual void SetLayer (unsigned int)
 setter for the layer
More...
 
virtual unsigned int GetLayer ()
 getter for the layer
More...
 
virtual void GenerateData (mitk::PropertyList::Pointer)
 abstract method to internally setup the overlay More...
 
virtual QWidget * GetWidget ()
 returns the internally handled QWidget More...
 

Additional Inherited Members

- Public Types inherited from QmitkOverlay
enum  DisplayPosition {
  top_Left, top_Center, top_Right, middle_Left,
  middle_Right, bottom_Left, bottom_Center, bottom_Right
}
 enumeration of all possible display positions
More...
 
- Protected Member Functions inherited from QmitkOverlay
void AddDropShadow (QWidget *widget)
 Add drop shadow effect via QGraphicsEffect. More...
 
- Protected Attributes inherited from QmitkOverlay
const char * m_Id
 ID of the overlay. More...
 
DisplayPosition m_Position
 position of the overlay More...
 
unsigned int m_Layer
 layer of the overlay More...
 
QWidget * m_Widget
 internal QWidget representing the overlay More...
 
bool m_WidgetIsCustom
 

Detailed Description

object representing a custom widget that is handled and positioned as an overlay.

A QmitkCustomWidgetOverlay is a generic sub-class of QmitkOverlay. It offers the possibility to set the internal m_Widget from the outside.

This offers the possibility to position custom widgets 'on top of' other widgets using the positioning mechanism of all overlays.

Warning
The custom widgets need to be configured and connected manually. Properties cannot be set.

Definition at line 37 of file QmitkCustomWidgetOverlay.h.

Constructor & Destructor Documentation

◆ QmitkCustomWidgetOverlay()

QmitkCustomWidgetOverlay::QmitkCustomWidgetOverlay ( const char *  id)

Default Constructor.

◆ ~QmitkCustomWidgetOverlay()

QmitkCustomWidgetOverlay::~QmitkCustomWidgetOverlay ( )
override

Default Destructor.

Member Function Documentation

◆ GetNeededSize()

QSize QmitkCustomWidgetOverlay::GetNeededSize ( )
overridevirtual

Implements QmitkOverlay.

◆ SetWidget()

void QmitkCustomWidgetOverlay::SetWidget ( QWidget *  widget)

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