Class: TDocumentComponentReference

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Provides a simple reference to the presenter state instance. If the referenced presenter state is persistent, this reference is valid across multiple sessions of the document.

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

TDocumentComponentReference (const TDocumentComponent &)
TDocumentComponentReference (const TDocumentComponentReference &)
TDocumentComponentReference ()

Interface Category:

API.

Purpose:

Constructs a reference for a specific component.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object.
Called by the stream-in operators and to create an undefined reference.

Parameters:

const TDocumentComponent & -A component to construct a reference for.
const TDocumentComponentReference & -The reference 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: TDocumentComponentReference::~TDocumentComponentReference

virtual ~ TDocumentComponentReference ()

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: TDocumentComponentReference::IsReferenceFor

bool IsReferenceFor (const TDocumentComponent &) const

Interface Category:

API.

Purpose:

Determines whether this reference is for a specific component.

Calling Context:

Call this function directly.

Parameters:

const TDocumentComponent & -A component to test reference against.

Return Value:

Returns true if this reference is for the component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

Determines whether this reference is defined to refer to a document component.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if this reference is defined to refer to a component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentReference::operatorTDocumentReference

operator TDocumentReference () const

Interface Category:

API.

Purpose:

Converts this reference to a document reference.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the document that contains this component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentReference::operator=

TDocumentComponentReference & operator =(const TDocumentComponentReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

bool operator ==(const TDocumentComponentReference &) const

Interface Category:

API.

Purpose:

Compares two reference objects for equality. The references are equal if they refer to the same document component. Two undefined references are not equal.

Calling Context:

Call this function directly.

Parameters:

const TDocumentComponentReference & -The right-hand side object.

Return Value:

Returns true if the references are for the same component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentReference::operator!=

bool operator != (const TDocumentComponentReference &) const

Interface Category:

API.

Purpose:

Compares two references for inequality. The references are not equal if they do not refer to the same component, or if either or both are undefined.

Calling Context:

Call this function directly.

Parameters:

const TDocumentComponentReference & -The right-hand side object.

Return Value:

Returns true if the references are not for the same component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentReference::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: TDocumentComponentReference::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: TDocumentComponentReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Speeds comparison.

Calling Context:

Called by collections when comparing objects.

Parameters:

Takes no parameters.

Return Value:

Returns the integer hash value.

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.