@database EditPrefs-rexx
@rem created by makedoc
@node main

@{"EditPrefs/--background--" link "--background--"}
@{"EditPrefs/DEFAULTS" link "DEFAULTS"}
@{"EditPrefs/LASTSAVED" link "LASTSAVED"}
@{"EditPrefs/OPEN" link "OPEN"}
@{"EditPrefs/QUIT" link "QUIT"}
@{"EditPrefs/RESTORE" link "RESTORE"}
@{"EditPrefs/SAVE" link "SAVE"}
@{"EditPrefs/SAVEAS" link "SAVEAS"}
@{"EditPrefs/SETATTR" link "SETATTR"}
@{"EditPrefs/USE" link "USE"}


@endnode
@node "--background--" "EditPrefs/--background--"

--background-- :


  There is no default portname for EditPrefs. The PORTNAME parameter must
  be supplied if an ARexx port is required.

  If 'OPTIONS RESULTS' is on then when an error is returned then RC2 will
  hold a supplementary error (number or text).

  Shortened unique formats of commands can be used.

@endnode
@node "DEFAULTS" "EditPrefs/DEFAULTS"

DEFAULTS :


   NAME   
  DEFAULTS -- Reverts to the default settings.

   SYNOPSIS
  DEFAULTS( )

   FUNCTION
  Reverts to the default settings.

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'DEFAULTS'

   NOTES

   BUGS

   SEE ALSO
  RESTORE(), LASTSAVED().

@endnode
@node "LASTSAVED" "EditPrefs/LASTSAVED"

LASTSAVED :


   NAME   
  LASTSAVED -- Reverts to the last saved settings.

   SYNOPSIS
  LASTSAVED( )

   FUNCTION
  Reverts to the LastSaved settings (from the Save directory).

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'LASTSAVED'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO
  DEFAULTS(), RESTORE().

@endnode
@node "OPEN" "EditPrefs/OPEN"

OPEN :


   NAME   
  OPEN -- Opens settings from the supplied file.

   SYNOPSIS
  OPEN( FILENAME/K )

   FUNCTION
  Opens settings from the supplied filename.

   INPUTS
  FILENAME - File name to open. If not supplied then requester is displayed

   RESULT
  None.

   EXAMPLE
  'OPEN FILENAME=ENV:MPMorph/Morph.prefs'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO

@endnode
@node "QUIT" "EditPrefs/QUIT"

QUIT :


   NAME   
  QUIT -- Quits EditPrefs.

   SYNOPSIS
  QUIT( )

   FUNCTION
  Quits EditPrefs without saving the settings.

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'QUIT'

   NOTES

   BUGS

   SEE ALSO
  SAVE(), USE().

@endnode
@node "RESTORE" "EditPrefs/RESTORE"

RESTORE :


   NAME   
  RESTORE -- Reverts to the last used settings.

   SYNOPSIS
  RESTORE( )

   FUNCTION
  Reverts to the LastUsed settings (from the Use directory).

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'RESTORE'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO
  DEFAULTS(), LASTSAVED().

@endnode
@node "SAVE" "EditPrefs/SAVE"

SAVE :


   NAME   
  SAVE -- Save the settings and Quits EditPrefs.

   SYNOPSIS
  SAVE( )

   FUNCTION
  Saves the settings to the Save and Use directories and quits EditPrefs.

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'SAVE'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO
  QUIT(), USE(), SAVEAS().

@endnode
@node "SAVEAS" "EditPrefs/SAVEAS"

SAVEAS :


   NAME   
  SAVEAS -- Save the settings to the supplied file.

   SYNOPSIS
  SAVEAS( NAME/K )

   FUNCTION
  Saves the settings to the supplied file.

   INPUTS
  NAME - Name of file. If not supplied then requester is displayed.

   RESULT
  None.

   EXAMPLE
  'SAVEAS NAME=Current.prefs'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO
  SAVE().

@endnode
@node "SETATTR" "EditPrefs/SETATTR"

SETATTR :


   NAME   
  SETATTR -- Sets the atributes of a gadget.

   SYNOPSIS
  SETATTR( TITLE/A,VALUE/A )

   FUNCTION
  Sets the value of a gadget.

   INPUTS
  TITLE - the title of the gadget (including spaces and _s)
  VALUE - the value to set the gadget to.

   RESULT
  None.

   EXAMPLE
  'SETATTR TITLE="_Public Screen" VALUE="Test Screen"'

   NOTES
  Capitilization of TITLE does matter.

   BUGS
  Never returns an error.

   SEE ALSO

@endnode
@node "USE" "EditPrefs/USE"

USE :


   NAME   
  USE -- Uses the settings and Quits EditPrefs.

   SYNOPSIS
  USE( )

   FUNCTION
  Saves the settings to the Use directory and quits EditPrefs.

   INPUTS
  None.

   RESULT
  None.

   EXAMPLE
  'USE'

   NOTES

   BUGS
  Never returns an error.

   SEE ALSO
  QUIT(), SAVE(), SAVEAS().

@endnode
