Class: TStandardCanvasSelectionNotification

Declaration: StandardGrafEdit.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSelectionNotification

Inherited By:

None.

Purpose:

Used to notify interested parties of changes to a collection of canvas graphics in the model.

Instantiation:

Allocate on the heap or the stack. There is no restriction on where this is allocated however, it is recommended that it reside 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: TStandardCanvasSelectionNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a unique value that can assist in identifying the object or comparing it to other objects.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

long -The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasSelectionNotification::GetSelection

virtual const TStandardCanvasModelSelection * GetSelection () const

Interface Category:

API.

Purpose:

Returns the associated selection that identifies graphics affected by the change that the notification represents.

Calling Context:

Handling notification.

Parameters:

Takes no parameters.

Return Value:

const TStandardCanvasModelSelection * -The selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasSelectionNotification::GetArea

virtual TGArea GetArea () const
virtual void GetArea (TGArea &) const

Interface Category:

API.

Purpose:

Returns the bounding area of the graphics affected by the change that the notification represents.

Calling Context:

Called during handling of notification.

Parameters:

Takes no parameters.
TGArea & -The returned area.

Return Value:

TGArea -The area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasSelectionNotification::operator=

const TStandardCanvasSelectionNotification & operator =( const TStandardCanvasSelectionNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual ~ TStandardCanvasSelectionNotification ()

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

TStandardCanvasSelectionNotification (const TModelInterest &, const TStandardCanvasModelSelection &, const TGArea &)
TStandardCanvasSelectionNotification ( const TStandardCanvasSelectionNotification &)
TStandardCanvasSelectionNotification ()

Interface Category:

API.

Purpose:

Constructor.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

const TModelInterest & -Any model interest to associate with the notification.
const TStandardCanvasModelSelection & -The selection that identifies changed graphics by ID.
const TGArea & -The area that encloses the changed graphics.
const TStandardCanvasSelectionNotification & -Another compatible object.
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.