All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

KnowledgeInterfaces Interface CATIParameterEditor

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

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIParameterEditor

Interface to the standard parameter editor.
Role: It allows the user to manipulate a parameter editor.
To create a standard parameter editor instance, use the CATIParameterEditorFactory

See also:
CATIParameterEditorFactory


Method Index


o GetEditedParameter()
Returns the edited parameter.
o GetFrame()
Use this method to retrieve the parameter editor frame.
o SetEditedParameter(CATICkeParm*)
Sets the parameter to be edited.
o SetEditorStyle(CATParameterEditorStyle&)
Sets a style to the parameter editor frame (available only on R16 and upper level).
o SetVisibleTextWidth(int)
Sets the editor visible text width of the editor.

Methods


o GetEditedParameter
public virtual CATICkeParm * GetEditedParameter()= 0
Returns the edited parameter. It can be NULL. If it is not NULL, AddRef is called on the returned pointer.
o GetFrame
public virtual CATDlgFrame * GetFrame()= 0
Use this method to retrieve the parameter editor frame. This frame can be used, for example to manage the dialog layout.
Returns:
The frame that contains the parameter editor.
o SetEditedParameter
public virtual void SetEditedParameter( const CATICkeParm* iParameter) = 0
Sets the parameter to be edited.
Parameters:
iParameter
The parameter to be edited. If this argument is NULL, the editor is emptied and cannot be used
o SetEditorStyle
public virtual void SetEditorStyle( const CATParameterEditorStyle& iStyle) = 0
Sets a style to the parameter editor frame (available only on R16 and upper level). The style allows to customize the editor display and the contextual menu.
Parameters:
iStyle
The style of the parameter editor. for example : WithoutLabel | NoCtxAddTolerance | RelationButtonDisabled
o SetVisibleTextWidth
public virtual void SetVisibleTextWidth( const int iWidth) = 0
Sets the editor visible text width of the editor. This method has no effect if the parameter editor's frame has been attached using its right hand side and if its grid column is resizable (default behavior). To specify the visible text width of the editor, you need first to use the WithVisibleTextWidth style.
Parameters:
iWidth
The width of the text editor expressed in number of characters.

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

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