Class: TAbstractLayerableReference

Declaration: SystemWindow.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TLayerableReference TLayerableSurrogate

Purpose:

TAbstractLayerableReference is the abstract base for windows and layers.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

The system window and layer classes derive from this abstract base. You should override GetOwningTask & GetOwningThread.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::TAbstractLayerableReference

TAbstractLayerableReference (const TAbstractLayerableReference &)
TAbstractLayerableReference ()

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.

Calling Context:

Called to copy an object.
Called by the stream-in operators.

Parameters:

const TAbstractLayerableReference & -A reference to the object to copy.
Takes no parameters.
WindowID -The identifier of a window.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::~TAbstractLayerableReference

virtual ~ TAbstractLayerableReference ()

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

TAbstractLayerableReference & operator =(const TAbstractLayerableReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAbstractLayerableReference & -The object that is to be assigned to this object.

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

bool operator ==(const TAbstractLayerableReference &) const

Interface Category:

API.

Purpose:

Tests for equality between this window or layer and the specified one. They are only equal if and only if their identifiers are equal.

Calling Context:

Call this function directly.

Parameters:

const TAbstractLayerableReference & -A reference to the other window or layer for the comparison.

Return Value:

Returns true if the identifiers are equal; otherwise, returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::GetOwningThread

virtual void GetOwningThread (TThreadHandle & returnedThread) const

Interface Category:

API.

Purpose:

Returns a reference to the thread that owns this window or layer.

Calling Context:

Call this function directly.

Parameters:

TThreadHandle & returnedThread -A reference to the owning thread which is returned by the function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the window identifier.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the window identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::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 no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::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 no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAbstractLayerableReference::SetOwningThread

void SetOwningThread (const TThreadHandle & Thread)

Interface Category:

API.

Purpose:

Sets the specified thread as the thread that owns the window or layer.

Calling Context:

Call this function directly to change the thread that owns the window or layer.

Parameters:

const TThreadHandle & Thread -A reference to the new thread that is to own the window or layer.

Return Value:

None.

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.