VICI::stub::ViciEditorStub Class Reference

A stub version of the Vici Editor module. More...

#include <vici/libifstubs.h>

Inheritance diagram for VICI::stub::ViciEditorStub:

Public Member Functions
virtual VICI::Window *	getMainWindow ()
	Get a pointer to the main window.
virtual void	openFile (const VICI::Path &)
	Tell the editor which file to start with.
virtual void	newSymbol (Symbol::Symbol *)
	called when a symbol is placed on the canvas. More...
virtual void	newChart ()
	called when a new diagram has been started
virtual void	changedChart ()
	called when the chart is first changed
virtual void	searchAction (NodeId)
	notification that the user wants the search tab
virtual void	commandAction (NodeId, const ArgList &)
	notification that the command tab is to be displayed
virtual void	breakAction (NodeId, bool)
	notification that a breakpoint has been set or cleared
virtual void	selection (Symbol::Symbol *)
	notify that a symbol has been selected. More...
virtual void	symbolAttr (Symbol::SymbolAttributes &)
	notify that the default symbol attributes have changed More...
virtual void	textAttr (Symbol::TextAttributes &)
	notify that the default text attributes have changed More...
virtual void	optionsAndParameters (NodeId, const ArgList &)
	this gets called when the user presses OK More...
virtual void	cmndError (csr)
	this gets called if there is an error More...
virtual void	selectedCommand (NodeId, csr)
	this function is called when the user selects a command. More...
Public Member Functions inherited from VICI::Ed::ViciEditor
virtual	~ViciEditor ()
	virtual destructor
Public Member Functions inherited from VICI::Canvas::CanvasClient
virtual	~CanvasClient ()
	virtual destructor
Public Member Functions inherited from VICI::Symbol::SymbolClient
virtual	~SymbolClient ()
	virtual destructor
Public Member Functions inherited from VICI::Cmnd::CommandClient
virtual	~CommandClient ()
	virtual destructor
Public Member Functions inherited from VICI::Search::SearchClient
virtual	~SearchClient ()
	virtual destructor

Detailed Description

A stub version of the Vici Editor module.

Member Function Documentation

void ViciEditorStub::cmndError ( csr  msg )

virtual

this gets called if there is an error

Parameters

msg	the text of the error message

Implements VICI::Cmnd::CommandClient.

void ViciEditorStub::newSymbol ( Symbol::Symbol *  sym )

virtual

called when a symbol is placed on the canvas.

Parameters

sym	the symbol that was placed on the canvas.

Implements VICI::Canvas::CanvasClient.

void ViciEditorStub::optionsAndParameters ( NodeId  nid, const ArgList &  args  )

virtual

this gets called when the user presses OK

Parameters

args	the selected command and its options are returned in this
nid	The identifier for the current node

Implements VICI::Cmnd::CommandClient.

void ViciEditorStub::selectedCommand ( NodeId  n, csr  c  )

virtual

this function is called when the user selects a command.

Parameters

c	the selected command
n	the identifier for the node

Implements VICI::Search::SearchClient.

void ViciEditorStub::selection ( Symbol::Symbol *  sym )

virtual

notify that a symbol has been selected.

Parameters

sym	the symbol that was selected.

Todo:

do we need to notify of deselection ?

Implements VICI::Symbol::SymbolClient.

void ViciEditorStub::symbolAttr ( Symbol::SymbolAttributes &  att )

virtual

notify that the default symbol attributes have changed

Parameters

att	the new default attributes

Implements VICI::Symbol::SymbolClient.

void ViciEditorStub::textAttr ( Symbol::TextAttributes &  att )

virtual

notify that the default text attributes have changed

Parameters

att	the new default text attributes.

Implements VICI::Symbol::SymbolClient.

---

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

• libifstubs.h
• libifstubs.cpp