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

  exports 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) name 'FileEdit_FileEditor';

  //*
  //  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 FileEditor
             (const FileName   : string;
              const LineLength : cardinal;
              const Modify     : boolean;
              const Defaults   : boolean;
              const Header     : boolean;
              const PrintDest  : string;
              const PrintKey   : TextEdit.KeyType); overload; stdcall;

  exports FileEditor (const FileName   : string;
                      const LineLength : cardinal;
                      const Modify     : boolean;
                      const Defaults   : boolean;
                      const Header     : boolean;
                      const PrintDest  : string;
                      const PrintKey   : TextEdit.KeyType) name 'FileEdit_STRFileEditor';

  //*
  //  STRFileEditor - See documentation of FileEditor.
  //


  function EditorSaved
             () : boolean; stdcall;

  exports EditorSaved name 'FileEdit_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 -
  //
  //    FileEdit.FileEditor ('TEST.FIL', 132, True, True, True, 'PRN', HotPrint);
  //
  //    if FileEdit.EditorSaved then begin
  //