All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

ObjectModelerNavigator Class CATNodeExtension

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

Usage: you can derive this class.


public class CATNodeExtension

Adapter class for CATINavigElement and CATINavigModify and CATINavigNodeCtrl interfaces.
Role: This class enables you to implement the CATINavigElement and CATINavigModify and CATINavigNodeCtrl interfaces.
BEWARE:
- You must call a method through its interface. For example, if you want to call GetExpansionMode , first query the interface CATINavigNodeCtrl and then call its method CATINavigNodeCtrl.GetExpansionMode .
- You must use the DataExtension mode.


Constructor and Destructor Index


o CATNodeExtension()
Constructs a CATNodeExtension.
o ~CATNodeExtension()

Method Index


o GetAssociatedInstance()
Retrieves the instance associated with the node.
o GetController()
Retrieves the tree controller.
o GetExpansionMode(CATINavigNodeCtrl::ExpansionMode&)
Gets the expansion mode.
o GetFatherContainer()
Returns the father container.
o IsSelected()
Defines whether the node has ever been selected.
o ModifyShortHelp(CATUnicodeString&)
Defines the node short help.
o ProcessAfterAction()
Defines behavior after double-click of this node.
o ProcessAfterExpand()
Defines behavior after expand of this node.
o ProcessAfterExtSelect()
Defines behavior after selection of several nodes.
o ProcessAfterMethod()
Defines the contextual menu after selecting a node.
o ProcessAfterSelect()
Defines behavior after selection of this node.
o Select(int)
Defines whether the node is selectable or not.
o Update()
Updates node.
o UpdateElem(CATNavigInstance*)
Defines node graphic representation.

Constructor and Destructor


o CATNodeExtension
public CATNodeExtension()
Constructs a CATNodeExtension.
o ~CATNodeExtension
public virtual ~CATNodeExtension()

Methods


o GetAssociatedInstance
public virtual CATNavigInstance* GetAssociatedInstance()
Retrieves the instance associated with the node.
Role: This method retrieves the object associated with the node.
Returns:
The associated instance.
Lifecycle rules deviation: This method doesn't AddRef the returned value.
See also:
CATINavigElement
o GetController
public virtual const CATNavigController* GetController()
Retrieves the tree controller.
Returns:
The tree controller.
Lifecycle rules deviation: This method doesn't AddRef the returned value.
See also:
CATINavigElement
o GetExpansionMode
public virtual void GetExpansionMode(CATINavigNodeCtrl::ExpansionMode& oExpansionMode) const
Gets the expansion mode.
The default is ExpandableIfWithChild. You may override this method in order to return your expansion mode.
Parameters:
oExpansionMode
The expansion mode.
o GetFatherContainer
public virtual CATINavigContainer* GetFatherContainer()
Returns the father container. Returned pointer must be released.
o IsSelected
public virtual int IsSelected()
Defines whether the node has ever been selected.
Returns:
The selecting state.
Legal values:
  • 0: The node is not selected
  • Otherwise : selected
See also:
CATINavigModify
o ModifyShortHelp
public virtual HRESULT ModifyShortHelp(CATUnicodeString& ioText)
Defines the node short help.
Role: This method defines the default behavior for the short help of a node. When you pass over a node a short help is displayed whose the text is either the name returned by the CATINavigateObject.GetIdentificators method, or if defined, the text set thanks to the CATIGraphNode.SetText method.
Parameters:
ioText
The short help of the node.
In input ioText is the text associated with the node.
See also:
CATINavigModify
o ProcessAfterAction
public virtual void ProcessAfterAction()
Defines behavior after double-click of this node.
Role:This method calls the ProcessAfterExpand method.
See also:
CATINavigElement
o ProcessAfterExpand
public virtual void ProcessAfterExpand()
Defines behavior after expand of this node.
Role:This method expands or collapses the node.
See also:
CATINavigElement
o ProcessAfterExtSelect
public virtual void ProcessAfterExtSelect()
Defines behavior after selection of several nodes.
Role:This method pre-highlights the node.
See also:
CATINavigElement
o ProcessAfterMethod
public virtual void ProcessAfterMethod()
Defines the contextual menu after selecting a node.
Role:This method does nothing.
See also:
CATINavigElement
o ProcessAfterSelect
public virtual void ProcessAfterSelect()
Defines behavior after selection of this node.
Role:This method highlights the node.
See also:
CATINavigElement
o Select
public virtual void Select(int mode)
Defines whether the node is selectable or not.
Note: This method enables you to control the node selection. The default behavior brings the node selectionnable.
Parameters:
mode
The selectable mode.
See also:
CATINavigModify
o Update
public virtual void Update()
Updates node.
Role:This method updates the text, the icon, and the children nodes (creation/deletion).
See also:
CATINavigElement
o UpdateElem
public virtual void UpdateElem(CATNavigInstance* iInst)
Defines node graphic representation.
Role:This method is empty.
Parameters:
iInst
The navig instance associated with the node.
See also:
CATINavigModify

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

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