Class: TGUIWindowArranger

Declaration: GUICompoundDocument.h

Taxonomy Categories:

Member Functions:

TGUIWindowArranger
~TGUIWindowArranger
StaggerWindow
CenterWindow
ForceWindowOnDesktop
GetNextStaggerIndex

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Encapsulates knowledge about how to arrange windows on the desktop.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGUIWindowArranger::TGUIWindowArranger

TGUIWindowArranger ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by the Presentation framework.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIWindowArranger::~TGUIWindowArranger

virtual ~ TGUIWindowArranger ()

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: TGUIWindowArranger::StaggerWindow

virtual void StaggerWindow (TWindow & window) const

Interface Category:

API.

Purpose:

Staggers windows on the desktop according to the HI guidelines. Adjusts the size and location of the argument. Designed for document content windows.

Calling Context:

Call this function directly.

Parameters:

TWindow & window -The window to stagger.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIWindowArranger::CenterWindow

virtual void CenterWindow (TWindow & window) const

Interface Category:

API.

Purpose:

Centers the window on the desktop according to the HI guidelines. Adjusts the size and location of the argument. Designed for alert windows.

Calling Context:

Call this function directly.

Parameters:

TWindow & window -The window to center.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIWindowArranger::ForceWindowOnDesktop

virtual void ForceWindowOnDesktop (TWindow & window) const

Interface Category:

API.

Purpose:

Used to ensure that a window is entirely visible on the desktop. Will move and resize the window if necessary to ensure that all of the window is visible.

Calling Context:

Call this function directly.

Parameters:

TWindow & window -The window to force onto the desktop.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TGUIWindowArranger::GetNextStaggerIndex

unsigned long GetNextStaggerIndex ()

Interface Category:

API.

Purpose:

Used internally by the stagger policy to obtain the next stagger index. The stagger index starts at zero, and increments by one for each window that is staggered. Right now the index is separate for each task, but in the future this will probably be changed so that all tasks use the same stagger index.

Calling Context:

Called by StaggerWindow.

Parameters:

Takes no parameters.

Return Value:

Returns the next stagger index.

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.