QmitkOverlayWidget Class Reference

Simple widget that can be used to achieve overlays above a parent widget. More...

#include <QmitkOverlayWidget.h>

Inheritance diagram for QmitkOverlayWidget:

Collaboration diagram for QmitkOverlayWidget:

Public Slots
void	setOpacity (int opacity)
	Sets the overlay opacity. More...

Public Member Functions
	QmitkOverlayWidget (QWidget *parent=nullptr)
	~QmitkOverlayWidget () override
bool	isTransparentForMouseEvents () const
	Returns whether mouse events pass through the overlay to the parent. More...
void	setTransparentForMouseEvents (bool transparent=true)
	Sets whether mouse events pass through the overlay. More...
int	getOpacity () const
	Returns the current opacity value (0-255). More...

Protected Member Functions
bool	event (QEvent *e) override
bool	eventFilter (QObject *watched, QEvent *event) override
void	paintEvent (QPaintEvent *event) override

Properties
bool	transparentForMouseEvents

Detailed Description

Simple widget that can be used to achieve overlays above a parent widget.

This implementation just renders a semi transparent black background. To add content to the overlay derive from this class.

See also

QmitkSimpleTextOverlayWidget

QmitkButtonOverlayWidget

Definition at line 29 of file QmitkOverlayWidget.h.

Constructor & Destructor Documentation

QmitkOverlayWidget()

QmitkOverlayWidget::QmitkOverlayWidget ( QWidget *  parent = nullptr )

explicit

~QmitkOverlayWidget()

QmitkOverlayWidget::~QmitkOverlayWidget ( )

override

Member Function Documentation

event()

bool QmitkOverlayWidget::event ( QEvent *  e )

overrideprotected

eventFilter()

bool QmitkOverlayWidget::eventFilter ( QObject *  watched, QEvent *  event  )

overrideprotected

getOpacity()

int QmitkOverlayWidget::getOpacity

(

)

const

Returns the current opacity value (0-255).

isTransparentForMouseEvents()

bool QmitkOverlayWidget::isTransparentForMouseEvents

(

)

const

Returns whether mouse events pass through the overlay to the parent.

paintEvent()

void QmitkOverlayWidget::paintEvent ( QPaintEvent *  event )

overrideprotected

setOpacity

void QmitkOverlayWidget::setOpacity ( int  opacity )

slot

Sets the overlay opacity.

Parameters

[in]

opacity

The opacity value (0 = fully transparent, 255 = fully opaque).

setTransparentForMouseEvents()

void QmitkOverlayWidget::setTransparentForMouseEvents

(

bool

transparent = true

)

Sets whether mouse events pass through the overlay.

Parameters

[in]

transparent

If true, mouse events are forwarded to the parent widget.

Property Documentation

transparentForMouseEvents

bool QmitkOverlayWidget::transparentForMouseEvents

readwrite

Definition at line 1 of file QmitkOverlayWidget.h.

---

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

• QmitkOverlayWidget.h