TourEngine Class Reference

#include <TourEngine.h>

Inheritance diagram for TourEngine:

Public Member Functions
void	advanceStep ()
int	currentStep () const
const TourStep &	currentStepData () const
	Returns the data for the current step.
void	goToPreviousStep ()
bool	isActive () const
bool	loadFromResource (const QString &resourcePath)
void	retranslate ()
void	retranslated ()
void	start ()
void	stepChanged (int step, int total, const TourStep &data)
void	stop ()
int	totalSteps () const
void	tourCompleted ()
	TourEngine (QObject *parent=nullptr)
QString	tourId () const
void	tourStopped ()
QString	tourTitle () const

Detailed Description

Definition at line 11 of file TourEngine.h.

Constructor & Destructor Documentation

TourEngine()

TourEngine::TourEngine ( QObject * parent = nullptr )

explicit

Definition at line 32 of file TourEngine.cpp.

References Settings::completedTours(), Settings::setCompletedTours(), Settings::setTourProgress(), and Settings::tourProgress().

Member Function Documentation

advanceStep()

void TourEngine::advanceStep

(

)

Definition at line 71 of file TourEngine.cpp.

currentStep()

int TourEngine::currentStep ( ) const

inline

Definition at line 25 of file TourEngine.h.

currentStepData()

const TourStep & TourEngine::currentStepData

(

)

const

Returns the data for the current step.

Definition at line 45 of file TourEngine.cpp.

goToPreviousStep()

void TourEngine::goToPreviousStep

(

)

Definition at line 64 of file TourEngine.cpp.

isActive()

bool TourEngine::isActive ( ) const

inline

Definition at line 27 of file TourEngine.h.

loadFromResource()

bool TourEngine::loadFromResource

(

const QString &

resourcePath

)

Loads a tour from a Qt resource path (e.g. ":/Tours/ui-overview.json"). Returns false and leaves the engine inactive if the resource is missing or malformed.

Definition at line 40 of file TourEngine.cpp.

retranslate()

void TourEngine::retranslate

(

)

Re-translates the title and all steps' title/body text for the current language, preserving currentStep()/isActive(). No-op if never loaded or inactive. Emits retranslated() (never stepChanged()) so listeners can't replay step-entry side effects like MainWindow's click-target handling.

Definition at line 83 of file TourEngine.cpp.

References retranslated().

retranslated()

void TourEngine::retranslated

(

)

Referenced by retranslate().

start()

void TourEngine::start

(

)

Definition at line 50 of file TourEngine.cpp.

stepChanged()

void TourEngine::stepChanged	(	int	step,
		int	total,
		const TourStep &	data )

stop()

void TourEngine::stop

(

)

Definition at line 57 of file TourEngine.cpp.

References tourStopped().

totalSteps()

int TourEngine::totalSteps ( ) const

inline

Definition at line 26 of file TourEngine.h.

tourCompleted()

void TourEngine::tourCompleted

(

)

tourId()

QString TourEngine::tourId ( ) const

inline

Definition at line 22 of file TourEngine.h.

tourStopped()

void TourEngine::tourStopped

(

)

Referenced by stop().

tourTitle()

QString TourEngine::tourTitle ( ) const

inline

Definition at line 23 of file TourEngine.h.

---

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

• TourEngine.h
• TourEngine.cpp