All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrInterfaces Interface CATIContextualSubMenu

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

interface CATIContextualSubMenu

Interface to add menu item in the contextual menu.
Role:This interface allows you to add command which appears in the < xxx > object menu of the contextual menu. The xxx object must also implement the interface.
To do this, we create and arrange command starters that we associate with commands using command headers. These command headers are defined in the workshop of the document.
All the starters are chained together to form a sub menu.
The life cycle of the sub menu
In each implementation of this interface, the sub menu must be a data member to manage its life cycle. It can be identical or different from a call to GetContextualSubMenu to another.

If it is identical, it can be created in the constructor, returned in the GetContextualSubMenu method, and deleted in the destructor.
Otherwise, it must be created in the GetContextualSubMenu method. To correctly manage its life cycle, it must be deleted:
- whenever calling GetContextualSubMenu
- in the destructor when the class itself is deleted

BOA information: this interface CANNOT be implemented using the BOA (Basic Object Adapter).

Important notice: Using the as a base class when implementing CATIContextualSubMenu is advised. Since CATIContextualSubMenu used to be "U5" exposed, it will not be modified.

Method Index

o GetContextualSubMenu(): Returns the sub menu access.

Methods

o GetContextualSubMenu

public virtual GetContextualSubMenu(

)

Returns the sub menu access.

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