Sage-ST

Sage-ST ä
Fileedit
Documentation

EditorSaved

FileEditor


  function EditorSaved return boolean;

  --*
  --  EditorSaved - Returns boolean value on last edit session 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 (FileName   => "TEST.FIL",
  --                          LineLength => 132,
  --                          Modify      => True,
  --                          Defaults    => True,
  --                          Header      => True,
  --                          PrintDest  => "PRN",
  --                          PrintKey   => HotPrint);
  --
  --    if Fileedit.EditorSaved then
  --


  procedure FileEditor
             (FileName   : in     string;
              LineLength : in     ModSys.S_Natural;
              Modify     : in     boolean;
              Defaults   : in     boolean;
              Header     : in     boolean;
              PrintDest  : in     string;
              PrintKey   : in     TextEdit.KeyType);

  --*
  --  FileEditor - 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 : String
  --      The name of the file to edit.
  --
  --    LineLength : Modsys.S_Natural
  --      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 - Colors, keys, etc. that 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 : String
  --      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 -
  --
  --    HotPrint : TextEdit.KeyType := (1 => 0,
  --                                    2 => 64);
  --
  --    begin
  --      Fileedit.FileEditor (FileName   => "TEST.FIL",
  --                           LineLength => 132,
  --                           Modify      => True,
  --                           Defaults    => True,
  --                           Header      => True,
  --                           PrintDest  => "PRN",
  --                           PrintKey   => HotPrint);
  --