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 ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Slots
virtual void	fetchInformation ()=0

Protected Member Functions
void	setHtml (const QString &result)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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