KTutorial: ktutorial::TutorialInformation Class Reference

KTutorial 0.5.1

ktutorial
TutorialInformation

Information about a Tutorial. More...

#include <TutorialInformation.h>

List of all members.

Public Member Functions
	TutorialInformation (const QString &id)
	Creates a new TutorialInformation with the specified identifier.
virtual	~TutorialInformation ()
	Destroys this TutorialInformation.
QString	id () const
	Returns the identifier of the tutorial.
QString	name () const
	Returns the name of the tutorial.
QString	description () const
	Returns the description of the tutorial.
Q_INVOKABLE void	setName (const QString &name)
	Sets the name of the tutorial.
Q_INVOKABLE void	setDescription (const QString &description)
	Sets the description of the tutorial.

Detailed Description

Information about a Tutorial.

Contains the identifier, name and description of a Tutorial.

The identifier must be unique. Also, it must be unstranslated, so it is the same no matter what languague is being used. For example, "moveToolbar".

The name is the human readable and localized for each language name of the Tutorial. For example, "How to move the toolbar".

Definition at line 40 of file TutorialInformation.h.

Constructor & Destructor Documentation

ktutorial::TutorialInformation::TutorialInformation ( const QString & id ) [explicit]

Creates a new TutorialInformation with the specified identifier.

Parameters:

id	The unique, untranslated identifier of the tutorial.

Definition at line 28 of file TutorialInformation.cpp.

References id(), and ktutorial::TutorialInformationPrivate::mId.

Member Function Documentation

QString ktutorial::TutorialInformation::description ( ) const

Returns the description of the tutorial.

Returns:: The description of the tutorial.

Definition at line 45 of file TutorialInformation.cpp.

References ktutorial::TutorialInformationPrivate::mDescription.

Referenced by setDescription().

QString ktutorial::TutorialInformation::id ( ) const

Returns the identifier of the tutorial.

Returns:: The identifier of the tutorial.

Definition at line 37 of file TutorialInformation.cpp.

References ktutorial::TutorialInformationPrivate::mId.

Referenced by ktutorial::Tutorial::addStep(), ktutorial::Tutorial::nextStep(), ktutorial::TutorialManager::registerTutorial(), ktutorial::Tutorial::start(), and TutorialInformation().

QString ktutorial::TutorialInformation::name ( ) const

Returns the name of the tutorial.

Returns:: The name of the tutorial.

Definition at line 41 of file TutorialInformation.cpp.

References ktutorial::TutorialInformationPrivate::mName.

Referenced by ktutorial::view::TutorialListModel::data(), setName(), and ktutorial::customization::DefaultKdeCustomization::showTutorialUI().

void ktutorial::TutorialInformation::setDescription ( const QString & description )

Sets the description of the tutorial.

This method can be invoked from a script.

Parameters:

description The description to set.

Definition at line 53 of file TutorialInformation.cpp.

References description(), and ktutorial::TutorialInformationPrivate::mDescription.

void ktutorial::TutorialInformation::setName ( const QString & name )

Sets the name of the tutorial.

This method can be invoked from a script.

Parameters:

name	The name to set.

Definition at line 49 of file TutorialInformation.cpp.

References ktutorial::TutorialInformationPrivate::mName, and name().

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