Sage-ST

Sage-ST ä
Blkedit
Documentation

EditorSaved



  //*
  //  BlkEdit - A simple editor to handle block data.
  //
  //
  //  This unit contains routines which create a simple text editor that can
  //  edit a block data field in text format.  Currently this is supported
  //  only in the SageTerm mode.  If a SageTerm is currently not open one will
  //  be created for this session.
  //


  procedure BlockDataEditor
             (const Relation   : array of char;
              const Field      : array of char;
              const LineLength : cardinal;
              const Modify     : boolean;
              const Defaults   : boolean;
              const Header     : boolean;
              const PrintDest  : array of char;
              const PrintKey   : TextEdit.KeyType); overload; stdcall;

  exports BlockDataEditor (const Relation   : array of char;
                           const Field      : array of char;
                           const LineLength : cardinal;
                           const Modify     : boolean;
                           const Defaults   : boolean;
                           const Header     : boolean;
                           const PrintDest  : array of char;
                           const PrintKey   : TextEdit.KeyType) name 'BlkEdit_BlockDataEditor';

  //*
  //  BlockDataEditor - View/edit variable block data.
  //
  //
  //  BlockDataEditor allows a quick way to view/edit block data.  If the
  //  Defaults flag is set to True then the default values will be used.
  //  If it is set to False then any settings which have been made before
  //  calling this routine will be used.  This library uses the TextEdit package
  //  as the editor.  If you want to change colors, editing keys, etc. then make
  //  calls to TextEdit before calling this routine and set the Defaults flag
  //  to False.
  //
  //  CALLING SEQUENCE -
  //
  //    BlockDataEditor (Relation, Field, LineLength, Modify, Defaults,
  //                     Header, PrintDest, PrintKey)
  //
  //  ENTRY -
  //
  //    Relation : array of char
  //      The name of the relation containing the block data field.
  //
  //    Field : array of char
  //      The name of the field containing the block data.
  //
  //    LineLength : cardinal
  //      The length of the lines when editing (May be larger than the window)
  //
  //    Modify : boolean
  //      True to allow modification of the block data.
  //      False to NOT allow modification of the block data.
  //
  //    Defaults : boolean
  //      True  - The editor defaults will be used.
  //      False - Any colors, keys, etc. that were user specified before
  //              calling this procedure will be used.
  //
  //    Header : boolean
  //      True  - The editor will provide a header on the top two lines of screen.
  //      False - No header lines will be displayed.  If you want a header then
  //              you can use a DisplayBackground of a form.
  //
  //    PrintDest : array of char
  //      The destination for printing (PRN, LPT1, [FILE NAME], etc.)
  //      If this is a null string ('') then no printing will be allowed.
  //
  //    PrintKey : TextEdit.KeyType
  //      The hot key to use for printing.
  //
  //  EXAMPLE -
  //
  //    var
  //      HotPrint : TextEdit.KeyType;
  //
  //    begin
  //      HotPrint[0] := ASCIIX.nul;
  //      HotPrint[1] := Chr (64);
  //
  //      BlkEdit.BlockDataEditor ('MYREL', 'FIELD1', 132, True, True, True,
  //                               'PRN', HotPrint);
  //


  procedure BlockDataEditor
             (const Relation   : string;
              const Field      : string;
              const LineLength : cardinal;
              const Modify     : boolean;
              const Defaults   : boolean;
              const Header     : boolean;
              const PrintDest  : string;
              const PrintKey   : TextEdit.KeyType); overload; stdcall;

  exports BlockDataEditor (const Relation   : string;
                           const Field      : string;
                           const LineLength : cardinal;
                           const Modify     : boolean;
                           const Defaults   : boolean;
                           const Header     : boolean;
                           const PrintDest  : string;
                           const PrintKey   : TextEdit.KeyType) name 'BlkEdit_STRBlockDataEditor';

  //*
  //  STRBlockDataEditor - See documentation of BlockDataEditor.
  //


  function EditorSaved
             () : boolean; stdcall;

  exports EditorSaved name 'BlkEdit_EditorSaved';

  //*
  //  EditorSaved - Returns boolean as to whether the last edit session was saved.
  //
  //
  //  EditorSaved returns a boolean value to tell whether the last editing
  //  session was saved or whether the user aborted out of the editor.
  //
  //  CALLING SEQUENCE -
  //
  //    EditorSaved
  //
  //  EXIT -
  //
  //    EditorSave : boolean
  //      True  - The editor was exited and the changes saved.
  //      False - The editor was aborted out of; no changes were saved.
  //
  //  EXAMPLE -
  //
  //    BlkEdit.BlockDataEditor ('MYREL', 'FIELD1', 132, True, True, True,
  //                             'PRN', HotPrint);
  //
  //    if (BlkEdit.EditorSaved ()) then begin
  //