StepDialog

class StepDialog(parent: QWidget, steps: List[Tuple[str, str, Union[QWidget, List[QWidget]]]], overlay: ‘Overlay’)

Bases: QDialog

Dialog that guides the user through steps using popups and an overlay.

Public Methods

StepDialog.force_close() → None

Forcefully close the walkthrough and clean up overlay.

StepDialog.moveEvent(event: QMoveEvent) → None

Run the default handling, then notify the on_move hook if one is set.

Parameters:

event (QMoveEvent) – The move event.

StepDialog.next_step() → None

Advance to the next step. Closes the dialog if it’s the last step.

StepDialog.prev_step() → None

Go back to the previous step.

StepDialog.reposition() → None

Recalculate the dialog position and move it near the target widget.

StepDialog.update_step() → None

Update the dialog to reflect the current tutorial step.

Private Methods

StepDialog.__init__(parent: QWidget, steps: List[Tuple[str, str, QWidget | List[QWidget]]], overlay: Overlay) → None

Initialize the step-by-step tutorial dialog.

Parameters:

• parent (QWidget) – Parent widget.

• steps (List[Tuple[str, str, Union[QWidget, List[QWidget]]]]) – List of (title, message, widget) tuples representing each step. The third element may be a single widget or a list of widgets to highlight together.

• overlay (Overlay) – Overlay widget to highlight target areas.

StepDialog._reposition_and_show() → None

StepDialog._reposition_now() → None