Sage-ST

Sage-ST ä
Fileedit
Documentation

EditorSaved

FileEditor


  PROCEDURE FileEditor
             (CONST FileName   : ARRAY OF CHAR;
              CONST LineLength : CARDINAL;
              CONST Modify     : BOOLEAN;
              CONST Defaults   : BOOLEAN;
              CONST Header     : BOOLEAN;
              CONST PrintDest  : ARRAY OF CHAR;
              CONST PrintKey   : TextEdit.KeyType);

  (**
      FileEditor - View/edit a text file.


      FileEditor allows a quick way to edit and/or view a file.  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 -

        FileEditor (FileName, LineLength, Modify, Defaults, Header,
                    PrintDest, PrintKey)

      ENTRY -

        FileName : ARRAY OF CHAR
          The name of the file to edit.

        LineLength : CARDINAL
          The length of the lines when editing (May be larger than the window)

        Modify : BOOLEAN
          TRUE to allow modification of the file.
          FALSE to NOT allow modification of the file.

        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 key to use for hot key printing.

      EXAMPLE -

        VAR
        HotPrint : TextEdit.KeyType;

        BEGIN
          HotPrint[0] := ASCIIX.nul;
          HotPrint[1] := CHR (64);

          FileEdit.FileEditor ("TEST.FIL", 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 -

        FileEdit.FileEditor ("TEST.FIL", 132, TRUE, TRUE, TRUE, "PRN", HotPrint);

        IF FileEdit.EditorSaved THEN
  *)