Class: TWindowInterest

Declaration: Window.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TInterest

Inherited By:

None.

Purpose:

TWindowInterest derives from TInterest and is used to register interest in specific windows events. Objects who register interest in events on this window are notified by the view class notifier when those events occur. Interesting window events include open, close, show, hide, enable, disable, highlight, and unhighlight.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Classes deriving from TWindow may wish to provide additional notification functionality through a class deriving from TWindowInterest.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TWindowInterest::TWindowInterest

TWindowInterest (TWindow * theWindow, const TToken & theChange, MNotifier * theNotifier)
TWindowInterest (const TWindowInterest &)
TWindowInterest ()

Interface Category:

API.

Purpose:

Creates a new TWindowInterest object initialized with the specified parameters.
Copy constructor.
Default constructor. This constructor is protected.

Calling Context:

You can call this function directly.
Called to copy an object.
Called by the stream-in operators.

Parameters:

TWindow * theWindow -The window in which this object is interested.
const TToken & theChange -The event in which this object is interested.
MNotifier * theNotifier -The object through which notification occurs.
const TWindowInterest & -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

In general, this class is not.

Other Considerations:

None.

Member Function: TWindowInterest::~TWindowInterest

virtual ~ TWindowInterest ()

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:

In general, this class is not.

Other Considerations:

None.

Member Function: TWindowInterest::operator=

const TWindowInterest & operator =(const TWindowInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TWindowInterest & -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

In general, this class is not.

Other Considerations:

None.

Member Function: TWindowInterest::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 streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws a TAssertionFailureException.

Concurrency:

In general, this class is not.

Other Considerations:

Local notification interests are not streamable. Attempting to use this operator will result in an assertion failure.

Member Function: TWindowInterest::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 streams itself in.

Return Value:

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

Exceptions:

Throws a TAssertionFailureException.

Concurrency:

In general, this class is not.

Other Considerations:

Local notification interests are not streamable. Attempting to use this operator will result in an assertion failure.

Member Function: TWindowInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this TWindowInterest.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns this TWindowInterest's hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

In general, this class is not.

Other Considerations:

None.

Member Function: TWindowInterest::GetWindow

virtual TWindow * GetWindow () const

Interface Category:

API.

Purpose:

Returns the window for which this interest object was created.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the window attribute of this TWindowInterest.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

In general, this class is not.

Other Considerations:

None.

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