Class: TOnTopNotification

Declaration: WindowNotification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TNotification

Inherited By:

None.

Purpose:

This notifies interested clients when the window or layer on top of others in its layer has changed. Notification is sent to both the new layer on top and the layer that is replaced.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TOnTopNotification::TOnTopNotification

TOnTopNotification (TInterest & theChange, const TLayerableReference & oldWindow, const TLayerableReference & newWindow)
TOnTopNotification (const TOnTopNotification & other)
TOnTopNotification ()

Interface Category:

API.

Purpose:

General use constructor.
Copy constructor.
Default constructor.

Calling Context:

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

Parameters:

TInterest & theChange -An interest in either the old or new window or layer. The interest token will be either LayerableOnTop or LayerableNotOnTop.
const TLayerableReference & oldWindow -The window/layer that was on top.
const TLayerableReference & newWindow -The window/layer that is now on top.
const TOnTopNotification & other -Other notification to copy to.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOnTopNotification::~TOnTopNotification

virtual ~ TOnTopNotification ()

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

TOnTopNotification & operator =(const TOnTopNotification & other)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TOnTopNotification & 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: TOnTopNotification::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 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: TOnTopNotification::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: TOnTopNotification::GetNewOnTop

TLayerableReference GetNewOnTop ()

Interface Category:

API.

Purpose:

Gets the window that is currently on top.

Calling Context:

Called by the client receiving the notification to get the window currently on top.

Parameters:

Takes no parameters.

Return Value:

Returns an TLayerableReference object that represents the window.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TOnTopNotification::GetOldOnTop

TLayerableReference GetOldOnTop ()

Interface Category:

API.

Purpose:

Gets the window that had been on top prior to the change.

Calling Context:

Called by the client receiving the notification to get the window that used to be on top.

Parameters:

Takes no parameters.

Return Value:

Returns an TLayerableReference object that represents the window.

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.