All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

CATIAApplicationFrame Class CATNavigBox

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---System.CATCommand
          |
          +---CATNavigBox
 

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


public class CATNavigBox

Classe to create a windows owning a graph.


Constructor and Destructor Index


o CATNavigBox(CATDialog*,CATString&,CATFrmEditor*,CATGraphStyle,CATClassId,int,int,CATViewer*,CAT2DViewpoint*)
Constructs a CATNavigBox.
o ~CATNavigBox()

Method Index


o AddRoot(CATBaseUnknown_var&)
Adds root node to the graphe.
o GetAllRoots()
Returns list of all roots.
o GetController()
Returns controller.
o GetOverviewVisibility()
Returns overview visibility.
o RemoveAllRoots()
Removes all roots.
o RemoveRoot(CATBaseUnknown_var&)
Removes root node.
o SetOverviewVisibility(int)
Sets overview visibility.

Constructor and Destructor


o CATNavigBox
public CATNavigBox(CATDialog* iFather,
const CATString& iName,
CATFrmEditor* iEditor=NULL,
CATGraphStyle iStyle=Indented,
CATClassId id="ObjNavDefault",
int width=500,
int height=300,
CATViewer* associated_viewer=0,
CAT2DViewpoint* assoc_vp=NULL)
Constructs a CATNavigBox.
Parameters:
iFather
father dialog for navigation window.
iName
name to give to the CATNavigBox.
iEditor
editor of the window where is the graph.
iStyle
Indented ( usual foe CATIA )
id
very important. Specifies which extension of CATINavigateObject has to be used.
if we need CATINavigateObject_ForCAA2, id has to be ForCAA2
o ~CATNavigBox
public virtual ~CATNavigBox()

Methods


o AddRoot
public void AddRoot( const CATBaseUnknown_var& iRoot)
Adds root node to the graphe.
Parameters:
iRoot
root to add.
o GetAllRoots
public CATListValCATBaseUnknown_var* GetAllRoots()const
Returns list of all roots. After use, the returned list must be destroyed.
o GetController
public CATNavigController* GetController()const
Returns controller.
o GetOverviewVisibility
public int GetOverviewVisibility()
Returns overview visibility.
o RemoveAllRoots
public void RemoveAllRoots()
Removes all roots.
o RemoveRoot
public void RemoveRoot( const CATBaseUnknown_var& iRoot)
Removes root node.
Parameters:
iRoot
root to remove.
o SetOverviewVisibility
public void SetOverviewVisibility(int iEtat)
Sets overview visibility.
Parameters:
iEtat
if 1 then true
else false.

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

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