All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ObjectModelerNavigator Interface CATIGraphNode

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIGraphNode

Interface to customize graph's nodes physical representation.
Role: This interface is automatically implemented on tree nodes. If you use the CATIGraphNode methods in the CATINavigModify.UpdateElem method, the update of the node is automatically done, otherwise call the CATINavigElement.Update method to refresh the visualization.

A node is a text with or without:


Method Index


o AddMask(CATUnicodeString&,int,int,int)
Adds a mask on an icon.
o GetContextualMenu()
Retrieves node contextual menu.
o GetFillStyle()
Retrieves node background mode.
o GetIndexedChildLink(int)
Returns a child link by its index.
o GetIndexedFatherLink(int)
Returns a father link by its index.
o GetNbChildLinks()
Returns number of child links.
o GetNbFatherLinks()
Returns number of father links.
o GetPixelImage()
Returns the pixel image associated with the node.
o GetUnderlineMode()
Retrieves node underline mode.
o IsDecorated()
Retrieves node frame mode.
o IsExpanded()
Retrieves node expand mode.
o IsHighlighted()
Retrieves node highlight mode.
o IsShadowOut()
Retrieves node frame shadow mode.
o RemoveAllMasks()
Removes all masks of an icon.
o RemoveLastMask()
Removes last mask of an icon.
o SetColor(int)
Sets node color.
o SetDecoration(int)
Sets node frame mode.
o SetFillStyle(int)
Sets node background mode.
o SetHighlight(int)
Sets node highlight mode.
o SetPixelImage(CATUnicodeString&)
Sets icon on the node.
o SetShadowOut(int)
Sets node frame shadow mode.
o SetText(CATListValCATUnicodeString&)
Sets node text.
o SetUnderlineMode(int)
Sets node underline mode.
o UpdateState(CATNavigNodeState)
Sets node expand mode.

Methods


o AddMask
public virtual void AddMask( const CATUnicodeString& iFile,
int XVal,
int YVal,
int TransVal=0)=0
Adds a mask on an icon.
Parameters:
iFile
path of the mask to add
XVal
coordinate of mask ( usually 0 )
YVal
coordinate of mask ( usually 0 )
TransVal
Flag to activate the transparency of the mask.
  • if TransVal=0, the mask is completely opaque.
  • if TransVal=1, the mask is transparent for all pixels which have the same color than this one on the top left.
o GetContextualMenu
public virtual CATDlgContextualMenu* GetContextualMenu()=0
Retrieves node contextual menu.
Role:This method is useful to modify the default contextual menu associated with a node. In the CATINavigElement.ProcessAfterMethod you can call this method and add items to the returned menu.
Returns:
The node contextual menu.
o GetFillStyle
public virtual int GetFillStyle()=0
Retrieves node background mode.
Returns:
The background mode.
Legal values: 1: The background is filled, 0: otherwise.
o GetIndexedChildLink
public virtual CATIGraphLink* GetIndexedChildLink(int index)=0
Returns a child link by its index.
Parameters:
iIndex
The index of the link Returned pointer must be released.
o GetIndexedFatherLink
public virtual CATIGraphLink* GetIndexedFatherLink(int iIndex)=0
Returns a father link by its index.
Parameters:
iIndex
The index of the link Returned pointer must be released.
o GetNbChildLinks
public virtual int GetNbChildLinks()=0
Returns number of child links.
o GetNbFatherLinks
public virtual int GetNbFatherLinks()=0
Returns number of father links.
o GetPixelImage
public virtual const CATPixelImage* GetPixelImage()=0
Returns the pixel image associated with the node.
o GetUnderlineMode
public virtual int GetUnderlineMode()=0
Retrieves node underline mode.
Returns:
The node underline mode.
Legal values: 1: The text is underlined 0: otherwise
o IsDecorated
public virtual int IsDecorated()=0
Retrieves node frame mode.
Returns:
The node frame mode.
Legal values: 1: The node has a frame, 0: otherwise.
o IsExpanded
public virtual int IsExpanded()=0
Retrieves node expand mode.
Returns:
The expand node mode.
Legal values: 1: The node is expanded 0: The node is collapsed
o IsHighlighted
public virtual int IsHighlighted()=0
Retrieves node highlight mode.
Returns:
The highlight mode.
Legal values: 1: The node is highlighted, 0: otherwise.
o IsShadowOut
public virtual int IsShadowOut()=0
Retrieves node frame shadow mode.
Returns:
The frame shadow mode.
Legal values: 1: The icon has a shadow, 0: otherwise.
o RemoveAllMasks
public virtual void RemoveAllMasks()=0
Removes all masks of an icon.
o RemoveLastMask
public virtual int RemoveLastMask()=0
Removes last mask of an icon.
Returns:
0 if succeeded
-1 otherwise.
o SetColor
public virtual void SetColor(int iCouleur)=0
Sets node color.
Role:This method enables you to modify the background color of the text. The text color being automatically computed to have enought contrast.
This color is useless if the node is without background, i.e. the GetFillStyle method returns 0.
Parameters:
iCouleur
The index of the color.
Legal values:iCouleur ranges from 0 to 255. You can use the CATColorMap#GetColor method to retrieve the r,g and b components associated with an index color.
o SetDecoration
public virtual void SetDecoration(int iMode)=0
Sets node frame mode.
Role:This method enables you to set or not a frame around the text of the node.
Parameters:
iMode
The node frame mode.
Legal values: 1: The node has a frame, 0: otherwise.
o SetFillStyle
public virtual void SetFillStyle(int iFill)=0
Sets node background mode.
Role:This method enables you to set or not a background behind the text. The color of the background being defined by the SetColor method.
Parameters:
iFill
The background mode
Legal values: 1: The background is filled, 0: otherwise.
o SetHighlight
public virtual void SetHighlight(int iMode)=0
Sets node highlight mode.
Parameters:
iMode
The highlight mode.
Legal values: 1: The node has to be highlighted, 0: otherwise.
o SetPixelImage
public virtual void SetPixelImage( const CATUnicodeString& iChaine)=0
Sets icon on the node.
Parameters:
iChaine
The name of the icon.
o SetShadowOut
public virtual void SetShadowOut(int iMode)=0
Sets node frame shadow mode.
Role:This method enables you to set or not a shadow on the frame. The value of this mode is useless if the node is without frame, i.e. the IsDecorated method returns 0.
Parameters:
iMode
The frame shadow mode.
Legal values: 1: The frame has a shadow, 0: otherwise.
o SetText
public virtual void SetText( const CATListValCATUnicodeString& iText)=0
Sets node text.
Role:This method enables you to modify the text associated with the node. The default text being the text returned by the CATINavigateObject.GetIdentificators method.
However, modify the text should be used temporary, because the Search mechanism is based on the text returned by the CATINavigateObject.GetIdentificators method.
Parameters:
iText
The text associated to node. There are as many strings as lines.
o SetUnderlineMode
public virtual void SetUnderlineMode(int iMode)=0
Sets node underline mode.
Parameters:
iMode
The node underline mode.
Legal values: 1: The text is underlined 0: otherwise
o UpdateState
public virtual void UpdateState(CATNavigNodeState iState)=0
Sets node expand mode.
Parameters:
iState
The node state.

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

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