AfrNavigator 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( iFather,
const iName,
iEditor=NULL,
iStyle=Indented,
id="ObjNavDefault",
width=500,
height=300,
associated_viewer=0,
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 AddRoot( const iRoot)
Adds root node to the graphe.
Parameters:
iRoot
root to add.
o GetAllRoots
public GetAllRoots()
Returns list of all roots. After use, the returned list must be destroyed.
o GetController
public GetController()
Returns controller.
o GetOverviewVisibility
public GetOverviewVisibility()
Returns overview visibility.
o RemoveAllRoots
public RemoveAllRoots()
Removes all roots.
o RemoveRoot
public RemoveRoot( const iRoot)
Removes root node.
Parameters:
iRoot
root to remove.
o SetOverviewVisibility
public SetOverviewVisibility( 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: CATAfrNavigator

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