![](../../Home/Icons/Home.gif)
![](../icons/UpCNM.gif)
![](../icons/CNMContext.gif)
![](../../Home/Icons/Search.gif)
Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
TSimpleMouseTool
Inherited By:
None.
Purpose:
A cursor tool that creates canvas lines.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Intended to be used as is but can also be derived.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- TCanvasLineCreationTool ()
- TCanvasLineCreationTool (const TCanvasLineCreationTool &)
Interface Category:
API.
Purpose:
- Default constructor.
- Copy constructor.
Calling Context:
- Called to create a new object and by the stream-in operators.
- Called to copy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ TCanvasLineCreationTool ()
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.
TCanvasLineCreationTool & operator =(const TCanvasLineCreationTool &)
Interface Category:
API.
Purpose:
Assignment operator.
Calling Context:
Called when an object is assigned to another compatible object.
Parameters:
Return Value:
A non-const reference to the left-hand side object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TStream & operator >>=(TStream &) const
Interface Category:
API.
Purpose:
Stream-out operator.
Calling Context:
Called to stream out data.
Parameters:
- TStream & -The stream the object is streamed out to.
Return Value:
Returns a reference to the stream the object streams itself out to.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TStream & operator <<= (TStream &)
Interface Category:
API.
Purpose:
Stream-in operator.
Calling Context:
Called to stream in data.
Parameters:
- TStream & -The stream the object is streamed in from.
Return Value:
Returns a reference to the stream the object streams itself in from.
Exceptions:
Throws TStandardException (kStreamBadVersion,0) if streaming in a version other than kOriginalVersion.
Passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void GetPaletteText (TText &) const
Interface Category:
API.
Purpose:
Produces the text to represent the tool in a menu or palette.
Calling Context:
Called by clients creating menus or palettes.
Parameters:
- TText & -A reference to a TText object that is assigned the palette text when GetPaletteText is called. Sets this parameter to TStandardText ( Line ).
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Derived classes override to produce different text to represent the tool.
virtual MGraphic * CreatePaletteGraphic () const
Interface Category:
API.
Purpose:
Creates a graphic to represent the tool in a menu or palette.
Calling Context:
Called by clients creating menus or palettes.
Parameters:
Return Value:
MGraphic * -Currently returns NIL.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Derived classes override to create and return a different graphic.
virtual MGraphic * CreateCursorGraphic () const
Interface Category:
API.
Purpose:
Creates a graphic to be used to represent the tool as a cursor.
Calling Context:
Called by Cursor Tools framework.
Parameters:
Return Value:
MGraphic * -A crosshair graphic.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
Derived classes override to create and return a different graphic.
virtual TToolInteractor * CreateInteractor (MToolTarget * target) const
Interface Category:
API.
Purpose:
Creates an interactor to manage the interaction of creating a canvas line for the tool.
Calling Context:
Called by the Cursor Tools framework.
Parameters:
Return Value:
TToolInteractor * -A new TCanvasLineCreationInteractor.
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.