Class: TSetCanvasGraphicFrameColorCmd

Declaration: CanvasCommands.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TChangeCanvasGraphicCmd

Inherited By:

None.

Purpose:

Sets the frame color for all canvas graphics in 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.

Member Function: TSetCanvasGraphicFrameColorCmd::TSetCanvasGraphicFrameColorCmd

TSetCanvasGraphicFrameColorCmd ()
TSetCanvasGraphicFrameColorCmd (const TColor &)
TSetCanvasGraphicFrameColorCmd (const TSetCanvasGraphicFrameColorCmd &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs from a frame color.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TColor & -The frame color to use.
const TSetCanvasGraphicFrameColorCmd & -Another command to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSetCanvasGraphicFrameColorCmd::~TSetCanvasGraphicFrameColorCmd

virtual ~ TSetCanvasGraphicFrameColorCmd ()

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

TSetCanvasGraphicFrameColorCmd & operator =(const TSetCanvasGraphicFrameColorCmd &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSetCanvasGraphicFrameColorCmd & -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: TSetCanvasGraphicFrameColorCmd::SetColor

virtual void SetColor (const TColor &)

Interface Category:

API.

Purpose:

Sets the frame color used for graphics when the command is done.

Calling Context:

Typically called by the same client that creates the command.

Parameters:

const TColor & -The frame color to use.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Can be called multiple times after command construction for incremental commands.

Member Function: TSetCanvasGraphicFrameColorCmd::BeginChange

virtual void BeginChange (MCanvasRepresentation &, MCanvasGraphic &)

Interface Category:

API.

Purpose:

Sets the frame color of the specified canvas graphic and saves undo information to later restore the graphic in UndoChange.

Calling Context:

Called by TChangeCanvasGraphicCmd::HandleDoBegin.

Parameters:

MCanvasRepresentation & -The representation that the canvas graphic is in.
MCanvasGraphic & -The canvas graphic to change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TCanvasGraphicAssociationsWith is used to save the entire graphic for undo.

Member Function: TSetCanvasGraphicFrameColorCmd::ContinueChange

virtual void ContinueChange (MCanvasRepresentation &, MCanvasGraphic &)

Interface Category:

API.

Purpose:

Sets the frame color of the specified canvas graphic.

Calling Context:

Called by TChangeCanvasGraphicCmd::HandleDoIncrement.

Parameters:

MCanvasRepresentation & -The representation that the canvas graphic is in.
MCanvasGraphic & -The canvas graphic to change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSetCanvasGraphicFrameColorCmd::UndoChange

virtual void UndoChange (MCanvasRepresentation &, MCanvasGraphic &)

Interface Category:

API.

Purpose:

Undoes prior changes to a specified canvas graphic and saves redo information to later restore the graphic in RedoChange.

Calling Context:

Called for each canvas graphic in the target selection by TChangeCanvasGraphicCmd::HandleUndo.

Parameters:

MCanvasRepresentation & -The representation that the canvas graphic is in.
MCanvasGraphic & -The canvas graphic for which to undo the change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TCanvasGraphicAssociationsWith is used to save the entire graphic for undo and redo. Undo is accomplished by calling MCanvasRepresentation::Swap to swap the saved graphic for the current one.

Member Function: TSetCanvasGraphicFrameColorCmd::RedoChange

virtual void RedoChange (MCanvasRepresentation &, MCanvasGraphic &)

Interface Category:

API.

Purpose:

Redoes changes to a specified canvas graphic and saves undo information to later restore the graphic in UndoChange.

Calling Context:

Called for each canvas graphic in the target selection by TChangeCanvasGraphicCmd::HandleRedo.

Parameters:

MCanvasRepresentation & -The representation that the canvas graphic is in.
MCanvasGraphic & -The canvas graphic for which to redo the change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

TCanvasGraphicAssociationsWith is used to save the entire graphic for undo and redo. Redo is accomplished by calling MCanvasRepresentation::Swap to swap the saved graphic for the current one.

Click the icon to mail questions or corrections about this material to Taligent personnel.