All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATExtIEdit

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

Usage: you can derive this class.


public class CATExtIEdit

Adapter for the CATIEdit interface .
Role : This base class provides usefull services making the management of the life cycle of the command returned by the CATIEdit.Activate method easier.
The CATExtIEdit class provides the IsActive method that tells whether the CATCommand instance returned by the CATIEdit.Activate method is in the active state or not.
Implementing CATIEdit just consists in subclassing the CATExtIEdit class and simply overriden the Activate or the GetPanelItem or both methods. Do not forget to implement the CATIEdit interface using : CATImplementBOA(CATIEdit, CATExtIEdit).


Constructor and Destructor Index


o CATExtIEdit()
Constructs the class.
o ~CATExtIEdit()

Method Index


o Activate(CATPathElement*)
Returns the command to launch to edit the object.
o Deactivate()
Deactivation of the feature edition command.
o GetPanelItem(CATDialog*,CATString&)
Returns a widget representing the current feature.
o IsActive()
Returns an integer value telling whether the command is launched or not.

Constructor and Destructor


o CATExtIEdit
public CATExtIEdit()
Constructs the class.
o ~CATExtIEdit
public virtual ~CATExtIEdit()

Methods


o Activate
public virtual CATCommand * Activate(CATPathElement* iPath)
Returns the command to launch to edit the object.
Role:Called by the ui-activation manager ( CATIUIActivate ) when the user double-clics on the feature, or selects the "Definition .." sub-item on the feature's contextual menu or on the Edit menu.
Parameters:
iPath
A
CATPathElement to the current feature object
Returns:
Returning the instanciated command, if any, is a good choice.
o Deactivate
public virtual void Deactivate()
Deactivation of the feature edition command.
Role:This method is called when the CATCommand issued by the CATIEdit.Activate leaves the active state.
o GetPanelItem
public virtual CATDlgFrame * GetPanelItem(CATDialog* iParent,
const CATString& iTitle)
Returns a 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 CATDlgFrame, child of iParent with the title iTitle.
o IsActive
public virtual int IsActive()
Returns an integer value telling whether the command is launched or not.
Returns:
0 if inactive, != 0 otherwise.

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

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