Class: TSelectionNotification

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

TStandardCanvasSelectionNotification

Purpose:

This notification is sent by the Compound Document Framework when the selected data has been orphaned.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Invariants: Assertion ( GetSelection() != NIL ).

Member Function: TSelectionNotification::TSelectionNotification

TSelectionNotification (const TModelInterest & theInterest, const TModelSelection &)
TSelectionNotification (const TSelectionNotification &)
TSelectionNotification ()

Interface Category:

API.

Purpose:

Constructs a new selection notification with the interest that gives the reason and a copy of the actual selection.
Copy constructor.
Default constructor. This is only for internal use by Resurrect. This function is protected.

Calling Context:

Call this function directly.
Called to copy an object. You can also call this function directly.
Only for internal use by Resurrect.

Parameters:

const TModelInterest & theInterest -The notification interest.
const TModelSelection & -The selection.
const TSelectionNotification & -The notification to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSelectionNotification::~TSelectionNotification

virtual ~ TSelectionNotification ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. You can also call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSelectionNotification::operator=

const TSelectionNotification & operator =(const TSelectionNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. You can also call this function directly.

Parameters:

const TSelectionNotification & -The right-hand side object.

Return Value:

Returns a 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: TSelectionNotification::operator>>=

virtual TStream & operator >>=(TStream & towhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. You can also call this function directly.

Parameters:

TStream & towhere -The stream to which the object streams itself out.

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

virtual TStream & operator <<= (TStream & fromwhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. You can also call this function directly.

Parameters:

TStream & fromwhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSelectionNotification::GetSelection

virtual const TModelSelection * GetSelection () const

Interface Category:

API.

Purpose:

Gets the selection for the notification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an alias to the copy of the TModelSelection that generated this notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSelectionNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object. Hash values are used to speed comparison.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for this object.

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.