ObjectModelerNavigator Interface 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 method, the update of the node is automatically done, otherwise call the
method to refresh the visualization.
A node is a text with or without:
- A fill background:
- A frame around:
- A frame shadow:
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 AddMask( | const | iFile, |
| | XVal, |
| | YVal, |
| | TransVal | =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 GetContextualMenu( | ) |
-
Retrieves node contextual menu.
Role:This method is useful to modify the default contextual menu associated
with a node. In the
you can call this method and add items to the returned menu.
- Returns:
- The node contextual menu.
o GetFillStyle
| public virtual GetFillStyle( | ) |
-
Retrieves node background mode.
- Returns:
- The background mode.
Legal values: 1: The background is filled,
0: otherwise.
o GetIndexedChildLink
| public virtual GetIndexedChildLink( | | iIndex) |
-
Returns a child link by its index.
- Parameters:
-
- iIndex
- The index of the link
- Returns:
- The child link
Returned pointer must be released.
o GetIndexedFatherLink
| public virtual GetIndexedFatherLink( | | iIndex) |
-
Returns a father link by its index.
- Parameters:
-
- iIndex
- The index of the link
- Returns:
- The father link
Returned pointer must be released.
o GetNbChildLinks
| public virtual GetNbChildLinks( | ) |
-
Returns number of child links.
- Returns:
- The number of child links
o GetNbFatherLinks
| public virtual GetNbFatherLinks( | ) |
-
Returns number of father links.
- Returns:
- The number of father links
o GetPixelImage
| public virtual GetPixelImage( | ) |
-
Returns the pixel image associated with the node.
- Returns:
- The pixel image.
o GetUnderlineMode
| public virtual GetUnderlineMode( | ) |
-
Retrieves node underline mode.
- Returns:
- The node underline mode.
Legal values: 1: The text is underlined
0: otherwise
o IsDecorated
| public virtual IsDecorated( | ) |
-
Retrieves node frame mode.
- Returns:
- The node frame mode.
Legal values: 1: The node has a frame,
0: otherwise.
o IsExpanded
| public virtual IsExpanded( | ) |
-
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 IsHighlighted( | ) |
-
Retrieves node highlight mode.
- Returns:
- The highlight mode.
Legal values: 1: The node is highlighted,
0: otherwise.
o IsShadowOut
| public virtual IsShadowOut( | ) |
-
Retrieves node frame shadow mode.
- Returns:
- The frame shadow mode.
Legal values: 1: The icon has a shadow,
0: otherwise.
o RemoveAllMasks
| public virtual RemoveAllMasks( | ) |
-
Removes all masks of an icon.
o RemoveLastMask
| public virtual RemoveLastMask( | ) |
-
Removes last mask of an icon.
- Returns:
- 0 if succeeded
-1 otherwise.
o SetColor
| public virtual SetColor( | | iCouleur) |
-
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
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 SetDecoration( | | iMode) |
-
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 SetFillStyle( | | iFill) |
-
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
method.
- Parameters:
-
- iFill
- The background mode
Legal values: 1: The background is filled,
0: otherwise.
o SetHighlight
| public virtual SetHighlight( | | iMode) |
-
Sets node highlight mode.
- Parameters:
-
- iMode
- The highlight mode.
Legal values: 1: The node has to be highlighted,
0: otherwise.
o SetPixelImage
| public virtual SetPixelImage( | const | iChaine) |
-
Sets icon on the node.
- Parameters:
-
- iChaine
- The name of the icon.
o SetShadowOut
| public virtual SetShadowOut( | | iMode) |
-
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
method returns 0.
- Parameters:
-
- iMode
- The frame shadow mode.
Legal values: 1: The frame has a shadow,
0: otherwise.
o SetText
| public virtual SetText( | const | iText) |
-
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
method.
However, modify the
text should be used temporary, because the Search mechanism is based on
the text returned by the
method.
- Parameters:
-
- iText
- The text associated to node. There are as many strings as lines.
o SetUnderlineMode
| public virtual SetUnderlineMode( | | iMode) |
-
Sets node underline mode.
- Parameters:
-
- iMode
- The node underline mode.
Legal values: 1: The text is underlined
0: otherwise
o UpdateState
| public virtual UpdateState( | | iState) |
-
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 © 1999-2014, Dassault Systèmes. All rights reserved.