Class: TDeleteCanvasGraphicsCmd

Declaration: CanvasCoreCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandOn

Inherited By:

None.

Purpose:

Deletes all the graphics identified by the target selection from the canvas representation that is associated with the target selection.

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: TDeleteCanvasGraphicsCmd::TDeleteCanvasGraphicsCmd

TDeleteCanvasGraphicsCmd ()
TDeleteCanvasGraphicsCmd (const TDeleteCanvasGraphicsCmd &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TDeleteCanvasGraphicsCmd & -The command to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeleteCanvasGraphicsCmd::~TDeleteCanvasGraphicsCmd

virtual ~ TDeleteCanvasGraphicsCmd ()

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: TDeleteCanvasGraphicsCmd::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: TDeleteCanvasGraphicsCmd::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 no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDeleteCanvasGraphicsCmd::operator=

TDeleteCanvasGraphicsCmd & operator =(const TDeleteCanvasGraphicsCmd &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual void HandleDoBegin (MCanvasSelection &)

Interface Category:

API.

Purpose:

Deletes all the graphics identified in the target selection from the canvas 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: TDeleteCanvasGraphicsCmd::HandleUndo

virtual void HandleUndo (MCanvasSelection &)

Interface Category:

API.

Purpose:

Undoes the affects of HandleDoBegin. Readopts previously deleted graphics into their original locations.

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: TDeleteCanvasGraphicsCmd::HandleRedo

virtual void HandleRedo (MCanvasSelection &)

Interface Category:

API.

Purpose:

Redoes the affects of HandleDoBegin. Redeletes the graphics.

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.