wiRedPanda
Logic Circuit Simulator
Loading...
Searching...
No Matches
TourOverlay Class Reference

#include <TourOverlay.h>

Inheritance diagram for TourOverlay:
[legend]

Public Types

using TargetResolver = std::function<QRect(const QString &targetId)>

Public Member Functions

void closeRequested ()
void onRetranslated ()
void onStepChanged (int step, int total, const TourStep &stepData)
void onTourFinished ()
void setParentWindow (QWidget *newParent)
 Re-parents the overlay to newParent and reinstalls the resize event filter.
void setTargetResolver (TargetResolver resolver)
 TourOverlay (TourEngine *engine, QWidget *parent=nullptr)

Protected Member Functions

bool eventFilter (QObject *obj, QEvent *event) override
void paintEvent (QPaintEvent *event) override

Friends

class TestTourEngine

Detailed Description

Full-window overlay for the guided interface tour.

Dims the entire centralWidget area and punches a spotlight hole over the target widget. A floating callout panel shows the step title, body text, and Prev/Next navigation buttons.

Definition at line 24 of file TourOverlay.h.

Member Typedef Documentation

◆ TargetResolver

using TourOverlay::TargetResolver = std::function<QRect(const QString &targetId)>

Definition at line 30 of file TourOverlay.h.

Constructor & Destructor Documentation

◆ TourOverlay()

TourOverlay::TourOverlay ( TourEngine * engine,
QWidget * parent = nullptr )
explicit

Definition at line 25 of file TourOverlay.cpp.

References ThemeManager::instance(), and ThemeManager::themeChanged().

Member Function Documentation

◆ closeRequested()

void TourOverlay::closeRequested ( )

Referenced by onTourFinished().

◆ eventFilter()

bool TourOverlay::eventFilter ( QObject * obj,
QEvent * event )
overrideprotected

Definition at line 194 of file TourOverlay.cpp.

◆ onRetranslated()

void TourOverlay::onRetranslated ( )

Definition at line 229 of file TourOverlay.cpp.

References TourStep::body, and TourStep::title.

◆ onStepChanged()

void TourOverlay::onStepChanged ( int step,
int total,
const TourStep & stepData )

Definition at line 203 of file TourOverlay.cpp.

References TourStep::body, TourStep::target, and TourStep::title.

◆ onTourFinished()

void TourOverlay::onTourFinished ( )

Definition at line 249 of file TourOverlay.cpp.

References closeRequested().

◆ paintEvent()

void TourOverlay::paintEvent ( QPaintEvent * event)
overrideprotected

Definition at line 293 of file TourOverlay.cpp.

References kSpotlightPad.

◆ setParentWindow()

void TourOverlay::setParentWindow ( QWidget * newParent)

Re-parents the overlay to newParent and reinstalls the resize event filter.

Definition at line 45 of file TourOverlay.cpp.

◆ setTargetResolver()

void TourOverlay::setTargetResolver ( TargetResolver resolver)

Registers a callback that maps a target-id string to a highlight rect in the overlay's local coordinate space. Called once after construction.

Definition at line 40 of file TourOverlay.cpp.

◆ TestTourEngine

friend class TestTourEngine
friend

Definition at line 27 of file TourOverlay.h.

References TestTourEngine.

Referenced by TestTourEngine.

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