VICI::stub::SymbolStub Class Reference

A stub version of the Symbol class. More...

#include <vici/libifstubs.h>

Inheritance diagram for VICI::stub::SymbolStub:

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

Detailed Description

A stub version of the Symbol class.

Constructor & Destructor Documentation

VICI::stub::SymbolStub::SymbolStub ( bool  command )

inline

Constructor.

Parameters

command

True if the symbol represents a command.

Member Function Documentation

virtual void VICI::stub::SymbolStub::attachCommand ( const ArgList &  args )

inlinevirtual

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

Implements VICI::Symbol::Symbol.

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

inlinevirtual

construct a copy of the symbol

Parameters

owner

the object that owns the symbol

Implements VICI::Symbol::Symbol.

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

inlinevirtual

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

Implements VICI::Symbol::Symbol.

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

inlinevirtual

get the style for the symbol

Returns

the style of the symbol.

Implements VICI::Symbol::Symbol.

virtual bool VICI::stub::SymbolStub::isCommand ( )

inlinevirtual

check if the symbol represents a command object

Returns

true if the object is a command or choice

Implements VICI::Symbol::Symbol.

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

inlinevirtual

change the attributes of the symbol

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

Parameters

att	the new attributes.

Implements VICI::Symbol::Symbol.

virtual void VICI::stub::SymbolStub::setHighlight ( bool  x )

inlinevirtual

show the symbol as selected

Parameters

x	True to show highlighted.

Implements VICI::Symbol::Symbol.

virtual void VICI::stub::SymbolStub::setNodeId ( NodeId  nid )

inlinevirtual

Set the node id for the object.

Parameters

nid	The node id to show on the symbol.

Implements VICI::Symbol::Symbol.

---

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

• libifstubs.h