Cantor::ScriptExtension Class Reference

#include <extension.h>

Inheritance diagram for Cantor::ScriptExtension:

Public Slots
virtual QString	commandSeparator ()
virtual QString	commentEndingSequence ()
virtual QString	commentStartingSequence ()
virtual QString	highlightingMode ()=0
virtual QString	runExternalScript (const QString &path)=0
virtual QString	scriptFileFilter ()=0

Public Member Functions
	ScriptExtension (QObject *parent)
	~ScriptExtension ()
Public Member Functions inherited from Cantor::Extension
	Extension (const QString &name, QObject *parent)
	~Extension ()
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

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)
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)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

An Extension providing commands to interact with external scripts.

Definition at line 74 of file extension.h.

Constructor & Destructor Documentation

Cantor::ScriptExtension::ScriptExtension

(

QObject *

parent

)

Cantor::ScriptExtension::~ScriptExtension

(

)

Member Function Documentation

QString ScriptExtension::commandSeparator ( )

virtualslot

returns a string used to separate commands (usually ;)

Returns

a string used to separate commands (usually ;)

Definition at line 51 of file extension.cpp.

QString ScriptExtension::commentEndingSequence ( )

virtualslot

returns a string used to end a comment (usually "")

Returns

a string used to end a comment (usually "")

Definition at line 63 of file extension.cpp.

QString ScriptExtension::commentStartingSequence ( )

virtualslot

returns a string used to start a comment (usually #)

Returns

a string used to start a comment (usually #)

Definition at line 57 of file extension.cpp.

virtual QString Cantor::ScriptExtension::highlightingMode ( )

pure virtualslot

returns the name of the language to use for syntax highlighting in the script editor (e.g.

python). The value returned must match the name attribute from the xml language description in KTexteditor.

Returns

name of the language to use for syntax highlighting (e.g. python)

virtual QString Cantor::ScriptExtension::runExternalScript ( const QString &  path )

pure virtualslot

returns the command for running a script

Parameters

path	path to the script file

Returns

command for running a script

virtual QString Cantor::ScriptExtension::scriptFileFilter ( )

pure virtualslot

returns the file filter used for Script Files (e.g.

*.py)

Returns

file filter used for Script Files (e.g. *.py)

---

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

• extension.h
• extension.cpp