SP Color functions

1. These are the functions that relate to entire color sets

  SATTCOLOR()         Sets up the the color set for color monitor
  SATTMONO()          Sets up the the color set for MONO
  SATTDIRECT()        Sets up the the color set directly
  SATTGET()           Sets up color set from COLORS.DBF
  SATTPICK()          Sets up color set by selecting from stored definitions
  SATTGETMEM()        Sets up color set from old colors.mem
  SATTPUT()           Stores current color set  to colors.dbf
  SATTPICKPUT()       Stores current SuperLib color set to
                      colors.dbf, with picklist selection of set
  SATTPICKDEL()       Picklist deletion of stored color sets
  SATTPUSH()          Pushes the current SuperLib color set
  SATTPOP()           Pops previously pushed color set
  SETCOLORS()         Interactive color setting -
                      save/restore/edit color sets
  COLPIK()            10 built in color sets to select
                      from a popup

 2. These are the functions that deal with individual color set items

  SLS_NORMCOL()       Normal screen output
  SLS_NORMMENU()      Normal MENU color
  SLS_POPCOL()        Popup screen output
  SLS_POPMENU()       Popup MENU color
  SLS_FRAME()         Box frames
  SLS_SHADATT()       Shadow attribute
  SLS_SHADPOS()       Shadow position
  SLS_XPLODE()        Explode/implode popups

 3. Other color related functions

  SLS_ISCOLOR( )      Is this a color monitor

SP SuperLib Environment Functions

 SETCOLORS()    Interactive color setting interface

 SATTPOP()      Pops previously pushed SuperLib interface variables
 SATTPUSH()     Pushes the current SuperLib interface variables
 SATTPICKPUT()  Stores SuperLib environment variables to COLORS.DBF
                with picklist
 SATTPICKDEL()  Picklist deletion of stored color sets
 SATTPUT()      Stores current SuperLib environment variables to DBF
 SLS_*()        Series of functions for system settings and colors
 SLSF_*()       Series of functions to determine system file names and
                locations
 INITSUP()      Sets SuperLib system interface vars for MONO or COLOR
 SATTDIRECT()   Sets up the the system color and interface settings directly
 SATTGET()      Sets up SuperLib environment variables from COLORS.DBF
 SATTCOLOR()    Sets up the the system color and interface settings
                for color monitor
 SATTPICK()     Sets up SuperLib environment vars by selecting from
                stored definitions
 SATTMONO()     Sets up the the system color and interface settings
                for MONOCHROME monitor
 SATTGETMEM()   Sets up SuperLib environment variables from old
                COLORS.MEM file

SP_SETCOLORS

SETCOLORS()

  Short:
  ------
  SETCOLORS() Interactive color setting interface

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SETCOLORS()

  Description:
  ------------
  This is a development tool for finding nice
  combinations of colors for the global superfunction colors. I would
  not give this to an end user, as it is just TOO MANY CHOICES! I
  normally select 10-15 nice combinations of the colors and give
  the user a selection of those, giving them such names as
  'Hawaiian Blue' or 'Royal Red'. In fact, see COLPIK() for just
  such a function.

  If SETBLINK() is set to False (.f.), the high
  intensity colors will be available - if your monitor supports them.

  Examples:
  ---------
   SETCOLORS()

  Notes:
  -------
  First, a word on the Superfunction color scheme:

  This is not the perfect color scheme. It is the one
  on which this library runs. (hey - I hadda pick something) I
  also realize full well that color selection is more art than it
  is technical, and it is difficult to get two people to agree on
  a color scheme.

  Several global color settings are used, and they are
  recorded and accessed via the functions:

     sls_normcol([cNew])    -  For normal input/output
     sls_normmenu([cNew])   -  For normal 'menu to' operations
     sls_popcol([cNew])     -  For popup box colors
     sls_popmenu([cNew])    -  For popup box menus
     sls_frame([cNew])      -  Frame string
     sls_shadatt([nNew])    -  Shadow color attribute
                              (numeric)
     sls_shadpos([nNew])    -  Shadow position (0,1,3,7,9)
     sls_xplode([lNew])     -  Logical - explode windows?

     (All of the colors are of the format "f/b,f/b,,,f/b"
      where f=foreground b=background)

  SETCOLORS() allows interactive setting of these
  colors. The settings can stored as color sets in COLORS.DBF -
  which is created if needed by SETCOLORS().

  If COLORS.DBF is not present, SuperLib will use a
  default set of colors.

  See the SATT*() functons, and the SLS_*() functions
  for more info.

  See the appendix for more general colors info.

  See the upgrade notes for more info on upgrading from
  older SuperLibs, which used a public variable scheme.

  Source:
  -------
  S_SETCOL.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_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_SATTGET

SATTGET()

  Short:
  ------
  SATTGET() Sets up SuperLib color vars from COLORS.DBF

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

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

  Description:
  ------------
  This sets up the system color and interface variables
  described in SLS_*() by grabbing them from the COLORS.DBF file, as
  described in 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")

  Notes:
  -------
  SATTPUT() and SETCOLORS() allow store of color sets.

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

---