All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATAnalysisInterfaces Interface CATISamEditionCmd

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

Usage: you can freely reimplement this interface.


interface CATISamEditionCmd

Basic Component Edition.
Role: Basic components provide dialog entities to deal with their edition,
thanks to interfaces CATISamEditWithCmd or CATISamEditWithFrame.
This edition dialog entity can be of two kinds :

CATStateCommand corresponding to the second case must implement this interface. Interface providing services to integrate the implementing CATStateCommand to the Edition Command of the Analysis Entity.

See also:
CATISamEditWithCmd, CATISamEditionFrame


Method Index


o AnalyseSelection()
Warns the implementing command that its Selection Agents are plugged on Selection Event.
o GetFeature(CATISpecObject_var&)
Retrieve the Basic Component associated the editor.
o GetModificationFrame(CATDialog*)
Returns the Frame associated to the implementing CATStateCommand.
o GetModificationNotification(CATCommand*&,CATNotification*&)
Returns the notification that will be sent, each time the implementing command modify the value of the edited Basic Component.
o GetQuerySelectFocusNotif(CATCommand*&,CATSamQuerySelectFocusNotification*&)
Returns the notification that will be sent, each time the implementing command wants to get the management of the selection in the document.
o IgnoreSelection()
Warns the implementing command that its Selection Agents aren't plugged on Selection Event anymore.
o IsAnalysingSelection()
Warns if the selection have been checked.
o SetFeature(CATISpecObject_var&)
Associates the editor to Basic Component.
o UnreferenceFrame()
Informs the implementing CATStateCommand that its associated Frame doesn't exist anymore.
o UpdateFrame()
Informs the implementing CATStateCommand that its associated Frame has to be updated according to the edited Basic component.

Methods


o AnalyseSelection
public virtual void AnalyseSelection()= 0
Warns the implementing command that its Selection Agents are plugged on Selection Event. That is to say, the implementing command deals with the selection management.
o GetFeature
public virtual void GetFeature(CATISpecObject_var& oFeature) = 0
Retrieve the Basic Component associated the editor.
Parameters:
oFeature
Basic component edited by the implemented CATStateCommand.
o GetModificationFrame
public virtual CATDlgFrame * GetModificationFrame(CATDialog* iParent= NULL) = 0
Returns the Frame associated to the implementing CATStateCommand. This Frame will be integrated to the Edition Command of the Analysis Entity.
Parameters:
iParent
Active CATDialog in which the Frame will appear.
o GetModificationNotification
public virtual void GetModificationNotification(CATCommand*& oFromCmd,
CATNotification*& oNotif) = 0
Returns the notification that will be sent, each time the implementing command modify the value of the edited Basic Component.
Parameters:
oFromCmd
CATCommand that will send the notification.
oNotif
CATNotification dedicated to warn the Edition Command of the Analysis Entity.
o GetQuerySelectFocusNotif
public virtual void GetQuerySelectFocusNotif(CATCommand*& oFromCmd,
CATSamQuerySelectFocusNotification*& oNotif) = 0
Returns the notification that will be sent, each time the implementing command wants to get the management of the selection in the document.
Parameters:
oFromCmd
CATCommand that will send the notification.
oNotif
CATNotification dedicated to warn the Edition Command of the Analysis Entity, that it must delegate the selection management to the implementing command.
o IgnoreSelection
public virtual void IgnoreSelection()= 0
Warns the implementing command that its Selection Agents aren't plugged on Selection Event anymore. That is to say, the implementing command doesn't deal with the selection management anymore.
o IsAnalysingSelection
public virtual int IsAnalysingSelection()= 0
Warns if the selection have been checked. Return 1 if the implementing command deals with the selection management. Return 0 else.
o SetFeature
public virtual void SetFeature( const CATISpecObject_var& iFeature) = 0
Associates the editor to Basic Component.
Parameters:
iFeature
Basic component edited by the implemented CATStateCommand.
o UnreferenceFrame
public virtual void UnreferenceFrame()= 0
Informs the implementing CATStateCommand that its associated Frame doesn't exist anymore.
o UpdateFrame
public virtual void UpdateFrame()= 0
Informs the implementing CATStateCommand that its associated Frame has to be updated according to the edited Basic component. WARNING ! This method must not send a Modification Notification.

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

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