A tutorial. More...

#include <Tutorial.h>

Inheritance diagram for ktutorial::Tutorial:

Public Slots
void	nextStep (const QString &id)
	Activates the next Step in the Tutorial.
void	finish ()
	Finishes this Tutorial.
Signals
void	finished (Tutorial *tutorial)
	This signal is emitted when this Tutorial finishes.
void	stepActivated (Step *step)
	This signal is emitted when a Step is activated.
Public Member Functions
	Tutorial (TutorialInformation *tutorialInformation)
	Creates a new Tutorial with the specified TutorialInformation.
virtual	~Tutorial ()
	Destroys this Tutorial.
Q_INVOKABLE TutorialInformation *	tutorialInformation () const
	Returns the TutorialInformation of this Tutorial.
Q_INVOKABLE void	addStep (Step *step)
	Adds a new Step to this Tutorial.
void	start ()
	Starts this Tutorial.
void	nextStep (Step *step)
	Activates the next step in the Tutorial.
Protected Member Functions
void	setTutorialInformation (TutorialInformation *tutorialInformation)
	Sets the information about this Tutorial.
virtual void	setup ()
	Sets up the Tutorial before activating start Step.
virtual void	tearDown ()
	Sets up the Tutorial before activating start Step.

Detailed Description

A tutorial.

A tutorial is composed by some information about it and several steps. The steps are shown to the user, one at a time, and the tutorial advances as the user completes each Step.

The information is stored in a TutorialInformation object associated with the Tutorial. It must be provided when the Tutorial is created. Subclasses can set it to 0, but must initialize it in their own constructor code. Don't delete the TutorialInformation in subclasses, as it is deleted when the Tutorial is destroyed.

Steps are the main elements in a Tutorial. They are each of the phases the user must complete when following a Tutorial. A Tutorial will have several Steps (each with a unique identifier), but it must contain at least a Step with "start" id. This will be the starting point of the Tutorial, and the first one to be activated.

To activate a Step, any of Tutorial::nextStep must be called. You are advised to use the QString version for convenience. Steps can activate another step when a condition is met or an option selected using an overloaded version of addOption and addWaitFor methods provided for convenience.

The Tutorial finishes when the user closes it. It can happen in an intermediate Step or when there are no more Steps. When making a Tutorial, add a final Step which notifies the user that the Tutorial is done and that it can be closed.

To create a Tutorial embedded in the application code the easiest way is subclassing Tutorial. In the constructor of the subclass, initialize the information about the Tutorial and add all the Steps with their WaitFors and Options. Add as many slots as needed to the class to connect them with the WaitFors and Options when added to their Steps. If something must be set before starting the Tutorial redefine setup(), if something must be cleaned after finishing the tutorial redefine tearDown(), and you are done.

Definition at line 72 of file Tutorial.h.

Constructor & Destructor Documentation

ktutorial::Tutorial::Tutorial ( TutorialInformation * tutorialInformation ) [explicit]

Creates a new Tutorial with the specified TutorialInformation.

When deriving from this class you may need to set the TutorialInformation to 0. In that case, remember to set the TutorialInformation in the constructor body!

Parameters:

tutorialInformation The TutorialInformation for this Tutorial.

Definition at line 38 of file Tutorial.cpp.

References ktutorial::TutorialPrivate::mCurrentStep, ktutorial::TutorialPrivate::mTutorialInformation, and tutorialInformation().

ktutorial::Tutorial::~Tutorial ( ) [virtual]

Destroys this Tutorial.

It also destroys the TutorialInformation.

Definition at line 44 of file Tutorial.cpp.

References ktutorial::TutorialPrivate::mTutorialInformation.