Class: TSystemLayerable

Declaration: SystemWindow.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TSystemLayer TSystemWindow

Purpose:

This is an abstract base for a real window or layer.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Both TSystemWindow and TSystemLayer derive from TSystemLayerable. You should override GetSurrogate.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TSystemLayerable::~TSystemLayerable

virtual ~ TSystemLayerable ()

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:

Removes the window or layer from the system.

Member Function: TSystemLayerable::BringToFront

void BringToFront ()

Interface Category:

API.

Purpose:

Brings this window or layer to the front of its containing layer.

Calling Context:

Called by a client to move the window or layer in front of the other windows or layers in the containing layer.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws TSystemWindowException(kOtherLayerableNonexistant) if there is no other window in the containing layer.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::SendToBack

void SendToBack ()

Interface Category:

API.

Purpose:

Sends this window or layer to the back of the containing layer.

Calling Context:

Called by a client to move the window or layer behind all the others in the containing layer.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws TSystemWindowException(kOtherLayerableNonexistant) if there is no other window in the containing layer.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::MoveToFrontOf

bool MoveToFrontOf (const TAbstractLayerableReference & aWindow, bool reparentWindow =false)

Interface Category:

API.

Purpose:

Brings this window or layer in front of another specified window or layer.

Calling Context:

Called by a client to move the window or layer in front of another specified window or layer.

Parameters:

const TAbstractLayerableReference & aWindow -A reference to the other window or layer to move in front of.
bool doReparent =false -Set to false if the client wants the window or layer to remain in the same layer.

Return Value:

None.

Exceptions:

Throws TSystemWindowException(kOtherLayerableNonexistant) if the window referred to by aWindow does not exist.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::MoveToBackOf

bool MoveToBackOf (const TAbstractLayerableReference & aWindow, bool reparentWindow =false)

Interface Category:

API.

Purpose:

Sends this window or layer behind another.

Calling Context:

Called by a client to move the window or layer behind another specified window or layer.

Parameters:

const TAbstractLayerableReference & aWindow -Other window or layer to move behind.
bool doReparent =false -Set to false if client wants to remain in same layer.

Return Value:

None.

Exceptions:

Throws TSystemWindowException(kOtherLayerableNonexistant) if the window referred to by aWindow does not exist.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::PutInLayer

void PutInLayer (TSystemLayerSurrogate & newLayer, bool onTop =true)

Interface Category:

API.

Purpose:

Moves this window or layer to another layer.

Calling Context:

Called when the client wants to put this window or layer within another layer.

Parameters:

TSystemLayerSurrogate & newLayer -Other layer to which to add this window or layer.
bool onTop =true -Set to true if this window or layer is to be added to the top of the new layer.

Return Value:

Returns true if successful.

Exceptions:

Throws a TSystemWindowException(kOtherLayerableNonexistant) exception if newLayer does not exist.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::PutInDesktopLayer

void PutInDesktopLayer (bool onTop =true)

Interface Category:

API.

Purpose:

Moves this window or layer to the root layer.

Calling Context:

Called when the client wants to put this window or layer in the root layer.

Parameters:

bool onTop =true -Set to true if the window or layer is to be on top of others in the layer; otherwise, set to false if the window or layer is to be behind all the others.

Return Value:

Returns true if successful.

Exceptions:

Throws a TSystemWindowException(kOtherLayerableNonexistant) exception if the root layer does not exist.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::Hide

void Hide ()

Interface Category:

API.

Purpose:

Hides the window or layer.

Calling Context:

Called when a client wants to make a window or layer invisible.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::Show

void Show ()

Interface Category:

API.

Purpose:

Shows the window or layer.

Calling Context:

Called when the client wants to make the window or layer visible.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::SetVisibility

void SetVisibility (bool makeVisible)

Interface Category:

API.

Purpose:

Sets the visibility state of the window or layer.

Calling Context:

Called to change the visibility of the window or layer.

Parameters:

bool makeVisible -Set to true to make the window or layer visible.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::CreateInterest

virtual TInterest * CreateInterest (const TToken & theChange) const

Interface Category:

API.

Purpose:

Creates a TSystemWindowInterest in this window.

Calling Context:

Called by a client who wants to receive notification about this window.

Parameters:

const TToken & theChange -The notification type that the client is interested in, and for which notification is sent.

Return Value:

A pointer to a TSystemWindowInterest.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::GetSurrogate

virtual const TLayerableSurrogate & GetSurrogate () const
virtual TLayerableSurrogate & GetSurrogate ()

Interface Category:

API.

Purpose:

Gets a const TLayerableSurrogate.
Gets a reference to TLayerableSurrogate.

Calling Context:

Called to return the const object.
Called to return a reference to the object.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns either the left-side const TLayerableSurrogate or a reference to TLayerableSurrogate.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::TSystemLayerable

TSystemLayerable ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the stream-in operators.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::IsValid

bool IsValid () const

Interface Category:

API.

Purpose:

Checks if this is a valid window, which means it has a valid identifier.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if the window has a valid identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSystemLayerable::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: TSystemLayerable::GetContainingLayer

TLayerableReference GetContainingLayer () const

Interface Category:

API.

Purpose:

Returns the layer that contains this window or layer.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the TLayerableReference containing layer for this window or layer.

Exceptions:

Throws a TSystemWindowException(kOtherLayerableNonexistant) exception if the containing layer does not exist.

Concurrency:

Multithread safe.

Other Considerations:

None.

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