All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface 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 This editor is dedicated for two kind of parameters: literal and volatile value.

See also:

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 SetUnitToUse(CATICkeUnit_var&)
o SetVisibleTextWidth(int): Sets the editor wisible text width of the editor.

Methods

o GetEditedParameter

public virtual GetEditedParameter(

)

Returns the edited parameter. It can be NULL. If it is not NULL, AddRef is called on the returned pointer.

o GetFrame

public virtual GetFrame(

)

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 SetEditedParameter( const iParameter)

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 SetEditorStyle( const iStyle)

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 SetUnitToUse

public virtual SetUnitToUse( const ispUserDefinedUnitToDisplay)

o SetVisibleTextWidth

public virtual SetVisibleTextWidth( const iWidth)

Sets the editor wisible 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.

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