All Frameworks Class Hierarchy This Framework Indexes Previous Next

KnowledgeInterfaces Interface CATICkeParamFrame

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

interface CATICkeParamFrame

Interface to create an editor from a parameter (literal or volatile value).
Role: From this interface you'll get an editor of the parameter that you will integrate in a complex dialog.
It can be used on persistant literals or volatile values.
This frame will offer a way to show a parameter value or to modify it.

All informations are available on the parameter

if the parameter is ReadOnly, or with a Visibility equal to false or

is valuated by a relation, the frame sensitivity will be false
=============================================================================
Depending on the type of the parameter, the frame will contain an editor, a combo
(for enumere parameters), or a spinner

The frame style is used to detail the frame look :

CATCkeNoLabel / CATCkeLabel : indicates if you want to have a label before your editor

CATCkeWithSpinner : to have a spinner and not an editor on real parameters

CATCkeNoRename : not to have the rename command available on contextual menu

CATCkeNoFormula : not to have the Edit formula command available on contextual menu

method is triggered on the CATDlgFrame.

To customise the NLS, all you have to know is the ressources structure
The returned CATDlgFrame is a frame named "ParamFrame"
The children of this frame are :

if CATCkeLabel option is chosen, the name of the label is "Label", and its value defaults to "Label", if not given by NLS tag "ParamFrame.EnglobingFrame.IntermediateFrame.Label.Title" .

if CATCkeWithSpinner option is chosen, the name of the editor is "Spinner" .

if it is a combo, its name is "Combo"

if not, it's an editor whose name is "Value"

If the last argument is different from "", then the name of the CATDlgFrame will
be the name in argument instead of "ParamFrame"

=============================================================================
Usage Note
// Imagine you have a parameter p
CATICkeParm_var p = ...;
// and a CATDialog d
CATDialog *d = ...

// QI on CATICkeParamFrame
CATICkeParamFrame_var pf = p;

// Get the frame (spinner, No formulas, and no label
CATDlgFrame *fr = pf->GetInPanelEdition (NULL_var,d,CATCkeNoLabel | CATCkeNoFormula | CATCkeNoRename | CATCkeWithSpinner);

See also:

Method Index

o GetInPanelEdition(CATIParmPublisher_var&,CATDialog*,CATCkeFrameStyle,CATUnicodeString&): Creates a frame-editor linked to a parameter (literal or volatile value) to include in your panel.

Methods

o GetInPanelEdition

public virtual GetInPanelEdition(	const	`iRoot`,
		`iFather`,
		`iStyle`	`= CATCkeLabel`,
	const	`iLabelName`	`= ""`)

Creates a frame-editor linked to a parameter (literal or volatile value) to include in your panel.

Parameters:

iRoot: the place where formulas will be added (can be NULL_var if no formulas)
iFather: the father CATDialog object
iStyle: the frame style
iLabelName: if <> from "", it's the name (CATString) of the frame

Returns:

a frame containing the editor associated to the literal

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