myscript::iink::ToolController Class Reference

#include <ToolController.h>

Public Member Functions
virtual	~ToolController ()
virtual PointerTool	getToolForType (PointerType type) const =0
virtual void	setToolForType (PointerType type, PointerTool tool)=0
virtual String	getToolStyle (PointerTool tool) const =0
virtual void	setToolStyle (PointerTool tool, const String &style)=0
virtual String	getToolStyleClasses (PointerTool tool) const =0
virtual void	setToolStyleClasses (PointerTool tool, const String &styleClasses)=0

Detailed Description

The ToolController manages pointer tools configuration.

See also

Editor.

Since

2.0

Constructor & Destructor Documentation

~ToolController()

virtual myscript::iink::ToolController::~ToolController ( )

inlinevirtual

Member Function Documentation

getToolForType()

virtual PointerTool myscript::iink::ToolController::getToolForType ( PointerType  type ) const

pure virtual

Returns the tool associated with a pointer type.

Parameters

type	the pointer type.

Exceptions

std::invalid_argument

when type is unknown.

Returns

the pointer tool associated with this type.

setToolForType()

virtual void myscript::iink::ToolController::setToolForType ( PointerType  type, PointerTool  tool  )

pure virtual

Sets the tool associated with a pointer type.

Parameters

type	the pointer type.
tool	the pointer tool.

Exceptions

std::invalid_argument	when type is unknown.
std::invalid_argument	when tool is unknown.
std::runtime_error	when a pointer event sequence is in progress with this pointer type.

getToolStyle()

virtual String myscript::iink::ToolController::getToolStyle ( PointerTool  tool ) const

pure virtual

Returns the CSS style properties associated with a pointer tool.

Parameters

tool	the pointer tool.

Exceptions

std::invalid_argument

when tool is unknown.

Returns

the CSS style properties associated with this pointer tool.

setToolStyle()

virtual void myscript::iink::ToolController::setToolStyle ( PointerTool  tool, const String &  style  )

pure virtual

Sets the CSS style properties associated with a pointer tool.

Parameters

tool	the pointer tool.
style	the tool CSS style properties.

Exceptions

std::invalid_argument	when tool is unknown.
std::runtime_error	when a pointer event sequence is in progress with a different tool (e.g. Eraser).

getToolStyleClasses()

virtual String myscript::iink::ToolController::getToolStyleClasses ( PointerTool  tool ) const

pure virtual

Returns the style classes associated with a pointer tool.

Parameters

tool	the pointer tool.

Exceptions

std::invalid_argument

when tool is unknown.

Returns

the style classes associated with this pointer tool.

setToolStyleClasses()

virtual void myscript::iink::ToolController::setToolStyleClasses ( PointerTool  tool, const String &  styleClasses  )

pure virtual

Sets the style classes associated with a pointer tool.

Note

style properties provided via setToolStyle() may override the styling associated with the style classes provided here.

Parameters

tool	the pointer tool.
styleClasses	the style class names, separated by spaces.

Exceptions

std::invalid_argument

when tool is unknown.

---

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

• iink/ToolController.h