Class: TCursorToolSelectionState

Declaration: CursorToolSelectionState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MMomentaryControlState

Inherited By:

None.

Purpose:

TCursorToolSelectionState is used to select the current cursor tool.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TCursorToolSelectionState.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TCursorToolSelectionState::TCursorToolSelectionState

TCursorToolSelectionState (TTool * adoptTool)
TCursorToolSelectionState (const TCursorToolSelectionState &)
TCursorToolSelectionState ()

Interface Category:

API.

Purpose:

Creates a TCursorToolSelectionState and adopts the specified tool.
Copy constructor.
Default constructor.

Calling Context:

Called to create a TCursorToolSelectionState with an adopted tool.
Called to copy an object.
Called to create a TCursorToolSelectionState suitable for streaming into.

Parameters:

TTool * adoptTool -The tool to adopt.
const TCursorToolSelectionState & -The tool selection state to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorToolSelectionState::~TCursorToolSelectionState

virtual ~ TCursorToolSelectionState ()

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

TCursorToolSelectionState & operator =(const TCursorToolSelectionState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TCursorToolSelectionState & -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: TCursorToolSelectionState::operator>>=

virtual 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 to which the object streams itself.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorToolSelectionState::operator<<=

virtual 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 from which the object streams itself.

Exceptions:

Throws TGlobalExceptionKludge(kStreamBadVersion) if not original version.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCursorToolSelectionState::Select

virtual void Select ()

Interface Category:

API.

Purpose:

Calls TTool::SetCurrentTool with the adopted tool. The tool is copied by TTool, not adopted.

Calling Context:

Called when momentary control is selected.

Parameters:

Takes no parameters.

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.