Class: TSystemWindowInterest

Declaration: WindowNotification.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

TSystemWindowInterest is used to register an interest in a specific system window for notification.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSystemWindowInterest::TSystemWindowInterest

TSystemWindowInterest (MNotifier *, const TToken & theChange, const TLayerableReference & theWindow)
TSystemWindowInterest (const TSystemWindowInterest &)
TSystemWindowInterest ()

Interface Category:

API.

Purpose:

General use constructor.
Copy constructor.
Default constructor. This constructor is for streaming only.

Calling Context:

Constructor used to create an interest in a window, using a notifier, and to specify an event that the caller is interested in.
Called to copy an object.
Called by the stream-in operators.

Parameters:

MNotifier * -Pointer to the notifier used to get notification.
const TToken & theChange -The notification the caller is specifying an interest in.
const TLayerableReference & theWindow -The system window the caller is specifying an interest in.
const TSystemWindowInterest & -A reference to another TSystemWindowInterest to copy from.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemWindowInterest::~TSystemWindowInterest

virtual ~ TSystemWindowInterest ()

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

TSystemWindowInterest & operator =(const TSystemWindowInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSystemWindowInterest & -The object to be assigned.

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: TSystemWindowInterest::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 this 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: TSystemWindowInterest::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 this 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: TSystemWindowInterest::GetWindow

TLayerableReference GetWindow () const

Interface Category:

API.

Purpose:

Gets the window from which this interest is interested in receiving notifications.

Calling Context:

Called from a notification receiver function to get the window that generated the notification.

Parameters:

Takes no parameters.

Return Value:

Returns an object representing the window that generated the notification.

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.