All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerNavigator Interface CATINavigNodeCtrl

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATINavigNodeCtrl
 

Usage: you can reimplement this interface by deriving the supplied CATNodeExtension adapter class.


interface CATINavigNodeCtrl

Interface to manage tree node expansion.
Role: This interface enables you to override the default expansion behaviour.

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter). To know more about the BOA, refer to the CAA Encyclopedia home page. Click Middleware at the bottom left, then click the Object Modeler tab page. Several articles deal with the BOA.


Method Index


o Dereference(int)
Looks for children and creates child nodes and expands them if necessary.
o GetExpansionMode(CATINavigNodeCtrl::ExpansionMode&)
Gets the expansion mode.
o Undereference()
Collapses the node.

Enumerated Type Index


o ExpansionMode
Mode of expansion of a node.

Methods


o Dereference
public virtual void Dereference(int iDepth)=0
Looks for children and creates child nodes and expands them if necessary.
Parameters:
iDepth
The depth until which expands the graph.
o GetExpansionMode
public virtual void GetExpansionMode(CATINavigNodeCtrl::ExpansionMode& oExpansionMode) const = 0
Gets the expansion mode.
The expansion mode is taken into account by Dereference .
Parameters:
oExpansionMode
The expansion mode.
o Undereference
public virtual void Undereference()=0
Collapses the node.

Enumerated Types


o ExpansionMode
enum ExpansionMode {
  NotExpandable,
  Expandable,
  ExpandableIfWithChild
}
Mode of expansion of a node.
Parameters:
NotExpandable
Children are never looked for. There's no activator (+)/(-) shown on the left of the node.
Expandable
Children are not looked for as long as the node is collapsed. The activator (+) is shown on the left of the node. Once the node is expanded, the node is treated like with ExpandableIfWithChild.
ExpandableIfWithChild
The children are looked for.
  • If no child has been found, no activator is shown.
  • If at least one child has been found, an activator (+) is shown if the node is collapsed, and an activator (-) is shown if the node is expanded.

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

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