Class: TDocumentComponentNotification

Declaration: GUICompoundDocumentEmbedder.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

Notifies clients of some change related to a document component. This class simply provides a notification with a component reference.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Notifications that add additional information about a component would derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::TDocumentComponentNotification

TDocumentComponentNotification (const TModelInterest & theInterest, const TDocumentComponentReference &)
TDocumentComponentNotification (const TDocumentComponentNotification &)
TDocumentComponentNotification ()

Interface Category:

API.

Purpose:

Creates a notification for a specific interest and component.
Copy constructor.
Default constructor.

Calling Context:

Called by any client object.
Called to copy an object.
Only for internal use by Resurrect. Developers should treat as protected.

Parameters:

const TModelInterest & theInterest -The interest.
const TDocumentComponentReference & -The component.
const TDocumentComponentNotification & -The notification to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::~TDocumentComponentNotification

virtual ~ TDocumentComponentNotification ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::operator=

TDocumentComponentNotification & operator =(const TDocumentComponentNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDocumentComponentNotification & -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. Throws if

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::GetComponentReference

TDocumentComponentReference GetComponentReference () const

Interface Category:

API.

Purpose:

Returns the component affected by the change that resulted in this notification.

Calling Context:

Called by an client object.

Parameters:

Takes no parameters.

Return Value:

Returns the affected component.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this object. Hash values are used to speed comparisons.

Calling Context:

Called by collection classes.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::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:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentNotification::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:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.