Class: TModelPresenterStateInterest

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

Specifies interest in notifications on a specific presenter state.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

No special requirements.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TModelPresenterStateInterest::TModelPresenterStateInterest

TModelPresenterStateInterest (const TPresenterStateReference & thePresenterState, const TToken & theName)
TModelPresenterStateInterest (const TModelPresenterStateInterest &)
TModelPresenterStateInterest ()

Interface Category:

API.

Purpose:

Constructs an interest in a notification on the specified presenter state.
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.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TPresenterStateReference & thePresenterState -The presenter state for which this object is an interest.
const TToken & theName -The notification name.
const TModelPresenterStateInterest & -The object 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: TModelPresenterStateInterest::~TModelPresenterStateInterest

virtual ~ TModelPresenterStateInterest ()

Interface Category:

API.

Purpose:

Destructor. This function deletes the TModelStyle object provided during construction.

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

const TModelPresenterStateInterest & operator =(const TModelPresenterStateInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TModelPresenterStateInterest & -The object to be copied.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -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: TModelPresenterStateInterest::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.

Member Function: TModelPresenterStateInterest::GetPresenterStateReference

TPresenterStateReference GetPresenterStateReference () const

Interface Category:

API.

Purpose:

Returns the presenter state on which this object is an interest.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the presenter state on which this object is an interest.

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.