Cantor::Result Class Reference

#include <result.h>

Inheritance diagram for Cantor::Result:

Public Member Functions
	Result ()
virtual	~Result ()
virtual QVariant	data ()=0
virtual QString	mimeType ()=0
virtual void	save (const QString &filename)=0
virtual void	saveAdditionalData (KZip *archive)
virtual QString	toHtml ()=0
virtual QString	toLatex ()
virtual QDomElement	toXml (QDomDocument &doc)=0
virtual int	type ()=0
virtual KUrl	url ()

Detailed Description

Base class for different results, like text, image, animation.

etc.

Definition at line 39 of file result.h.

Constructor & Destructor Documentation

Result::Result

(

)

Default constructor.

Definition at line 33 of file result.cpp.

Result::~Result ( )

virtual

Destructor.

Definition at line 38 of file result.cpp.

Member Function Documentation

virtual QVariant Cantor::Result::data ( )

pure virtual

returns data associated with this result (text/images/etc)

Returns

data associated with this result

Implemented in Cantor::LatexResult, Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, and Cantor::AnimationResult.

virtual QString Cantor::Result::mimeType ( )

pure virtual

returns the mimetype, this result is

Returns

the mimetype, this result is

Implemented in Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, Cantor::LatexResult, and Cantor::AnimationResult.

virtual void Cantor::Result::save ( const QString &  filename )

pure virtual

saves this to a file

Parameters

filename

name of the file

Implemented in Cantor::LatexResult, Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, and Cantor::AnimationResult.

void Result::saveAdditionalData ( KZip *  archive )

virtual

saves all the data, that can't be saved in xml in an extra file in the archive.

Reimplemented in Cantor::EpsResult, Cantor::ImageResult, and Cantor::AnimationResult.

Definition at line 58 of file result.cpp.

virtual QString Cantor::Result::toHtml ( )

pure virtual

returns html code, that represents this result, e.g.

an img tag for images

Returns

html code representing this result

Implemented in Cantor::LatexResult, Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, and Cantor::AnimationResult.

QString Result::toLatex ( )

virtual

returns latex code, that represents this result e.g.

a includegraphics command for images it falls back to toHtml if not implemented

Returns

latex code representing this result

Reimplemented in Cantor::LatexResult, Cantor::EpsResult, and Cantor::ImageResult.

Definition at line 48 of file result.cpp.

virtual QDomElement Cantor::Result::toXml ( QDomDocument &  doc )

pure virtual

returns a DomElement, containing the information of the result

Parameters

doc	DomDocument used for storing the information

Returns

DomElement, containing the information of the result

Implemented in Cantor::LatexResult, Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, Cantor::AnimationResult, and Cantor::HelpResult.

virtual int Cantor::Result::type ( )

pure virtual

returns an unique number, representing the type of this result.

Every subclass should define their own Type.

Returns

the type of this result

Implemented in Cantor::TextResult, Cantor::EpsResult, Cantor::ImageResult, Cantor::LatexResult, Cantor::AnimationResult, and Cantor::HelpResult.

KUrl Result::url ( )

virtual

returns an url, data for this result resides at

Returns

an url, data for this result resides at

Reimplemented in Cantor::EpsResult, Cantor::ImageResult, and Cantor::AnimationResult.

Definition at line 43 of file result.cpp.

---

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

• result.h
• result.cpp