Class: TToolInteractor

Declaration: CursorTools.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInteractor

Inherited By:

TCanvasInteractor THighlightTextToolInteractor TSimpleTextToolInteractor

Purpose:

TToolInteractor is a base class that specific cursor interactors can be derived from. It facilitates the binding of commands produced by tool interactors and the tool handlers it applies them to.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive classes from TToolInteractor to create interactors for your own cursor tools. No functions are required to be overridden. Add protocol to translate specific input device actions into the desired commands.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TToolInteractor::TToolInteractor

TToolInteractor (MToolHandler *)
TToolInteractor (const TToolInteractor & source)

Interface Category:

API.

Purpose:

Creates a TToolInteractor for the specified tool handler or view.
Copy constructor.

Calling Context:

Called to create an instance of TToolInteractor.
Called to copy an object.

Parameters:

MToolHandler * -The tool handler or view.
const TToolInteractor & source -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::~TToolInteractor

virtual ~ TToolInteractor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::GetToolHandler

MToolHandler * GetToolHandler ()

Interface Category:

API.

Purpose:

Returns a reference to the tool handler.

Calling Context:

Called to obtain a reference to the tool handler. Called by TDelegatingMouseTool::MouseDown and TSimpleMouseTool::MouseDown.

Parameters:

Takes no parameters.

Return Value:

A reference to this interactor's tool handler.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::AdoptAndDo

virtual void AdoptAndDo (TToolCommandBinding *)

Interface Category:

API.

Purpose:

Adopts the tool command binding and does the command.

Calling Context:

Called to adopt the tool command binding and do the command. Call this function directly.

Parameters:

TToolCommandBinding * -The tool command binding to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::DoBegin

virtual void DoBegin (TToolCommandBinding &)

Interface Category:

API.

Purpose:

Performs the initial segment of an interaction.

Calling Context:

Called to start the interaction. Call this function directly.

Parameters:

TToolCommandBinding & -The tool command binding.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::DoIncrement

virtual void DoIncrement (TToolCommandBinding &)

Interface Category:

API.

Purpose:

Performs the intermediate segment of an interaction.

Calling Context:

Called to performs the intermediate segment of an interaction. Call this function directly.

Parameters:

TToolCommandBinding & -The target command binding for interactor.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TToolInteractor::AdoptAndDoEnd

virtual void AdoptAndDoEnd (TToolCommandBinding *)

Interface Category:

API.

Purpose:

Adopts the tool command binding and performs the final segment of an interaction.

Calling Context:

Called to adopt the tool command binding and performs the final segment of an interaction. Call this function directly.

Parameters:

TToolCommandBinding * -The tool command binding.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.