AfrProperties CATEditor
Usage: you can derive this class.
public class CATEditor
Class to define an editor called by the PropertyEditor.
Constructor and Destructor Index
- o
CATEditor()
- Constructs the editor.
- o
~CATEditor()
-
Method Index
- o
BuildEditor(CATEditorPage*)
- Constructs the dialog objects of the editor.
- o
CancelModification(CATSettingRepository*)
- Cancels settings modification.
- o
CancelModification(CATLISTV(CATBaseUnknown_var)&)
- Cancels a modification when closing the panel.
- o
CheckPropertyValues(CATBoolean&)
- Method to Check if all the property values are OK.
- o
CloseWindowFromEditor()
- Method to close dialog object open by the editor.
- o
CommitModification(CATSettingRepository*)
- Saves settings modifications.
- o
CommitModification(CATLISTV(CATBaseUnknown_var)&)
- Saves properties modifications for all the selection.
- o
ExtractFromSelection(CATLISTV(CATBaseUnknown_var)&,CATLISTV(CATBaseUnknown_var)*)
- Method to make a query on the selection for acceptance.
- o
GetEditorTitle()
- Method to give a name to the editor.
- o
GetListOfUnexpectedTabpages()
- Returns the list of unexpected tab pages.
- o
GetUndoFromEditor()
- Method to record 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
ResetUserSettingsValue()
- Resets all values of repositories.
- o
SetEditorSize(int&)
- Allows to choose the size you need to accommodate the page.
- o
SetPropertyValue(CATLISTV(CATBaseUnknown_var)&,ModeReadWrite)
- Valuates the dialog objects of the editor.
- o
SetUserSettingsValue(CATSettingRepository*)
- Valuates the dialog objects of the Tools Option editor.
- o
ValuePropertyOnOK(CATBoolean&)
- Sets the behaviour of the dialog objects when applying modifications by OK.
Constructor and Destructor
o CATEditor
-
Constructs the editor.
o ~CATEditor
| public virtual ~CATEditor( | ) |
-
Methods
o BuildEditor
| public virtual BuildEditor( | | iPage) |
-
Constructs the dialog objects of the editor.
o CancelModification
| public virtual CancelModification( | | iRep) |
-
Cancels settings modification.
- Parameters:
-
- iRep
- not used.
careful: you need to get the repository by yourself
by GetRepository method, don't try to use iRep directly
- See also:
-
o CancelModification
| public virtual CancelModification( | | iExtract) |
-
Cancels a modification when closing the panel.
- Parameters:
-
- iExtract
- list of concerned objects with the modification.
o CheckPropertyValues
| public virtual CheckPropertyValues( | | oStatus) |
-
Method to Check if all the property values are OK.
- Parameters:
-
- oStatus
-
Legal Values :
FALSE : if any value is incorrect
TRUE : If the values are proper
o CloseWindowFromEditor
| public virtual CloseWindowFromEditor( | ) |
-
Method to close dialog object open by the editor.
o CommitModification
| public virtual CommitModification( | | iRep) |
-
Saves settings modifications.
- Parameters:
-
- iRep
- not used.
careful: you need to get the repository by yourself
by GetRepository method, don't try to use iRep directly
- See also:
-
o CommitModification
| public virtual CommitModification( | | iExtract) |
-
Saves properties modifications for all the selection.
- Parameters:
-
- iExtract
- list of concerned objects with the modification.
o ExtractFromSelection
| public virtual ExtractFromSelection( | | iExtract, |
| const | iSelection | =NULL ) |
-
Method to make a query on the selection for acceptance.
o GetEditorTitle
| public virtual GetEditorTitle( | ) |
-
Method to give a name to the editor.
o GetListOfUnexpectedTabpages
| public GetListOfUnexpectedTabpages( | ) |
-
Returns the list of unexpected tab pages.
o GetUndoFromEditor
| public virtual GetUndoFromEditor( | ) |
-
Method to record an undo action from the editor.
o OKToRepaintOnCommit
| public virtual OKToRepaintOnCommit( | | oStatus) |
-
Sets the behaviour of the dialog objects during the update of tabpages when applying modifications.
Useful for tab pages depending on each other
- Parameters:
-
- oStatus
-
Legal Values :
0 if no repaint is required : for each tabpage, methods CommitModification and SetPropertyValue are called one after the other
1 otherwise : default behaviour - for each tabpage method CommitModification is applied. Then, for each tabpage method SetPropertyValue is called.
o ResetUserSettingsValue
| public virtual ResetUserSettingsValue( | ) |
-
Resets all values of repositories.
o SetEditorSize
| public virtual SetEditorSize( | | iSize) |
-
Allows to choose the size you need to accommodate the page.
- Parameters:
-
- iSize
-
Legal Values :
1 for small size: 250x460 using Windows or 294x533 using Unix.
2 for large size: 415x425 using Windows or 500x496 using Unix.
o SetPropertyValue
| public virtual SetPropertyValue( | | iExtract, |
| | iMode) |
-
Valuates the dialog objects of the editor.
o SetUserSettingsValue
| public virtual SetUserSettingsValue( | | iRep) |
-
Valuates the dialog objects of the Tools Option editor.
- Parameters:
-
- iRep
- not used.
o ValuePropertyOnOK
| public virtual ValuePropertyOnOK( | | oStatus) |
-
Sets the behaviour of the dialog objects when applying modifications by OK.
- Parameters:
-
- oStatus
-
Legal Values :
FALSE : SetPropertyValue method is not called after OK is pressed.
TRUE otherwise : default behaviour - SetPropertyValue method is called when APPLY or/and OK are pressed.
This object is included in the file: CATEditor.h
If needed, your Imakefile.mk should include the module: CATAfrProperties
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.