Class: TStandardArrowTool

Declaration: StandardArrowTool.h

Taxonomy Categories:

Member Functions:

Interface Category:

API

Inherits From:

TDelegatingMouseTool

Inherited By:

TStandardIBeamTool

Purpose:

TStandardArrowTool provides a delegating tool with an arrow appearance. TStandardArrowTool starts an application-supplied interactor when a mouse-down event occurs.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from TStandardArrowTool.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TStandardArrowTool::TStandardArrowTool

TStandardArrowTool ()
TStandardArrowTool (const TStandardArrowTool &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called to create a TStandardArrowTool suitable for streaming into.
Called to copy an object.

Parameters:

Takes no parameters.
const TStandardArrowTool & -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: TStandardArrowTool::~TStandardArrowTool

virtual ~ TStandardArrowTool ()

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: TStandardArrowTool::operator=

TStandardArrowTool & operator =(const TStandardArrowTool &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardArrowTool & -The object to be copied.

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.

Member Function: TStandardArrowTool::operator>>=

TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The destination stream.

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.

Member Function: TStandardArrowTool::operator<<=

TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The source stream.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws TGlobalExceptionKludge(kStreamBadVersion) if the version of the streamed in object does not match the original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardArrowTool::CreatePaletteGraphic

virtual MGraphic * CreatePaletteGraphic () const

Interface Category:

API.

Purpose:

Creates a palette graphic for this tool. The default implementation returns the default tool graphic.

Calling Context:

Called to create a palette graphic for this tool. Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the graphic created.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardArrowTool::GetPaletteText

virtual void GetPaletteText (TText &) const

Interface Category:

API.

Purpose:

Returns the current palette text for this tool.

Calling Context:

Called to obtain the current palette text for this tool. Call this function directly.

Parameters:

TText & -Filled in with the current palette text for this tool.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardArrowTool::CreateCursorGraphic

virtual MGraphic * CreateCursorGraphic () const

Interface Category:

API.

Purpose:

Creates a cursor graphic for this tool. The default implementation simply returns NIL.

Calling Context:

Called to create a cursor graphic for this tool. Called by the Cursor Tools Framework so the cursor can be set to the correct graphic when it enters a tool supporting view. Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A pointer to the cursor graphic created for this tool.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardArrowTool::GetHint

virtual TToken GetHint () const

Interface Category:

API.

Purpose:

Returns a hint about which delegating tool is associated with the view's interactor.

Calling Context:

Called by TDelegatingMouseTool::MouseDown so the correct hint can be passed as a parameter when calling MToolHandler::CreateToolInteractor. Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a hint about which delegating tool is associated with the view's interactor.

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.