ObjectModelerNavigator Interface CATINavigateObject
Usage: you can freely reimplement this interface.
interface CATINavigateObject
Interface to navigate in object tree.
Role: This interface enables you to visualize a component in an object tree. This interface
implementation is mandatory, even if the component is a leaf. In this case, the method returns an empty list.
Once you have implemented this interface, you may customize default behaviors
for the node representing your component. Refer to the
and the
interfaces. Note that contrary to CATINavigateObject, the implementation of these two interfaces is not mandatory.
This interface is called in the following contexts:
- When the node is redrawn, thanks to the
interface:
and
methods are then called.
- When the node is expanded:
and
methods are then called.
- When the node is collapsed: only
method is called.
This interface can be also used to "dump" the contents of an existing object tree.
Method Index
- o
GetChildren()
- Retrieves list of direct childrens in the tree.
- o
GetIdentificators()
- Retrieves the node text.
Methods
o GetChildren
| public virtual GetChildren( | ) |
-
Retrieves list of direct childrens in the tree.
- Returns:
- The children list.
The CATINavigateObject interface will be called for each one. This list
is empty if the node is a leaf.
o GetIdentificators
| public virtual GetIdentificators( | ) |
-
Retrieves the node text.
Role:This method retrieves the
text associated with the node. This text is used as reference for
the graph name criterion of the Search mechanism. Refer to
the CATIIniSearchGraphNameCriterion interface.
- Returns:
- The text of the node. There are as many strings as lines.
This object is included in the file: CATINavigateObject.h
If needed, your Imakefile.mk should include the module: CATObjectModelerNavigator
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.