VICI::stub::CanvasStub Class Reference

A stub version of the Canvas module. More...

#include <vici/libifstubs.h>

Inheritance diagram for VICI::stub::CanvasStub:

Public Member Functions
	CanvasStub (Window *w, Symbol::SymbolMgr *s, Interp::Interpreter *i, VICI::Canvas::CanvasClient *c)
	Constructor. More...
virtual void	load (csr filename)
	restore the chart from the specified XML file. More...
virtual void	save (csr filename)
	save the chart More...
virtual void	setExecution (bool active, csr node)
	display of executing script More...
virtual void	setCommand (NodeId, const ArgList &)
	assigning a command to the current symbol More...
virtual void	selection (VICI::Symbol::Symbol *)
	notification that a symbol has been selected More...
virtual void	symbolAttr (VICI::Symbol::SymbolAttributes &)
	notification that the default symbol attributes have changed More...
virtual void	textAttr (VICI::Symbol::TextAttributes &)
	notification of new text attributes More...
virtual VICI::ArgList	getNames ()
	get a list of names of variables etc for use in command options
virtual void	setValue (csr varName, csr value)
	this gets called when a script variable has a change of value More...
virtual void	setFile (int state, csr filename)
	this gets called when a monitored file changes state. More...
virtual void	setCursor (ThreadId, NodeId)
	this gets called as the shell steps through the script More...
virtual void	breakReached (ThreadId, NodeId)
	this gets called when a break point is reached More...
virtual void	dataReady (NodeId)
	this gets called when data is available on a display More...
virtual void	reportError (Severity, csr)
	This gets called if an error is detected. More...
virtual void	done ()
	this gets called when the script completes
Public Member Functions inherited from VICI::Canvas::Canvas
virtual	~Canvas ()
	virtual destructor
Public Member Functions inherited from VICI::Symbol::SymbolClient
virtual	~SymbolClient ()
	virtual destructor
Public Member Functions inherited from VICI::Interp::InterpreterClient
virtual	~InterpreterClient ()
	virtual destructor

Detailed Description

A stub version of the Canvas module.

Constructor & Destructor Documentation

CanvasStub::CanvasStub	(	Window *	w,
		Symbol::SymbolMgr *	s,
		Interp::Interpreter *	i,
		VICI::Canvas::CanvasClient *	c
	)

Constructor.

Parameters

w	The window to display into
s	The symbol manager responsible for the symbol pallette
i	The Vici interpreter.
c	The owner of the canvas.

Member Function Documentation

void CanvasStub::breakReached ( ThreadId  tid, NodeId  node  )

virtual

this gets called when a break point is reached

Parameters

tid	the thread which reached the breakpoint
node	the location of the breakpoint

Implements VICI::Interp::InterpreterClient.

void CanvasStub::dataReady ( NodeId  node )

virtual

this gets called when data is available on a display

Parameters

node	the node of the display object in the flowchart

Implements VICI::Interp::InterpreterClient.

void CanvasStub::load ( csr  filename )

virtual

restore the chart from the specified XML file.

Parameters

filename

the XML VICI script file.

Implements VICI::Canvas::Canvas.

void CanvasStub::reportError ( Severity  sev, csr  msg  )

virtual

This gets called if an error is detected.

Parameters

msg	The text of the error message.
sev	The severity of the error

Implements VICI::Interp::InterpreterClient.

void CanvasStub::save ( csr  filename )

virtual

save the chart

Parameters

filename

the XML VICI script file.

Implements VICI::Canvas::Canvas.

void CanvasStub::selection ( VICI::Symbol::Symbol *  sym )

virtual

notification that a symbol has been selected

Parameters

sym	the symbol to place on the canvas

Implements VICI::Canvas::Canvas.

void CanvasStub::setCommand ( NodeId  nid, const ArgList &  args  )

virtual

assigning a command to the current symbol

Parameters

nid	The node to set the args of.
args	The command (arg[0]) and options.

Implements VICI::Canvas::Canvas.

void CanvasStub::setCursor ( ThreadId  tid, NodeId  node  )

virtual

this gets called as the shell steps through the script

Parameters

tid	the thread which changed to executing this node
node	the node that is currently being executed

Implements VICI::Interp::InterpreterClient.

void CanvasStub::setExecution ( bool  active, csr  node  )

virtual

display of executing script

Parameters

active	true if the command is being executed
node	the node being executed

Todo:

node should be NodeId type

Implements VICI::Canvas::Canvas.

void CanvasStub::setFile ( int  state, csr  filename  )

virtual

this gets called when a monitored file changes state.

Parameters

state	this needs to be defined
filename	the name of the file that changed

Implements VICI::Interp::InterpreterClient.

void CanvasStub::setValue ( csr  varName, csr  value  )

virtual

this gets called when a script variable has a change of value

Parameters

varName	the name of the variable that changed value
value	the new value of the variable

Implements VICI::Interp::InterpreterClient.

void CanvasStub::symbolAttr ( VICI::Symbol::SymbolAttributes &  att )

virtual

notification that the default symbol attributes have changed

Parameters

att	the new default attributes

Todo:

this appears to be meaningless without the symbol

Implements VICI::Canvas::Canvas.

void CanvasStub::textAttr ( VICI::Symbol::TextAttributes &  att )

virtual

notification of new text attributes

Parameters

att	the new text attributes

Implements VICI::Canvas::Canvas.

---

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

• libifstubs.h
• libifstubs.cpp