AfrFoundation CATFrmLayout

Usage: you must use this class as is. You should never derive it.

public class CATFrmLayout

Class to manage a set of CATFrmWindow.
Role: This class offers a general layout of windows for applications. It supplies standard functionnalities on these windows (cascade, horizontal/vertical tile, maximize, minimize ...). During a session of CATIA the unic instance of CATFrmLayout can be obtained by using static method

See also:

Constructor and Destructor Index


o ~CATFrmLayout()

Method Index


o GetCurrentLayout()
Returns the unique CATFrmLayout created by CATIA session.
o GetCurrentWindow()
Returns the current active window.
o GetWindowList(int,int)
Returns a list of windows.
o GroupWindows(CATLISTP(CATFrmWindow)&,int)
Arrange MDI Windows - with classical window MDI, performs a tile layout on a list of MDI child windows.
o SetCurrentWindow(CATFrmWindow*)
Changes the current active window.

Enumerated Type Index


o CATFrmWindowArrange
Possible types of window arrangement in tab groups.

Constructor and Destructor


o ~CATFrmLayout
public virtual ~CATFrmLayout()

Methods


o GetCurrentLayout
public static GetCurrentLayout()
Returns the unique CATFrmLayout created by CATIA session.
o GetCurrentWindow
public GetCurrentWindow()
Returns the current active window.
o GetWindowList
public GetWindowList( iWinType=0,
iSort=0)
Returns a list of windows.
Parameters:
iWinType
the type of window to be listed.
Legal values:
  • 0 all types of window (it's the default value)
  • 1 Restored windows
    • .
  • 2 Minimized windows
    • .
    iSort
    the sort option for returned list. The sort is done according to activating time of windows.
    Legal values:
  • 0 the list is not sorted (it's the default value)
  • 1 sort in increase order (the newest is the last)
    • .
  • 2 sort in decrease order
    • .
    o GroupWindows
    public GroupWindows( iWindowList,
    iArrangementType= VerticalArrangement)
    Arrange MDI Windows - with classical window MDI, performs a tile layout on a list of MDI child windows. The other MDI child windows are minimized.
    - with MDI Tab page implementation (available from V6R2014 release only)
    --> if needed, moves all MDI child windows into one tab group.
    --> all the MDI child windows belonging to the list but the first window are moved to a new individual tab group. In both cases, the current active MDI child window remains the same. It is recommended to set it as the first element of the list.
    Parameters:
    iWindowList
    The list of MDI child windows which are going to take part in the arrangement operation.
    iArrangementType
    The type of arrangement.
    Legal values:
  • VerticalArrangement the arrangement is vertical
  • HorizontalArrangement the arrangement is horizontal
    • .
    o SetCurrentWindow
    public SetCurrentWindow( iWindow)
    Changes the current active window.
    Parameters:
    iWindow
    the window to be activated.

    Enumerated Types


    o CATFrmWindowArrange 
    enum CATFrmWindowArrange {
  VerticalArrangement,
  HorizontalArrangement
}
    Possible types of window arrangement in tab groups.
    This object is included in the file: CATFrmLayout.h
    If needed, your Imakefile.mk should include the module: CATAfrFoundation

    Copyright © 1999-2015, Dassault Systèmes. All rights reserved.