All Frameworks Class Hierarchy This Framework Indexes Previous Next

ObjectModelerNavigator Interface CATINavigModify

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

interface CATINavigModify

Interface to customize tree node visualization.

Role:This interface enables you to customize the visual aspect of nodes associated with your object. If to be visualized in object tree, an object must implement the interface, this interface implementation is not mandatory. Nodes associated with an object have a default implementation of this interface, such as the and interfaces.

This implementation, full or partial, is not done on the object itself but on an object, named MyObject_node, where MyObject is the name of the object.

To implement or , it can be useful to retrieve a pointer to the object implementing . From a node, there are two steps:

Call , to retrieve a pointer (It is already the input)
Then, call to retrieve a pointer on the object associated with the node.

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 IsSelected(): Defines whether the node has ever been selected.
o ModifyShortHelp(CATUnicodeString&): Defines the node short help.
o Select(int): Defines whether the node is selectable or not.
o UpdateElem(CATNavigInstance*): Defines node graphic representation.

Methods

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

o ModifyShortHelp

public virtual ModifyShortHelp( ioText)

Defines the node short help.
Role: When you pass over a node a short help is displayed. The short help text is the text associated with the node. This text is either the name returned by the method, or if defined, the text set thanks to the method.
This method enables you to modify this default behavior defined by . You have three possibilities:

do not overwrite this method: you have the default behavior: short help + text associated with the node,
Overwrite it and return E_FAIL: no short help will be displayed,
Overwrite it and return S_OK: ioText will be the displayed text.

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

o Select

public virtual Select( iMode)

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:

iMode: The selectable mode.

o UpdateElem

public virtual UpdateElem( iInst)

Defines node graphic representation.
Role:This method enables you to modify the default visual aspect of a node. By using the interface you can:

Modify the text ( ): the default one is those returned by ,
Modify the box color ( ): the default color is blue ,
Add an icon ( ) ,
...

The interface is natively implemented on your node. You use it in the UpdateElem implementation such as:

      CATIGraphNode *pIGraphNode = NULL ;
      HRESULT rc = QueryInterface(IID_CATIGraphNode,
                        (void**)&pIGraphNode);
      if ( SUCCEEDED(rc) )
      {
          pIGraphNode->SetXXX(..);
      }

Parameters:

iInst: The navig instance associated with the node.
This parameter enables you to retrieve the component associated with the node and then to get specific information from the component.

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