Class: TDualSelectionNotification

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

TDualSelectionNotification
~TDualSelectionNotification
operator=
operator>>=
operator<<=
GetNewSelection
GetOldSelection
Hash

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

This notification is sent by the Compound Document Framework for the following reasons:

The selection has changed.
The selected data has been replaced.

Instantiation:

Always allocate on the heap.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

Invariants: Assertion ( GetNewSelection() != NIL && GetOldSelection() != NIL ).

Member Function: TDualSelectionNotification::TDualSelectionNotification

TDualSelectionNotification (const TModelInterest & theInterest, const TModelSelection & theNewSelection, const TModelSelection & theOldSelection)
TDualSelectionNotification (const TDualSelectionNotification &)
TDualSelectionNotification ()

Interface Category:

API.

Purpose:

Creates a new notification with theInterest as the reason. It makes copies of theNewSelection and theOldSelection.
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 & theNewSelection -The new selection.
const TModelSelection & theOldSelection -The old selection.
const TDualSelectionNotification & -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: TDualSelectionNotification::~TDualSelectionNotification

virtual ~ TDualSelectionNotification ()

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

const TDualSelectionNotification & operator =(const TDualSelectionNotification &)

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 TDualSelectionNotification & -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: TDualSelectionNotification::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: TDualSelectionNotification::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: TDualSelectionNotification::GetNewSelection

virtual const TModelSelection * GetNewSelection () const

Interface Category:

API.

Purpose:

Returns the new selection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the new selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDualSelectionNotification::GetOldSelection

virtual const TModelSelection * GetOldSelection () const

Interface Category:

API.

Purpose:

Returns the old selection.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the old selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDualSelectionNotification::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.