Daily Archives: November 21, 2013

SP_SBROWS

Posted on by vivaclipper 
SBROWS()

  Short:
  ------
  SBROWS() Determine number of rows in a box

  Returns:
  --------
  <nRows> => rows in the box

  Syntax:
  -------
  SBROWS(nTop,nBottom,[lIncludeFrame])

  Description:
  ------------
  The number of rows of a box with top of <nTop> and
  bottom of <nBottom> is returned. By default, the frame is
  included (the top and the bottom)

  [lIncludeFrame] by default is True - and all rows are
  counted. If passed as False, only the inside rows are counted.

  Examples:
  ---------
   nRows := SBROWS(nTop,nBottom,.f.)
   for i = nTop to nRows
     @nTop+i,nLeft say i
   next

  Source:
  -------
  S_BOXES.PRG

 

SP_SBCOLS

Posted on by vivaclipper 
SBCOLS()

  Short:
  ------
  SBCOLS() Determine number of columns in a box

  Returns:
  --------
  <nCols> => columns in the box

  Syntax:
  -------
  SBCOLS(nLeft,nRight,[lIncludeFrame])

  Description:
  ------------
  The number of columns of a box with left of <nLeft>
  and right of <nRight> is returned. By default, the frame is
  included (the left and the right)

  [lIncludeFrame] by default is True - and all columns
  are counted. If passed as False, only the inside columns are
  counted.

  Examples:
  ---------
   // this example fills a box with "X"'s

   nRows := SBROWS(nTop,nBottom,.f.)
   nCols := SBCOLS(nLeft,nRight,.f.)
   for i = nTop to nRows
     @nTop+i,nLeft say repl("X",nCols)
   next

  Source:
  -------
  S_BOXES.PRG

 

SP_SBCENTER

Posted on by vivaclipper 
SBCENTER()

  Short:
  ------
  SBCENTER() Centers box coordinates

  Returns:
  --------
  Nil

  Syntax:
  -------
  SBCENTER(@nTop,@nLeft,@nBottom,@nRight)

  Description:
  ------------
  Dimensions nTop,nLeft,nBottom,nRight are passed by
  reference.

  They are changed by SBCENTER to dimensions that are
  centered on the screen.

  Examples:
  ---------

   nTop    := 0
   nLeft   := 0
   nBottom := nRows+2
   nRight  := nMaxwidth+2

   SBCENTER(@nTop,@nLeft,@nBottom,@nRight)
                  // center the coordinates

   cBox := makebox(nTop,nLeft,nBottom,nRight)

  Source:
  -------
  S_BOXES.PRG

 

SP_SAVESETKEYS

Posted on by vivaclipper 
SAVESETKEYS()

  Short:
  ------
  SAVESETKEYS() Saves active set keys to an array

  Returns:
  --------
  <aSaved> => setkey setting saved to an array

  Syntax:
  -------
  SAVESETKEYS([lClear])

  Description:
  ------------
  Saves the inkey codes and codeblocks associated with
  all active setkeys to an array.

  [lClear] If True, clear any active setkeys (set to NIL)

  Examples:
  ---------
   aSaved := SAVESETKEYS(.t.)

   * do stuff

   RESTSETKEYS(aSaved)

  Source:
  -------
  S_SETKEY.PRG

 

SP_SATTPUT

Posted on by vivaclipper 
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

Posted on by vivaclipper 
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

Posted on by vivaclipper 
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

Posted on by vivaclipper 
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

Posted on by vivaclipper 
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