3D PLM Enterprise Architecture

CATDialog
  |
  +---CATDlgControl
        |
        +---CATDlgEditor

The Editor

The editor allows the end user to enter a text, numerics, or both, or modify existing ones. The text can extend on one or several lines. Scrollbars can be added if the text is longer than the editor display area.

Use editors whenever you propose to the end user to edit or modify a text or unpredictable numerical values.

[Top]

[Top]

[Top]

Programmer's Guide

The editor is dedicated to text or numerical value edition.

Constructing an Editor

These following kinds of multiple list can be constructed.

_pEditor  = new CATDlgEditor (iParent, iName);

_pMEditor = new CATDlgEditor (iParent, iName,
                          CATDlgEdtMultiline);

[Top]

Managing the Line Content

You can manage the line with the following methods:

• get the number of lines:

  int NumberOfLines = _pEditor->GetLineCount();

• get or set the contents of a given line as a CATUnicodeString:

  get a line contents	set a line contents CATUnicodeString oLineContents; int iLineNumber = 2; _pEditor->GetLine(oLineContents, iLineNumber);
  set a line contents	... iLineNumber = 3; CATUnicodeString * _iLineToSet = "Line to set"; _pEditor->SetLine(*iLineContents, iLineNumber);

• get or set the whole editor contents as a CATUnicodeString:

  get all text	CATUnicodeString oAllText, iAllText; oAllText = _pEditor->GetText();
  set all text	... iAllText = ... _pEditor->SetText(iAllText);

• get an integer or a float from the contents of a line:

  get integer value	int IntValue = _pEditor->GetIntegerValue();
  get float value	float FloatValue = _pEditor->GetFloatValue();

• delete a given line or all the lines:

  clear line 2

  int iLineNumber = 2; _pEditor->ClearLine(iLineNumber)

  The default value -1 deletes all the lines.

• get or set the maximum number of characters that a line can contain:

  get max char	int MaxCharacter; MaxCharacter = _pEditor->GetMaxCharacterWidth(); ...
  set max char	MaxCharacter = 20; _pEditor->SetMaxCharacterWidth(MaxCharacter);

• in addition, declare your own function to execute when a key-board entry happens:

  declare a function

  CATDlgEditorCallback MyFunction; _pEditor->SetVerifyCallback(MyFunction, _iUsefulData);

  MyFunction is the function to execute and _iUsefulData is the contents of the filed casted as a pointer to void.

[Top]

Managing the Line Display

You can manage the line display with the following methods:

• get or set the visible text width:

  get number of visible char	int NumberOfVisibleChar; NumberOfVisibleChar = _pEditor->GetVisibleTextWidth(); ...
  setnumber of visible char	NumberOfVisibleChar = 20: _pEditor->SetVisibleTextWidth(NumberOfVisibleChar);

• get or set the visible text height:

  get visible height	int VisibleTextHeight; TextHeight = _pEditor->GetVisibleTextHeight(); ...
  set visible height	TextHeight = 8; _pEditor->SetVisibleTextHeight(TextHeight);

• get or set the position of the first visible character in the line:

  get 1st visible char	int FirstVisibleChar; FirstVisibleChar = _pEditor->GetFirstColumn(); ...
  set 1st visible char	FirstVisibleChar = 5; _pEditor->SetFirstColumn(FirstVisibleChar);

• get or set the position of the first line:

  get 1st line position	int FirstLine; FirstLine = _pEditor->GetFirstLine(); ...
  set 1st line position	FirstLine = 3; _pEditor->SetFirstLine(FirstLine);

[Top]

Setting a Callback on an Editor

Set a callback on an editor to be informed whenever the end user modify the text as follows:

AddAnalyseNotificationCB(
  _pEditor,                                   // multiple list 
  _pEditor->GetEditModifyNotification(),      // notification
  (CATCommand)&Editor::MethodToExecute,       // method to execute 
  CATCommandClientData iUsefulData);          // useful data for this method 

[Top]

Setting a Title to an Editor

The editor title should be set by the resource file using a key built with the identifier you declare as the second parameter of the editor constructor. This title is never displayed. If you want to comment the editable field of the editor in your dialog, use a label.

[Top]

History

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