AfrProperties Interface CATIEditProperties

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

interface CATIEditProperties

Interface to create an Edit Properties property page.
Role: Each property page of the Edit Properties command corresponds to an implementation of the CATIEditProperties interface.

Step by step: CATEditorManager implements the IMyPropertyEdtFactory factory interface. This Factory creates a MyPropertyEdt instance class. This class implements the CATIEditProperties interface.

1. Create the factory IMyPropertyEdtFactory interface which derives from
2. Implement this factory interface using macros

This implementation, MyPropertyEdtFactory, is done in the module myModule thanks to 2 macros: and
1. The header file MyPropertyEdtFactory.h must contain these two lines:

 
       #include "CATEditorFactory.h"
       #include "MyPropertyEdt.h"
 
       #define ExportedByNOTHING

       CAT_EDITOR_DECLARE_FACTORY(NOTHING, MyPropertyEdt, MyPropertyEdt);
 

2. The source file MyPropertyEdtFactory.cpp must contain these lines:

 
        #include "MyPropertyEdtFactory.h"

        CAT_EDITOR_DEFINE_FACTORY(MyPropertyEdt, MyPropertyEdt);

        #include "TIE_IMyPropertyEdtFactory.h"
        TIE_IMyPropertyEdtFactory(MyPropertyEdtFactory);

 

3. To declare that CATEditorManager implements IMyPropertyEdtFactory, insert the following line in the interface dictionary:

 
       CATEditorManager    IMyPropertyEdtFactory  myModule 
 

4. To declare that the factory creates an instance of the MyPropertyEdt class, insert the following line in the factory dictionary:

 
       MyPropertyEdt            IMyPropertyEdtFactory      
 

5. Implement the CATIEditProperties interface, describe here, with a class which derives from the adapter class

BOA information: this interface CANNOT 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 BuildEditor(CATEditorPage*)

Constructs the dialog objects of the editor.

o CancelModification(CATLISTV(CATBaseUnknown_var)&)

Cancels a modification when closing the panel.

o CheckPropertyValues(CATBoolean&)

Check the Property Values

o CloseWindowFromEditor()

Closes dialog object open by the editor.

o CommitModification(CATLISTV(CATBaseUnknown_var)&)

Validates modifications done on objects from iExtract.

o ExtractFromSelection(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)*)

Extracts from the selection the objects which can be managed.

o GetEditorTitle()

Returns the editor title.

o GetListOfUnexpectedTabpages()

Returns the list of unexpected tab pages.

o GetUndoFromEditor()

Records an undo action from the editor.

o OKToRepaintOnCommit(int&)

Sets the behaviour of the dialog objects during the update of tabpages when applying modifications.

o SetEditorSize(int&)

Sets editor's size.

o SetPropertyValue(CATLISTV(CATBaseUnknown_var)&,ModeReadWrite)

Valuates the dialog objects.

o ValuePropertyOnOK(CATBoolean&)

Sets the behaviour of the dialog objects when applying modifications by OK.

Methods

Constructs the dialog objects of the editor.

Parameters:

iMyPage

to specify a tab page.

Cancels a modification when closing the panel.

Parameters:

iExtract

list of objects supposed to be managed.

Check the Property Values

Parameters:

oStatus

Legal Values : FALSE : There is some error in the values TRUE : The Values are Proper