VICI::Symbol::Symbol Class Reference

Represents something that is drawn on the canvas. More...

#include <vici/vici.h>

Inheritance diagram for VICI::Symbol::Symbol:

Public Member Functions
virtual	~Symbol ()
	virtual destructor
virtual Symbol *	clone (SymbolOwner *owner)=0
	construct a copy of the symbol More...
virtual void	setAttributes (SymbolAttributes &att)=0
	change the attributes of the symbol More...
virtual bool	isCommand ()=0
	check if the symbol represents a command object More...
virtual void	draw (Scene *scene, double x, double y, double scale)=0
	display the object More...
virtual void	attachCommand (const ArgList &args)=0
	Associate the symbol with a command. More...
virtual void	setNodeId (NodeId nid)=0
	Set the node id for the object. More...
virtual Style	getStyle ()=0
	get the style for the symbol More...
virtual void	setHighlight (bool x)=0
	show the symbol as selected More...

Detailed Description

Represents something that is drawn on the canvas.

The implementation will paint itself on the provided scene.

Member Function Documentation

virtual void VICI::Symbol::Symbol::attachCommand ( const ArgList &  args )

pure virtual

Associate the symbol with a command.

The first entry becomes the label for the object. The entire argument list is assigned to the tool tip for the symbol.

Parameters

args	the command and its options

Implemented in VICI::stub::SymbolStub.

virtual Symbol* VICI::Symbol::Symbol::clone ( SymbolOwner *  owner )

pure virtual

construct a copy of the symbol

Parameters

owner

the object that owns the symbol

Implemented in VICI::stub::SymbolStub.

virtual void VICI::Symbol::Symbol::draw ( Scene *  scene, double  x, double  y, double  scale  )

pure virtual

display the object

Parameters

scene	the canvas on which to display the object.
x	the x coordinate on the scene
y	the y coordinate on the scene
scale	the scaling factor to use

Implemented in VICI::stub::SymbolStub.

virtual Style VICI::Symbol::Symbol::getStyle ( )

pure virtual

get the style for the symbol

Returns

the style of the symbol.

Implemented in VICI::stub::SymbolStub.

virtual bool VICI::Symbol::Symbol::isCommand ( )

pure virtual

check if the symbol represents a command object

Returns

true if the object is a command or choice

Implemented in VICI::stub::SymbolStub.

virtual void VICI::Symbol::Symbol::setAttributes ( SymbolAttributes &  att )

pure virtual

change the attributes of the symbol

This will cause the symbol to be redisplayed with the new attributes.

Parameters

att	the new attributes.

Implemented in VICI::stub::SymbolStub.

virtual void VICI::Symbol::Symbol::setHighlight ( bool  x )

pure virtual

show the symbol as selected

Parameters

x	True to show highlighted.

Implemented in VICI::stub::SymbolStub.

virtual void VICI::Symbol::Symbol::setNodeId ( NodeId  nid )

pure virtual

Set the node id for the object.

Parameters

nid	The node id to show on the symbol.

Implemented in VICI::stub::SymbolStub.

---

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

• vici.h