All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATFrmLayout

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---Dialog.CATDialog
            |
            +---Dialog.CATDlgBox
              |
              +---Dialog.CATDlgFrame
                |
                +---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 GetCurrentLayout

See also:
CATFrmWindow


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 SetCurrentWindow(CATFrmWindow*)
Changes the current active window.

Constructor and Destructor


o ~CATFrmLayout
public virtual ~CATFrmLayout()

Methods


o GetCurrentLayout
public static CATFrmLayout * GetCurrentLayout()
Returns the unique CATFrmLayout created by CATIA session.
o GetCurrentWindow
public virtual CATFrmWindow * GetCurrentWindow()
Returns the current active window.
o GetWindowList
public virtual CATLISTP(CATFrmWindow) & GetWindowList(int iWinType=0,
int 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 SetCurrentWindow
    public virtual void SetCurrentWindow(CATFrmWindow* iWindow)
    Changes the current active window.
    Parameters:
    iWindow
    the window to be activated.

    This object is included in the file: CATFrmLayout.h
    If needed, your Imakefile.mk should include the module: CATApplicationFrame

    Copyright © 2003, Dassault Systèmes. All rights reserved.