ObjectModelerNavigator 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 and
and
interfaces.
BEWARE:
- You must call a method through its interface. For example, if you want to call
, first query the interface
and then call its method
.
- You must use the DataExtension mode.
Constructor and Destructor Index
- o
CATNodeExtension()
- Constructs a 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.
Methods
o GetAssociatedInstance
| public virtual 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:
-
o GetController
| public virtual GetController( | ) |
-
Retrieves the tree controller.
- Returns:
- The tree controller.
Lifecycle rules deviation: This method doesn't AddRef the
returned value.
- See also:
-
o GetExpansionMode
| public virtual GetExpansionMode( | | oExpansionMode) |
-
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 GetFatherContainer( | ) |
-
Returns the father container.
Returned pointer must be released.
o IsSelected
| public virtual 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:
-
o ModifyShortHelp
| public virtual ModifyShortHelp( | | 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
method, or if defined, the text set thanks to the
method.
- Parameters:
-
- ioText
- The short help of the node.
In input ioText is the text associated with the node.
- Returns:
- The displaying state.
Legal values:
- E_FAIL: no short help will be displayed
- S_OK : ioText will be displayed
- See also:
-
o ProcessAfterAction
| public virtual ProcessAfterAction( | ) |
-
Defines behavior after double-click of this node.
Role:This method calls the
method.
- See also:
-
o ProcessAfterExpand
| public virtual ProcessAfterExpand( | ) |
-
Defines behavior after expand of this node.
Role:This method expands or collapses the node.
- See also:
-
o ProcessAfterExtSelect
| public virtual ProcessAfterExtSelect( | ) |
-
Defines behavior after selection of several nodes.
Role:This method pre-highlights the node.
- See also:
-
o ProcessAfterMethod
| public virtual ProcessAfterMethod( | ) |
-
Defines the contextual menu after selecting a node.
Role:This method does nothing.
- See also:
-
o ProcessAfterSelect
| public virtual ProcessAfterSelect( | ) |
-
Defines behavior after selection of this node.
Role:This method highlights the node.
- See also:
-
o Select
| public virtual Select( | | 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:
-
o Update
-
Updates node.
Role:This method updates the text, the icon,
and the children nodes (creation/deletion).
- See also:
-
o UpdateElem
| public virtual UpdateElem( | | iInst) |
-
Defines node graphic representation.
Role:This method is empty.
- Parameters:
-
- iInst
- The navig instance associated with the node.
- See also:
-
This object is included in the file: CATNodeExtension.h
If needed, your Imakefile.mk should include the module: CATObjectModelerNavigator
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.