All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Interface CATIEdit

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

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


interface CATIEdit

Interface implemented by CATIA objects to react to double clicking.
Role: A double clic on a pad in the part design workshop pops up the definition dialog, and the invocation of the contextual menu on a pad makes the item "Definition ..." available under the "Object Pad.1" submenu).
This is possible because the Pad object implements CATIEdit. When double-clicked on, or activated from the "Definition ..." contextual item, a CATIA object implementing CATIEdit is callbacked on its Activate method and is then expected to start a CATCommand.
Note that before being activated via Activate, the ui-activation manager ui-activates the first ui-activable object ( CATIUIActivate ) in the immediate hierarchy of this feature.
Important notice: Using the CATExtIEdit as a base class when implementing CATIEdit is mandatroy.

BOA information: this interface can 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 Activate(CATPathElement*)
Returns the command to launch to edit the object.
o GetPanelItem(CATDialog*,CATString&)
Returns a CATDlgFrame widget representing the current feature.

Methods


o Activate
public virtual CATCommand * Activate(CATPathElement* iPath) = 0
Returns the command to launch to edit the object.
Role: Called by the ui-activation manager, see CATIUIActivate, when the user double-clics on the feature, or selects the "Definition .." sub-item on the feature's contextual menu.
Parameters:
iPath
A CATPathElement to the current feature object
Returns:
Returning the instanciated command, if any, is a good choice
See also:
CATPathElement
o GetPanelItem
public virtual CATDlgFrame * GetPanelItem(CATDialog* iParent,
const CATString& iTitle) = 0
Returns a CATDlgFrame widget representing the current feature.
Role: During a multi-selection of feature objects implementing the CATIEdit interface, it is thus possible for a command to build a compound dialog containing each selected feature's editing widget.
Parameters:
iParent
The widget that the returned CATDlgFrame must parented to.
iTitle
The title that the returned widget must have.
Returns:
A new CATPathElement, child of iParent with the title iTitle.
See also:
CATDlgFrame

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

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