Class: TSystemLayerSurrogate

Declaration: SystemWindow.h

Taxonomy Categories:

Member Functions:

TSystemLayerSurrogate
~TSystemLayerSurrogate
GetChildLayerFromName
GetContainedLayerables
operator=
GetClipArea
operator<<=
operator>>=
operator==

Interface Category:

API.

Inherits From:

TLayerableSurrogate

Inherited By:

None.

Purpose:

TSystemLayerSurrogate is a functional, heavyweight reference to a layer.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

You would not normally derive from this class. Instead derive from TLayerableSurrogate.

Concurrency: Not multithread safe.

Resource Use:

No special requirements.

Member Function: TSystemLayerSurrogate::TSystemLayerSurrogate

TSystemLayerSurrogate (const TSystemLayerSurrogate & otherLayer)
TSystemLayerSurrogate (const TLayerableReference & otherLayer)
TSystemLayerSurrogate (const TSystemLayer & otherLayer)
TSystemLayerSurrogate ()

Interface Category:

API.

Purpose:

Copy constructor.
Convert from a reference.
Convert from a real layer.
Default constructor.

Calling Context:

Called to copy an object.
Called to convert from a reference.
Called to convert from a real layer.
Called by the stream-in operators.

Parameters:

const TSystemLayerSurrogate & otherLayer -Surrogate to copy from.
const TLayerableReference & otherLayer -Reference to convert from.
const TSystemLayer & otherLayer -Real layer to convert from.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws TSystemWindowException(kReferenceToWrongLayerable) if otherLayer in constructor case (2) refers to a layer.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::~TSystemLayerSurrogate

virtual ~ TSystemLayerSurrogate ()

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:

Doesn't affect layer.

Member Function: TSystemLayerSurrogate::GetChildLayerFromName

bool GetChildLayerFromName (const TText & theName, TLayerableReference & theLayer) const

Interface Category:

API.

Purpose:

Gets a child layer by name.

Calling Context:

Called when the client needs a named layer that is a descendant of the clientÕs layer.

Parameters:

const TText & theName -The name to search for.
TLayerableReference & theLayer -A reference to the named layer. This is returned by the function.

Return Value:

Returns true if a layer with theName is found.

Exceptions:

Throws TSystemWindowException(kThisLayerableNonexistant) if the layer referred to by this surrogate does not exist.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::GetContainedLayerables

void GetContainedLayerables (TDequeOf < TLayerableReference > & dequeToFill) const

Interface Category:

API.

Purpose:

Gets the list of windows and/or layers contained by this window or layer.

Calling Context:

Call this function directly.

Parameters:

TDequeOf < TLayerableReference > & dequeToFill -The list of contained layers or windows that is filled in by the function.

Return Value:

None.

Exceptions:

Throws a TSystemWindowException(kThisLayerableNonexistant) if this window or layer does not exist.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::operator=

const TSystemLayerSurrogate & operator =(const TSystemLayerSurrogate & otherLayer)
const TSystemLayerSurrogate & operator =(const TLayerableReference & otherLayer)
const TSystemLayerSurrogate & operator =(const TSystemLayer & otherLayer)

Interface Category:

API.

Purpose:

Assignment operator.
Convert from a reference.
Convert from a real layer.

Calling Context:

Called when an object is assigned to another compatible object.
Called to convert from a reference.
Called to convert from a real layer.

Parameters:

const TSystemLayerSurrogate & otherLayer -Surrogate to copy from.
const TLayerableReference & otherLayer -Reference to convert from.
const TSystemLayer & otherLayer -Real layer to convert from.

Return Value:

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

Exceptions:

Throws TSystemWindowException(kReferenceToWrongLayerable) if otherLayer in case (2) above refers to a layer.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::GetClipArea

void GetClipArea (TGArea & clipTo) const

Interface Category:

API.

Purpose:

Gets the clip area bounds.

Calling Context:

Call this function directly.

Parameters:

TGArea & clipTo -The clip area; returned by the function.

Return Value:

None.

Exceptions:

Throws a TSystemWindowException(kThisLayerableNonexistant) if this window or layer does not exist.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in system layer surrogate objects.

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out system layer surrogate objects.

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerSurrogate::operator==

bool operator ==(const TSystemLayerSurrogate &) const

Interface Category:

API.

Purpose:

Tests for equality between this layer and the specified layer. Layers are equal if and only if their identifiers are equal.

Calling Context:

Call this function directly.

Parameters:

const TSystemLayerSurrogate & -A reference to the other layer for comparing to this layer.

Return Value:

Returns true if the identifiers for the two layers 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.