The facade for canvas library. More...

#include <vici/vici.h>

Inheritance diagram for VICI::Canvas::Canvas:

Public Member Functions
virtual	~Canvas ()
	virtual destructor

virtual void	load (csr filename)=0
	restore the chart from the specified XML file. More...

virtual void	save (csr filename)=0
	save the chart More...

virtual void	setExecution (bool active, csr node)=0
	display of executing script More...

virtual void	setCommand (NodeId nid, const ArgList &args)=0
	assigning a command to the current symbol More...

virtual void	selection (Symbol::Symbol *sym)=0
	notification that a symbol has been selected More...

virtual void	symbolAttr (Symbol::SymbolAttributes &att)=0
	notification that the default symbol attributes have changed More...

virtual void	textAttr (Symbol::TextAttributes &att)=0
	notification of new text attributes More...

virtual ArgList	getNames ()=0
	get a list of names of variables etc for use in command options

Public Member Functions inherited from VICI::Symbol::SymbolClient
virtual	~SymbolClient ()
	virtual destructor

Public Member Functions inherited from VICI::Interp::InterpreterClient
virtual	~InterpreterClient ()
	virtual destructor

virtual void	setValue (csr varName, csr value)=0
	this gets called when a script variable has a change of value More...

virtual void	setFile (int state, csr filename)=0
	this gets called when a monitored file changes state. More...

virtual void	setCursor (ThreadId tid, NodeId node)=0
	this gets called as the shell steps through the script More...

virtual void	breakReached (ThreadId tid, NodeId node)=0
	this gets called when a break point is reached More...

virtual void	dataReady (NodeId node)=0
	this gets called when data is available on a display More...

virtual void	reportError (Severity sev, csr msg)=0
	This gets called if an error is detected. More...

virtual void	done ()=0
	this gets called when the script completes

Detailed Description

The facade for canvas library.

The implementation of this class will provide a canvas on which the user constructs a flow chart.

Member Function Documentation

virtual void VICI::Canvas::Canvas::load ( csr filename )

pure virtual

restore the chart from the specified XML file.

Parameters

filename the XML VICI script file.

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::save ( csr filename )

pure virtual

save the chart

Parameters

filename the XML VICI script file.

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::selection ( Symbol::Symbol * sym )

pure virtual

notification that a symbol has been selected

Parameters

sym	the symbol to place on the canvas

Implements VICI::Symbol::SymbolClient.

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::setCommand	(	NodeId	nid,
		const ArgList &	args
	)

pure virtual

assigning a command to the current symbol

Parameters

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

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::setExecution	(	bool	active,
		csr	node
	)

pure 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

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::symbolAttr ( Symbol::SymbolAttributes & att )

pure 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::Symbol::SymbolClient.

Implemented in VICI::stub::CanvasStub.

virtual void VICI::Canvas::Canvas::textAttr ( Symbol::TextAttributes & att )

pure virtual

notification of new text attributes

Parameters

att	the new text attributes

Implements VICI::Symbol::SymbolClient.

Implemented in VICI::stub::CanvasStub.

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

vici.h

Public Member Functions

Detailed Description

Member Function Documentation