Class: TPresenterReference

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Provides a simple reference to a GUI presenter instance.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TPresenterReference is monomorphic and is not derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TPresenterReference::TPresenterReference

TPresenterReference ()
TPresenterReference (const TPresenterReference &)
TPresenterReference (const TGUIPresenter &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates a reference to the specified GUI presenter.

Calling Context:

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

Parameters:

Takes no parameters.
const TPresenterReference & -The reference to copy.
const TGUIPresenter & -The presenter for which to create a reference.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterReference::~TPresenterReference

~ TPresenterReference ()

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

bool IsReferenceFor (const TGUIPresenter &) const

Interface Category:

API.

Purpose:

Determines if this object is a reference for the specified GUI presenter.

Calling Context:

Call this function directly.

Parameters:

const TGUIPresenter & -The presenter to test the reference against.

Return Value:

Returns true if this reference is for the argument presenter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterReference::operatorTDocumentReference

operator TDocumentReference () const

Interface Category:

API.

Purpose:

Converts this reference to a reference to the document that contains the presenter this reference refers to.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a reference to the document.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterReference::operator=

TPresenterReference & operator =(const TPresenterReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TPresenterReference & -The reference to copy

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

bool operator ==(const TPresenterReference &) const

Interface Category:

API.

Purpose:

Compares a reference object to another for equality. References are equal if they refer to the same presenter. Two undefined references are equal.

Calling Context:

Call this function directly.

Parameters:

const TPresenterReference & -The right-hand side object.

Return Value:

Returns true if references are for the same presenter.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterReference::operator!=

bool operator != (const TPresenterReference &) const

Interface Category:

API.

Purpose:

Compares a reference object to another for inequality. References are not equal if they refer to different presenters.

Calling Context:

Call this function directly.

Parameters:

const TPresenterReference & -The right-hand side object.

Return Value:

Returns true if the references are for different presenters.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object. The hash value used to speed comparison.

Calling Context:

Called by collections when comparing objects.

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.

Member Function: TPresenterReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

Determines whether or not this presenter reference refers to any presenter that exists or may have existed at one time. Note that the presenter that this reference refers to may no longer exist or may be unavailable for some other reason.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the reference refers to any presenter; false otherwise.

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.