Cantor::SyntaxHelpObject Class Reference

#include <syntaxhelpobject.h>

Inheritance diagram for Cantor::SyntaxHelpObject:

Signals
void	done ()

Public Member Functions
	SyntaxHelpObject (const QString &command, Session *session)
	~SyntaxHelpObject ()
QString	command ()
void	fetchSyntaxHelp ()
Session *	session ()
QString	toHtml ()

Protected Slots
virtual void	fetchInformation ()=0

Protected Member Functions
void	setHtml (const QString &result)

Detailed Description

Object, used to display Syntax informtion to a given command It is designed for asynchroneous use.

The Object emits done as soon as fetching of the Help is finished

Author

Alexander Rieder

Definition at line 39 of file syntaxhelpobject.h.

Constructor & Destructor Documentation

SyntaxHelpObject::SyntaxHelpObject	(	const QString &	command,
		Cantor::Session *	session
	)

Construct a HelpObject, for the given command, belonging to the Session session.

Parameters

command	Command the help should be fetched for
session	Session the HelpObject belongs to

Definition at line 35 of file syntaxhelpobject.cpp.

SyntaxHelpObject::~SyntaxHelpObject

(

)

Destructor.

Definition at line 42 of file syntaxhelpobject.cpp.

Member Function Documentation

QString SyntaxHelpObject::command

(

)

Returns the command, this SyntaxHelp is for.

Returns

the command, this SyntaxHelp is for

Definition at line 64 of file syntaxhelpobject.cpp.

void Cantor::SyntaxHelpObject::done ( )

signal

The SyntaxHelpObject is done, fetching the Information.

The syntax help can be shown now

virtual void Cantor::SyntaxHelpObject::fetchInformation ( )

protectedpure virtualslot

This method should fetch the Syntax help information from the backend.

void SyntaxHelpObject::fetchSyntaxHelp

(

)

Start fetching the syntax help, emitting done() when done.

Definition at line 47 of file syntaxhelpobject.cpp.

Session * SyntaxHelpObject::session

(

)

Returns the Session, this Object belongs to.

Returns

the Session, this Object belongs to

Definition at line 69 of file syntaxhelpobject.cpp.

void SyntaxHelpObject::setHtml ( const QString &  result )

protected

Set the html syntax help.

Parameters

result

the html syntax help

Definition at line 59 of file syntaxhelpobject.cpp.

QString SyntaxHelpObject::toHtml

(

)

Returns Html text of the Syntax Help.

Definition at line 54 of file syntaxhelpobject.cpp.

---

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

• syntaxhelpobject.h
• syntaxhelpobject.cpp