Class: TWindowGroupInterest

Declaration: WindowGroup.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 window group events. Objects who register interest in events on this window group are notified by the window group class notifier when those events occur. Interesting window group events include the showing of a content window, and the hiding or closing of the last content window.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Classes deriving from TWindowGroup may wish to provide additional notification functionality through a class deriving from TWindowGroupInterest.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TWindowGroupInterest::TWindowGroupInterest

TWindowGroupInterest (TWindowGroup * theWindowGroup, const TToken & theChange, MNotifier * theNotifier)
TWindowGroupInterest (const TWindowGroupInterest &)
TWindowGroupInterest ()

Interface Category:

API.

Purpose:

Creates a new TWindowGroupInterest 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:

TWindowGroup * theWindowGroup -The window group 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 TWindowGroupInterest & -The object to be copied.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TWindowGroupInterest::~TWindowGroupInterest

virtual ~ TWindowGroupInterest ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TWindowGroupInterest::operator=

const TWindowGroupInterest & operator =(const TWindowGroupInterest &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TWindowGroupInterest & -The source object for the assignment.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TWindowGroupInterest::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

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 a TAssertionFailureException.

Concurrency:

Multithread safe.

Other Considerations:

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

Member Function: TWindowGroupInterest::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

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 a TAssertionFailureException.

Concurrency:

Multithread safe.

Other Considerations:

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

Member Function: TWindowGroupInterest::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value for this TWindowGroupInterest.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns this TWindowGroupInterest's hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TWindowGroupInterest::GetWindowGroup

virtual TWindowGroup * GetWindowGroup () const

Interface Category:

API.

Purpose:

Returns the window group for which this interest object was created.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the window group attribute of this TWindowInterest.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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