Class: TLayerableReference

Declaration: SystemWindow.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractLayerableReference

Inherited By:

None.

Purpose:

Acts as a simple, copyable, lightweight reference to a window. TLayerableReference is derived from TAbstractLayerableReference. TLayerableReference provides a reference to windows and/or layers. It also lets you get the creating thread for a window. To do anything else to a window or layer, you need to create a TLayerableSurrogate derived class or TSystemLayerSurrogate. Keep in mind that a TSystemLayerSurrogate object has more run-time overhead than a TLayerableSurrogate object. TLayerableReference is not intended to be used polymorphically. As it is not multithread safe, you should create copies of it as needed.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLayerableReference::TLayerableReference

TLayerableReference (const TAbstractLayerableReference &)
TLayerableReference (const TSystemLayerable &)
TLayerableReference ()

Interface Category:

API.

Purpose:

Creates from another reference or a LayerableSurrogate.
Creates from a SystemWindow or SystemLayer.
Default constructor.

Calling Context:

Called to copy a LayerableReference or LayerableSurrogate.
Called to get a LayerableReference to a real Layerable.
Called by the stream-in operators.

Parameters:

const TAbstractLayerableReference & -A reference to either a TLayerableReference or a TLayerableSurrogate to copy from.
const TSystemLayerable & -A reference to a Real SystemWindow or a TSystemLayerable object.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLayerableReference::~TLayerableReference

virtual ~ TLayerableReference ()

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:

Has no effect on window or layer.

Member Function: TLayerableReference::operator=

TLayerableReference & operator =(const TAbstractLayerableReference &)
TLayerableReference & operator =(const TSystemLayerable &)

Interface Category:

API.

Purpose:

Copy from another reference.
Copy from a real Layerable.

Calling Context:

Called to copy from another reference.
Called to copy from real layerable.

Parameters:

const TAbstractLayerableReference & -Other reference to copy from.
const TSystemLayerable & -Real window or layer to copy from.

Return Value:

Left side reference to this.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLayerableReference::GetOwningThread

virtual void GetOwningThread (TThreadHandle & theThread) const

Interface Category:

API.

Purpose:

Gets the thread that created the window.

Calling Context:

Called when a client needs the thread that created the window and to whom the window belongs. Generally, this is called by the WindowServer.

Parameters:

TThreadHandle & returnedThread -A reference to the owning thread. This value is filled in by the function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLayerableReference::operator==

bool operator ==(const TLayerableReference &) const

Interface Category:

API.

Purpose:

Determines whether this TLayerableReference window object is equal to the other specified TLayerableReference window object. Windows are equal if and only if their identifiers are equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TLayerableReference & -A reference to another TLayerableReference window object for the comparison.

Return Value:

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

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.