Class: TModelAnchorNotification

Declaration: CompoundDocumentLinking.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

This notification is sent by the Compound Document Framework for the following reasons: 1. An anchor is adopted. 2. An anchor is orphaned. 3. The selected data of the anchor's selection is changed.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TModelAnchorNotification::TModelAnchorNotification

TModelAnchorNotification (const TModelInterest & theInterest, const TModelAnchorReference & theAnchor)
TModelAnchorNotification (const TModelAnchorNotification &)
TModelAnchorNotification ()

Interface Category:

API.

Purpose:

Constructs a new anchor notification with the interest that gives the reason and a reference to the actual anchor.
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. Developers should treat as protected.

Parameters:

const TModelInterest & theInterest -The reason.
const TModelAnchorReference & theAnchor -A reference to the anchor.
const TModelAnchorNotification & -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: TModelAnchorNotification::~TModelAnchorNotification

virtual ~ TModelAnchorNotification ()

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

TModelAnchorNotification & operator =(const TModelAnchorNotification &)

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 TModelAnchorNotification & -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: TModelAnchorNotification::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

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: TModelAnchorNotification::GetAnchorReference

const TModelAnchorReference & GetAnchorReference () const

Interface Category:

API.

Purpose:

Returns a reference to the anchor that caused this notification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the anchor that caused this notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TModelAnchorNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash key. Used by the Collection classes.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a hash key.

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.