CATMatInterfaces Interface CATIMatFeaturePropEditFrame

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

interface CATIMatFeaturePropEditFrame

Interface for comunication between Edit Definition window and feature edition frame.
Role: When a behavior owner wants to be integrated into Edit Definition of the behavior he needs to implement CATIEdit on the applicative feature to return a frame.
That frame need to implement CATIMatFeaturePropEditFrame to interact with the panel.

Example: 
 How to retrieve this interface.
  

  CATIMatFeaturePropEditFrame* currentDisplay = NULL; 

  rc = window->QueryInterface(IID_CATIMatFeaturePropEditFrame,
                                     (void**) &currentDisplay); 

   

 
   
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 CheckDomainDataValidity(CATUnicodeString&)
Checks that domain data are valid.
o CloseAction()
Action that will be called when Close button is pressed.
o GetTabTitle(CATUnicodeString&)
Gets the name of the tab.
o OkAction()
Action that will be called when OK button is pressed.
o UseUndoAtEnd()
Calls UndoAtEnd.

Methods


o CheckDomainDataValidity
public virtual CheckDomainDataValidity( oShortErrorMessage)
Checks that domain data are valid.
Returns:
A CATBoolean
Legal values:
TRUE
The data are valid.
FALSE
The data are not valid (It displays an error message).
o CloseAction
public virtual CloseAction()
Action that will be called when Close button is pressed.
o GetTabTitle
public virtual GetTabTitle( oTabTitle)
Gets the name of the tab.
Parameters:
oTabTitle
The displayed name of the tab.
o OkAction
public virtual OkAction()
Action that will be called when OK button is pressed.
o UseUndoAtEnd
public virtual UseUndoAtEnd()
Calls UndoAtEnd.
Returns:
A CATBoolean
Legal values:
TRUE
An undo will be call at the end of the transaction.
FALSE
No undo called at the end of the transaction.
This object is included in the file: CATIMatFeaturePropEditFrame.h
If needed, your Imakefile.mk should include the module: CATMatInterfaces

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.