Sage-ST

Sage-ST ä
Mblkedit
Documentation

EditorSaved


  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);

  (**
      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.

      NOTE - In the Multi-user Sage the record for this block data must be
             locked before calling this routine.  If the record does not
             exist then you must write it, lock it and then call this routine
             to edit the block data.

      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);

          MBlkEdit.BlockDataEditor ("MYREL", "FIELD1", 132, TRUE, TRUE, TRUE,
                                    "PRN", HotPrint);
  *)


  PROCEDURE EditorSaved
             () : BOOLEAN;

  (**
      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 -

        MBlkEdit.BlockDataEditor ("MYREL", "FIELD1", 132, TRUE, TRUE, TRUE,
                                  "PRN", HotPrint);

        IF (MBlkEdit.EditorSaved ()) THEN
  *)