Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MEventTarget, MMouseEventHandler
Inherited By:
None.
Purpose:
TToolNegotiator interfaces with the Cursor Tools Framework to match a tool with an event. An event handler, usually a view, creates the negotiator and dispatches the current event to it. The Tools framework calls the tool handler to request either a target for the tool to work on or an interactor for a delegating tool.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive any classes from TToolNegotiator.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
None.
TToolNegotiator (MToolHandler *, const TViewHandle &)
Interface Category:
API.
Purpose:
Default Constructor.
Calling Context:
Called to create an object with the specified tool handler, view and location.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
~ TToolNegotiator ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TToolNegotiator::DispatchEvent
virtual bool DispatchEvent (TEvent &)
Interface Category:
API.
Purpose:
Dispatches the specified event to correct tool.
Calling Context:
Called to dispatch an event to the correct tool. Call this function directly from the DispatchEvent function of the view cursor tool support is desired for.
Parameters:
- TEvent & -The event to dispatch.
Return Value:
Returns true if the event was handled.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual bool MouseMoved (TMouseMovedEvent &)
Interface Category:
API.
Purpose:
Facilitates the cursor tool framework in managing the cursor graphic. The default implementation simply returns false.
Calling Context:
Called by the input system framework when the mouse is moved within the view that is delegating mouse events to this object.
Parameters:
Return Value:
Returns true if the mouse event was handled.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual bool MouseExited (TMouseMovedEvent &)
Interface Category:
API.
Purpose:
Changes the cursor graphic to the graphic of the default tool when the mouse exits the view that is delegating mouse events to this object.
Calling Context:
Called by the input system framework when the mouse exits the view that is delegating mouse events to this object.
Parameters:
Return Value:
Returns true if the mouse event was handled.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
Member Function: TToolNegotiator::MouseEntered
virtual bool MouseEntered (TMouseMovedEvent &)
Interface Category:
API.
Purpose:
Changes the cursor graphic to the graphic of the current tool when the mouse enters the view that is delegating mouse events to this object.
Calling Context:
Called by the input system framework when the mouse enters the view that is delegating mouse events to this object.
Parameters:
Return Value:
Returns true if the mouse event was handled.
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.
Copyright©1995 Taligent,Inc. All rights reserved.