Class: TStandardCanvasFrameColorSelectionState

Declaration: StandardGrafEdit.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCommandControlStateOn

Inherited By:

None.

Purpose:

Momentary control state that sets the frame color of the graphics in the current selection.

Instantiation:

Allocate on the heap or the stack. There is no restriction, but it is recommended that this class be allocated on the heap.

Deriving Classes:

Intended to be used as is but can also be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardCanvasFrameColorSelectionState::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: TStandardCanvasFrameColorSelectionState::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: TStandardCanvasFrameColorSelectionState::operator=

TStandardCanvasFrameColorSelectionState & operator =( const TStandardCanvasFrameColorSelectionState &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardCanvasFrameColorSelectionState & -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: TStandardCanvasFrameColorSelectionState::~TStandardCanvasFrameColorSelectionState

virtual ~ TStandardCanvasFrameColorSelectionState ()

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

TStandardCanvasFrameColorSelectionState (const TStandardCanvasFrameColorSelectionState &)
TStandardCanvasFrameColorSelectionState (const TColor &, TGUIBundleConnection * theBundleConnectionToAlias)
TStandardCanvasFrameColorSelectionState ()

Interface Category:

API.

Purpose:

Copy constructor.
Constructor.
Default constructor.

Calling Context:

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

Parameters:

const TStandardCanvasFrameColorSelectionState & -Another compatible object.
const TColor & -The color to use.
TGUIBundleConnection * theBundleConnectionToAlias -The GUI bundle that the new object is to use.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasFrameColorSelectionState::HandleAddInterests

void HandleAddInterests (TSetOf < TInterest > & theInterests) const

Interface Category:

API.

Purpose:

Adds the interest of the current selection to a specified set of existing interests.

Calling Context:

Call this function directly.

Parameters:

TSetOf < TInterest > & theInterests -The list of interests which is to be added to.

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.