SP Internal Datafiles

 SuperLib uses a number of internal datafiles to store

 such things as queries, reports and colors.

 All of these files have default names - for instance
 queries are stored in QUERIES.DBF by default. SuperLib 3.x
 provides a series of functions to determine internal file names
 and locations.

 All of these functions start with SLSF_ (Super Lib System File )

 Function                 Purpose                Default

 SLSF_REPORT([cNew])      Stored reports         SFREPORT
 SLSF_QUERY([cNew])       Stored queries         QUERIES
 SLSF_FORM([cNew])        FORMLETR() forms       FORM
 SLSF_HELP([cNew])        Help records           HELP
 SLSF_LIST([cNew])        LISTER() definitions   PLIST
 SLSF_SCROLL([cNew])      Lookup definitions     SCROLLER
 SLSF_COLOR([cNew])       Color sets             COLORS
 SLSF_TODO([cNew])        TODOLIST() dbf         TODO
 SLSF_TDN1([cNew])        TODOLIST 1st index     TODO
 SLSF_TDN2([cNew])        TODOLIST 2nd  index    TODOP
 SLSF_TDN3([cNew])        TODOLIST 3rd  index    TODOD
 SLSF_APPT([cNew])        Appointments           APPOINT
 SLSF_LABEL([cNew])       Labels database        CLABELS
 SLSF_OLD([cNew])         O.L.D. doc database    SLOLDS

 Where [cNew] optionally sets the path and/or filename.
 If [cNew] is passed, this is the value returned as
 well.

 For example, to change the default file and place
 where reports are stored when using REPORTER(),

   SLSF_REPORT("c:\hidden\MYREPORT")
              // sets the report file
              // to MYREPORT.DBF in
              // c:\HIDDEN

 These take the place of the following public
 variables in earlier versions of SuperLib:

     _REPORTS   = "SFREPORT"   (for reports)
     _FORMS     = "FORM"       (for form letters)
     _QUERIES   = "QUERIES"    (for queries)
     _LISTER    = "PLIST"      (for lister)
     _TODODBF   = "TODO"       (for todo list)
     _TODONTX1  = "TODO"       (TODO category INDEX)
     _TODONTX2  = "TODOP"      (TODO priority INDEX)
     _TODONTX3  = "TODOD"      (TODO do by INDEX)
     _HELP      = "HELP"       (for help)
     _SCROLLER  = "SCROLLER"   (for scroller)
     _COLORS    = "COLORS"     (for colors)

 COLORS are now stored in a DBF file, rather than a
 .MEM file.

 

SP_SLSF_COLOR

SLSF_COLOR()

  Short:
  ------
 SLSF_COLOR() Sets and retrieves the file name and path for the
 COLOR SET DBF file

 Returns
 <cFileSpec>  => File path and name less extension

 Syntax
 SLSF_COLOR([cNew])

 Description

 [cNew] optionally sets the path and/or filename.

 If [cNew] is passed, this is the value returned as well.

 Examples
  USE (SLSF_COLOR() )                    // open the file

  SLSF_COLOR("c:\hidden\XYZ123")         // sets the filespec
                                          // to XYZ123.DBF in
                                          // c:\HIDDEN

 Source: S_PATHS.PRG

 

SP_SATTPUT

SATTPUT()

  Short:
  ------
  SATTPUT() Stores current SuperLib color vars to COLORS.DBF

  Returns:
  --------
  <lSuccess> => Success, True of False

  Syntax:
  -------
  SATTPUT([cSetName])

  Description:
  ------------
  This stores the system color and interface variables
  described in SLS_*() in the colors dbf defined by SLSF_COLOR().

  [cSetName] is an optional name of a previously saved
  color set.

  If none is passed, the color set named "DEFAULT" is
  used.

  Examples:
  ---------
   SATTGET("THE BLUE SET")        // restore a previous definition
   SLS_POPCOL("+GR/N,+W/R,,,W/R")
                              // changes the sls_popcol() setting
   SATTPUT("THE BLUE SET # 2")    // stores the revised set in the dbf

  Notes:
  -------
  SETCOLORS() also allows storage of color sets.

  SATTPUT() attempts to re-used deleted records.

  Source:
  -------
  S_CLRFUN.PRG

 

SP_SATTPUSH

SATTPUSH()

  Short:
  ------
  SATTPUSH() Pushes the current SuperLib color vars

  Returns:
  --------
  Nil

  Syntax:
  -------
  SATTPUSH()

  Description:
  ------------
  This pushes the current system color and interface
  variables described in SLS_*() onto a stack, for later retrieval
  with SATTPOP().

  Examples:
  ---------
   SATTPUSH()
   SATTGET("THE BLUE SET")
   //...some code
   SATTPOP()  // restore the prior color set

  Source:
  -------
  S_CLRFUN.PRG

 

SP_SATTPOP

SATTPOP()

  Short:
  ------
  SATTPOP() Pops previously pushed SuperLib color vars

  Returns:
  --------
  Nil

  Syntax:
  -------
  SATTPOP()

  Description:
  ------------
  This pops a previously pushed set of SuperLib system
  interface

  variables described in SLS_*().

  Examples:
  ---------
   SATTPUSH()
   SATTGET("THE BLUE SET")
   //...some code
   SATTPOP()  // restore the prior color set

  Source:
  -------
  S_CLRFUN.PRG

 

SP_SATTPICKPUT

SATTPICKPUT()

  Short:
  ------
  SATTPICKPUT() Stores SuperLib color vars to selected record

  Returns:
  --------
  Nil

  Syntax:
  -------
  SATTPICKPUT()

  Description:
  ------------
  This writes the current system color and interface
  variables described in SLS_*() by selecting either an existing
  set name (contained in the colors dbf file described in
  SLSF_COLOR() ) to overwrite, or allowing a new set to be stored.

  Examples:
  ---------
   SATTPICKPUT()

  Notes:
  -------
  SATTPUT() and SETCOLORS() allow storage of color sets
  to disk.

  SATTPICKPUT() attempts to re-use deleted records.

  Source:
  -------
  S_CLRFUN.PRG

 

SP_SATTPICKDEL

SATTPICKDEL()

  Short:
  ------
  SATTPICKDEL() Picklist deletion of stored color var sets

  Returns:
  --------
  Nil

  Syntax:
  -------
  SATTPICKDEL()

  Description:
  ------------
  A Picklist of color sets, stored in the colors dbf
  file described in SLSF_COLOR(), is presented. Selected color set is
  deleted.

  Examples:
  ---------
   If MESSYN("Want to delete a stored color set?")
     SATTPICKDEL()
   Endif

  Source:
  -------
  S_CLRFUN.PRG

 

SP_SATTPICK

SATTPICK()

  Short:
  ------
  SATTPICK() Sets up SuperLib color vars by selecting from DBF

  Returns:
  --------
  Nil

  Syntax:
  -------
  SATTPICK()

  Description:
  ------------
  This sets up the system color and interface variables
  described in SLS_*() by allowing a picklist of them from the
  colors dbf defined in SLSF_COLOR().

  Examples:
  ---------
   SATTPICK()

  Notes:
  -------
  SATTPUT() and SETCOLORS() allow storage of color sets
  to disk. SETCOLORS() makes use of SATTPICK().

  Source:
  -------
  S_CLRFUN.PRG

 

SP_COLPIK

COLPIK()

  Short:
  ------
  COLPIK() Allows selection of colors from a list

  Returns:
  --------
  Nothing

  Syntax:
  -------
  COLPIK()

  Description:
  ------------
  Gives the user a choice of 12 pre-defined color
  combinations to choose from

  Examples:
  ---------
   COLPIK()

  Notes:
  -------
  Color combo is stored to COLORS.DBF (or whatever name
  is assigned - see SLSF_COLOR()  ).

  See appendix for more info on colors usage by the
  library.

  Source:
  -------
  S_COLPIK.PRG