Class: TAdoptCanvasGraphicCmd

Declaration: CanvasCoreCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

A command to adopt a canvas graphic into the canvas representation associated with the canvas selection to which the command is bound.

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.

Other Considerations:

None.

Member Function: TAdoptCanvasGraphicCmd::TAdoptCanvasGraphicCmd

TAdoptCanvasGraphicCmd ()
TAdoptCanvasGraphicCmd (MCanvasGraphic * adoptGraphic, bool adoptAtFront =true)
TAdoptCanvasGraphicCmd (const TAdoptCanvasGraphicCmd &)

Interface Category:

API.

Purpose:

Default constructor.
Constructor to create from a canvas graphic to adopt.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to create a new command.
Called to copy a command.

Parameters:

Takes no parameters.
MCanvasGraphic * adoptGraphic -The canvas graphic to adopt when the command is done.
bool adoptAtFront =true -Allows the caller to specify whether the adopted graphic goes in front of (on top) or behind (underneath) the other canvas graphics already in the canvas representation.
const TAdoptCanvasGraphicCmd & -Another command that is to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptCanvasGraphicCmd::~TAdoptCanvasGraphicCmd

virtual ~ TAdoptCanvasGraphicCmd ()

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

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.

Member Function: TAdoptCanvasGraphicCmd::operator<<=

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 a TStandardException(kStreamBadVersion,0) when streaming in a version other than kOriginalVersion. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptCanvasGraphicCmd::operator=

TAdoptCanvasGraphicCmd & operator =(const TAdoptCanvasGraphicCmd &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAdoptCanvasGraphicCmd & -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: TAdoptCanvasGraphicCmd::HandleDoBegin

virtual void HandleDoBegin (MCanvasSelection &)

Interface Category:

API.

Purpose:

Adopts a canvas graphic into the representation associated with the target selection.

Calling Context:

Called by TCommandOn< MCanvasSelection >::Do and TCommandOn< MCanvasSelection >::DoBegin.

Parameters:

MCanvasSelection & -The target selection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptCanvasGraphicCmd::HandleUndo

virtual void HandleUndo (MCanvasSelection &)

Interface Category:

API.

Purpose:

Undoes the affects of HandleDoBegin.

Calling Context:

Called by TCommandOn<MCanvasSelection>::Undo.

Parameters:

MCanvasSelection & -The target selection.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAdoptCanvasGraphicCmd::HandleRedo

virtual void HandleRedo (MCanvasSelection &)

Interface Category:

API.

Purpose:

Redoes the affects of HandleDoBegin.

Calling Context:

Called by TCommandOn<MCanvasSelection>::Redo.

Parameters:

MCanvasSelection & -The target selection.

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.