Overlay

class Overlay(parent)

Bases: QWidget

Dark transparent overlay that highlights widgets during the walkthrough.

param parent:

Parent widget over which the overlay is displayed.

type parent:

QWidget

Public Methods

Overlay.eventFilter(watched, event)

Update overlay geometry if the parent is resized or moved.

Parameters:
  • watched (QObject) – The object being watched.

  • event (QEvent) – The triggered event.

Returns:

True if the event is handled, False otherwise.

Return type:

bool

Overlay.highlight(widgets)

Set the target widgets to be highlighted by the overlay.

Parameters:

widgets (QWidget | list[QWidget]) – A widget or list of widgets to highlight.

Overlay.paintEvent(event)

Paint the dimmed background and highlight outlines around target widgets.

Parameters:

event (QPaintEvent) – The paint event.

Private Methods

Overlay.__init__(parent)