Editor widget with support for evaluating expressions and executing code. More...

#include <ScriptEdit.h>

Inheritance diagram for ScriptEdit:

Public Slots
void	evaluate ()
void	execute ()
void	executeAll ()
QString	exportASCII (const QString &file=QString::null)
void	exportPDF (const QString &fileName)
QString	importASCII (const QString &file=QString::null)
void	insertFunction (const QString &)
void	insertFunction (QAction *action)
void	print ()
void	scriptPrint (const QString &)
void	setContext (QObject *context)
void	updateIndentation ()

Public Member Functions
void	customEvent (QEvent *)
	Handle changing of scripting environment.
int	lineNumber (int pos) const
	Map cursor positions to line numbers.
	ScriptEdit (ScriptingEnv env, QWidget parent=0, QString name="")
	Constructor.
Public Member Functions inherited from scripted
	scripted (ScriptingEnv *env)
void	scriptingChangeEvent (ScriptingChangeEvent *)
	~scripted ()

Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *e)
virtual void	keyPressEvent (QKeyEvent *e)

Private Slots
void	handleContentsChange (int position, int chars_removed, int chars_added)
	Called whenever the contents of the text document changes.
void	insertErrorMsg (const QString &message)
	Insert an error message from the scripting system at printCursor.

Private Attributes
QAction *	actionEval
QAction *	actionExecute
QAction *	actionExecuteAll
QAction *	actionExport
QAction *	actionImport
QAction *	actionPrint
bool	d_changing_fmt
	True iff the text is programmatically changed and handleContentsChange() should do nothing.
bool	d_error
	True iff we are inside evaluate(), execute() or executeAll() there were errors.
QTextBlockFormat	d_fmt_default
	Format used for resetting success/failure markers.
QTextBlockFormat	d_fmt_failure
	Format used for marking code that resulted in an error.
QTextBlockFormat	d_fmt_success
	Format used for marking code that was executed or evaluated successfully.
QMenu *	functionsMenu
	Submenu of context menu with mathematical functions.
Script *	myScript
	Script used for executing/evaluating code or expressions.
QTextCursor	printCursor
	Cursor used for output of evaluation results and error messages.

Additional Inherited Members
Protected Attributes inherited from scripted
ScriptingEnv *	scriptEnv

Detailed Description

Editor widget with support for evaluating expressions and executing code.

Future Plans

Display line numbers.
syntax highlighting, indentation, auto-completion etc. (maybe using QScintilla)

Constructor & Destructor Documentation

ScriptEdit::ScriptEdit	(	ScriptingEnv *	env,
		QWidget *	parent = `0`,
		QString	name = `""`
	)

Member Function Documentation

void ScriptEdit::contextMenuEvent ( QContextMenuEvent * e )

protectedvirtual

References actionEval, actionExecute, actionExecuteAll, actionExport, actionImport, actionPrint, Note::autoexec(), functionsMenu, ScriptingEnv::mathFunctionDoc(), ScriptingEnv::mathFunctions(), and scripted::scriptEnv.

void ScriptEdit::customEvent ( QEvent * e )

Handle changing of scripting environment.

References insertErrorMsg(), myScript, ScriptingEnv::newScript(), print(), scripted::scriptEnv, SCRIPTING_CHANGE_EVENT, scripted::scriptingChangeEvent(), and scriptPrint().

void ScriptEdit::evaluate ( )

slot

References d_changing_fmt, d_error, d_fmt_default, d_fmt_failure, d_fmt_success, Script::eval(), lineNumber(), myScript, printCursor, Script::setCode(), and Script::setName().

Referenced by ScriptEdit().

void ScriptEdit::execute ( )

slot

References d_changing_fmt, d_error, d_fmt_failure, d_fmt_success, Script::exec(), lineNumber(), myScript, printCursor, Script::setCode(), and Script::setName().

Referenced by Note::execute(), and ScriptEdit().

void ScriptEdit::executeAll ( )

slot

References Script::exec(), myScript, printCursor, Script::setCode(), and Script::setName().

Referenced by Note::executeAll(), and ScriptEdit().

QString ScriptEdit::exportASCII ( const QString & file = QString::null )

slot

References ScriptingEnv::fileFilter(), and scripted::scriptEnv.

Referenced by Note::exportASCII(), and ScriptEdit().

void ScriptEdit::exportPDF ( const QString & fileName )

slot

Referenced by Note::exportPDF().

void ScriptEdit::handleContentsChange	(	int	position,
		int	chars_removed,
		int	chars_added
	)

privateslot

Called whenever the contents of the text document changes.

References d_changing_fmt, and d_fmt_default.

Referenced by ScriptEdit().

QString ScriptEdit::importASCII ( const QString & file = QString::null )

slot

References ScriptingEnv::fileFilter(), and scripted::scriptEnv.

Referenced by Note::importASCII(), and ScriptEdit().

void ScriptEdit::insertErrorMsg ( const QString & message )

privateslot

Insert an error message from the scripting system at printCursor.

After insertion, the text cursor will have the error message selected, allowing the user to delete it and fix the error.

References d_error, and printCursor.

Referenced by customEvent(), and ScriptEdit().

void ScriptEdit::insertFunction ( const QString & fname )

slot

Referenced by insertFunction(), and ScriptEdit().

void ScriptEdit::insertFunction ( QAction * action )

slot

References insertFunction(), ScriptingEnv::mathFunctions(), and scripted::scriptEnv.

void ScriptEdit::keyPressEvent ( QKeyEvent * e )

protectedvirtual

References updateIndentation().

int ScriptEdit::lineNumber ( int pos ) const

Map cursor positions to line numbers.

Referenced by evaluate(), execute(), and scriptPrint().

void ScriptEdit::print ( )

slot

Referenced by customEvent(), Note::print(), and ScriptEdit().

void ScriptEdit::scriptPrint ( const QString & text )

slot

References lineNumber(), and printCursor.

Referenced by customEvent(), and ScriptEdit().

void ScriptEdit::setContext ( QObject * context )

inlineslot

References myScript, and Script::setContext().

void ScriptEdit::updateIndentation ( )

slot

Referenced by keyPressEvent().

Member Data Documentation

QAction * ScriptEdit::actionEval

private

Referenced by contextMenuEvent(), and ScriptEdit().

QAction* ScriptEdit::actionExecute

private

Referenced by contextMenuEvent(), and ScriptEdit().

QAction * ScriptEdit::actionExecuteAll

private

Referenced by contextMenuEvent(), and ScriptEdit().

QAction * ScriptEdit::actionExport

private

Referenced by contextMenuEvent(), and ScriptEdit().

QAction * ScriptEdit::actionImport

private

Referenced by contextMenuEvent(), and ScriptEdit().

QAction * ScriptEdit::actionPrint

private

Referenced by contextMenuEvent(), and ScriptEdit().

bool ScriptEdit::d_changing_fmt

private

True iff the text is programmatically changed and handleContentsChange() should do nothing.

Referenced by evaluate(), execute(), and handleContentsChange().

bool ScriptEdit::d_error

private

True iff we are inside evaluate(), execute() or executeAll() there were errors.

Referenced by evaluate(), execute(), and insertErrorMsg().

QTextBlockFormat ScriptEdit::d_fmt_default

private

Format used for resetting success/failure markers.

Referenced by evaluate(), handleContentsChange(), and ScriptEdit().

QTextBlockFormat ScriptEdit::d_fmt_failure

private

Format used for marking code that resulted in an error.

Referenced by evaluate(), execute(), and ScriptEdit().

QTextBlockFormat ScriptEdit::d_fmt_success

private

Format used for marking code that was executed or evaluated successfully.

Referenced by evaluate(), execute(), and ScriptEdit().

QMenu* ScriptEdit::functionsMenu

private

Submenu of context menu with mathematical functions.

Referenced by contextMenuEvent(), and ScriptEdit().

Script* ScriptEdit::myScript

private

Script used for executing/evaluating code or expressions.

Referenced by customEvent(), evaluate(), execute(), executeAll(), ScriptEdit(), and setContext().

QTextCursor ScriptEdit::printCursor

private

Cursor used for output of evaluation results and error messages.

Referenced by evaluate(), execute(), executeAll(), insertErrorMsg(), ScriptEdit(), and scriptPrint().

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

scidavis/src/ScriptEdit.h
scidavis/src/ScriptEdit.cpp

Public Slots

Public Member Functions

Protected Member Functions

Private Slots

Private Attributes

Additional Inherited Members

Detailed Description

Future Plans

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation