WalkthroughMixin¶

class WalkthroughMixin()

Mixin class to provide walkthrough functionality.

Subclasses must implement get_current_view() and get_walkthrough_steps().

Signals:

walkthrough_finished (str, bool): Emitted when the walkthrough ends.

Parameters:

current_view (str): The name of the current view.
was_completed (bool): True if walkthrough finished successfully, False if exited early.

Public Methods¶

WalkthroughMixin.get_current_view()¶

Abstract method to get the name of the current view.

WalkthroughMixin.get_walkthrough_steps()¶

Abstract method to retrieve the walkthrough steps for the current view.

WalkthroughMixin.launch_walkthrough()¶: Starts the walkthrough process from the appropriate view. Skips to the relevant section depending on the current view.

WalkthroughMixin.show_walkthrough_intro(current_view)¶

Displays the initial tutorial intro dialog.

WalkthroughMixin._advance_walkthrough_index()¶: Increments the walkthrough index and moves to the next step, if available.

WalkthroughMixin._force_close_walkthrough_dialog()¶: Forcefully closes the walkthrough dialog and emits a termination signal.

WalkthroughMixin._handle_walkthrough_done(steps_completed, *, is_pseudo=False)¶

Handles cleanup and transition after a walkthrough step or sequence.

Parameters:

steps_completed (int) – Number of steps completed in the walkthrough.
is_pseudo (bool) – True if the step was completed implicitly (e.g. view change).

WalkthroughMixin._init_walkthrough()¶: Initializes walkthrough state and internal tracking variables.

WalkthroughMixin._reposition_dialog(event)¶: Reposition the walkthrough dialog near the highlighted widget, avoiding overlap and staying within the main window.

WalkthroughMixin._run_next_walkthrough_step()¶: Executes the next step in the walkthrough, waiting for the correct view.