Class: TNotification

Declaration: Notification.h

Taxonomy Categories:

Member Functions:

TNotification
~TNotification
operator=
GetInterest
SetInterest
GetName
SetName
GetNotifier
SetNotifier
Hash
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TDamageNotification TOnTopNotification TOrderChangeNotification TParentDeletedNotification TSystemWindowMoveNotification TTelephoneDigitsNotification TTelephoneRingNotification TTelephoneStatusNotification TTextNotification TTextPresenterStateNotification TVisibilityChangeNotification TBatchNotification TDocumentComponentNotification TDualSelectionNotification TModelAnchorNotification TModelLinkNotification TModelStyleChangedNotification TModelStyleRemovedNotification TPrintJobStatusNotification TSelectionNotification

Purpose:

The base class for transporting notification specific information. TNotification simply contains a TInterest specifying the notification interest being generated. TNotification can be derived to pass additional information for specific notifications, such as the old selection and the new selection.

Instantiation:

Always allocate on the heap.

Concurrency:

Not multithread safe.

Deriving Classes:

Derive from this class to pass additional information for specific notifications, such as the old selection and the new selection in a selection changed notification.

Resource Use:

No special requirements.

Invariants:

Assertion( GetInterest() != NIL ).

Member Function: TNotification::TNotification

Interface Category:

API.

Purpose:

Creates a TNotification with the specified interest.
Copy constructor.
Default constructor.

Calling Context:

Call this function directly.
Called to copy an object. Call this function directly.
Only for internal use by Resurrect. Developers should treat this as protected.

Parameters:

const TInterest & -The reason this notification was generated.
const TNotification & -The notification 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: TNotification::~TNotification

virtual ~ TNotification ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object. 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: TNotification::operator=

TNotification & operator =(const TNotification &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object. Call this function directly.

Parameters:

const TNotification & -The object to be assigned to.

Return Value:

A non-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: TNotification::GetInterest

const TInterest * GetInterest () const

Interface Category:

API.

Purpose:

Always returns the interest that was given to the notification when it was created. This interest should indicate the reason why the notification was generated.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the associated TInterest for the notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::SetInterest

virtual void SetInterest (const TInterest &)

Interface Category:

API.

Purpose:

Sets the interest associated with the notification.

Calling Context:

Call this function directly.

Parameters:

const TInterest & -The interest used to indicate why the notification was generated.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::GetName

TToken GetName () const

Interface Category:

API.

Purpose:

Returns the token that indicates the reason why a notification will be generated.

Calling Context:

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: TNotification::SetName

virtual void SetName (const TToken &)

Interface Category:

API.

Purpose:

Changes the token that indicates the reason why a notification will be generated.

Calling Context:

Call this function directly.

Parameters:

const TToken & -

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::GetNotifier

MNotifier * GetNotifier () const

Interface Category:

API.

Purpose:

Determines who sent the original notification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the notifier that generated this notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::SetNotifier

virtual void SetNotifier (MNotifier *)

Interface Category:

API.

Purpose:

Used by the notifier sending the notification. It tells the notification which notifier is actually sending the notification.

Calling Context:

Call this function directly.

Parameters:

MNotifier * -The notifier that generated the notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Used by the collection classes to generate a hash value for the notification.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the hash value for the notification.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TNotification::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. Call this function directly.

Parameters:

TStream & -The stream the object streams itself out to.

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

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Call this function directly.

Parameters:

TStream & -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

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.