Class: TWholeModelAnchor

Declaration: CompoundDocumentLinking.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TModelAnchor

Inherited By:

None.

Purpose:

An anchor that marks all of the model's data.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TWholeModelAnchor::TWholeModelAnchor

TWholeModelAnchor (const TModelReference &)
TWholeModelAnchor (const TWholeModelAnchor &)
TWholeModelAnchor ()

Interface Category:

API.

Purpose:

Creates an anchor that marks all of the model's data.
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 TModelReference & -The model to select.
const TWholeModelAnchor & -The anchor 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: TWholeModelAnchor::~TWholeModelAnchor

virtual ~ TWholeModelAnchor ()

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: TWholeModelAnchor::FixupSelection

virtual void FixupSelection () const

Interface Category:

API.

Purpose:

Causes the selection to SelectWholeModel, before returning it. This ensures that the selection is always up-to-date.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the selection.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TWholeModelAnchor::operator=

TWholeModelAnchor & operator =(const TWholeModelAnchor &)

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

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

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: TWholeModelAnchor::AcceptsLinks

virtual bool AcceptsLinks () const

Interface Category:

API.

Purpose:

Tests to see if the anchor allows links to be adopted into it. (That is, can this anchor be a here anchor for a link.) This function always returns false.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns false.

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.