StepDialog

class StepDialog(parent, steps, overlay)

Bases: QDialog

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

Public Methods

StepDialog.force_close()

Forcefully close the walkthrough and clean up overlay.

StepDialog.next_step()

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

StepDialog.prev_step()

Go back to the previous step.

StepDialog.reposition()

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

StepDialog.update_step()

Update the dialog to reflect the current tutorial step.

Private Methods

StepDialog.__init__(parent, steps, overlay)

Initialize the step-by-step tutorial dialog.

Parameters:
  • parent (QWidget) – Parent widget.

  • steps (list[tuple[str, str, QWidget]]) – List of (title, message, widget) tuples representing each step.

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

StepDialog._reposition_and_show()
StepDialog._reposition_now()