Class: TDamageNotification

Declaration: WindowNotification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

Used to notify clients that a window has damage that must be repaired. Because of the way this particular notification is sent, it can only be received by the same address space that created the TSystemWindow.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDamageNotification::TDamageNotification

TDamageNotification ()
TDamageNotification (const TDamageNotification & other)
TDamageNotification (TInterest & theChange, const TGArea & theArea)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
General use constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.
Called by the Window Server before sending the notification.

Parameters:

Takes no parameters.
const TDamageNotification & other -Other notification to copy from.
TInterest & theChange -An interest in the window damaged.
const TGArea & theArea -The area that is damaged and must be redrawn.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TDamageNotification::~TDamageNotification

virtual ~ TDamageNotification ()

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

TDamageNotification & operator =(const TDamageNotification & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDamageNotification & other -Other notification to copy from for the assignment.

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: TDamageNotification::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 is object is written.

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: TDamageNotification::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 is read .

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.

Member Function: TDamageNotification::GetDamageArea

TGArea GetDamageArea () const

Interface Category:

API.

Purpose:

Gets the area that is damaged and needs redrawing.

Calling Context:

Called by the notification client to get the area to redraw.

Parameters:

Takes no parameters.

Return Value:

Returns the damaged area.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Because of the way this particular notification is sent, it can only be received by the same address space that created the TSystemWindow.

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