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

 

Advertisements

SP_PROGEVAL

PROGEVAL()

  Short:
  ------
  PROGEVAL() Perform a Database DBEVAL() with a progress box

  Returns:
  --------
  Nil

  Syntax:
  -------
  PROGEVAL(bBlock,expCondit,[cMessage],[bMessage],[lPause])

  Description:
  ------------
  Pops up a progress bar box with PROGON().

  Performs a DBEVAL() using <bBlock> as the first
  parameter, and <expCondit> as the FOR condition. (can be
  passed as a codeblock or a string).

  [cMessage] is an optional box title for the progress
  box

  [bMessage] is a codeblock which returns a string
  which will be displayed on the bottom inside line of the progress
  box for each record processed.

  [lPause] if True will pause before removing the box
  with PROGOFF()- default is False.

  Examples:
  ---------

   // here is a counting example
   nCount   := 0
   nScanned := 0
   bDisplay := {||alltrim(str(nCount))+" matches of "+;
                  alltrim(str(nScanned++))+" scanned"}
   ProgEval({||++nCount},"[S]$LNAME","Counting",bDisplay,.t.)

   // OR
   ProgEval({||++nCount},{||"S"$LNAME},"Counting",bDisplay,.t.)

  Notes:
  -------
  Look up on DBEVAL() and note that this function is
  the same, except it uses only the first two parameters.

  Source:
  -------
  S_PROG.PRG

See also : PROGCOUNT(), PROGDISP(), PROGINDEX(), PROGOFF(), PROGON()

SP_PROGDISP

PROGDISP()

  Short:
  ------
  PROGDISP() Displays progress bar in box created with PROGON()

  <quick descrip>

  Returns:
  --------
  <expReturn> => determined by several things

  Syntax:
  -------
  PROGDISP(nCurrent,nTotal,[bMessage],[bReturn])

  Description:
  ------------
  Updates a progress bar created with PROGON().

  <nCurrent> is the current item/position. <nTotal> is
  the total items. What is displayed is the percentage <nCurrent>
  is of <nTotal>.

  [bMessage] is an optional message line block, which
  is displayed

  on the bottom inside line of the box [bReturn] is an
  optional return value, with the default being  True

  Examples:
  ---------
   //---------- this just shows progress from 1 - 1000
   initsup()
   ProgOn("Test")
   for i = 1 to 1000
     IF !ProgDisp(i,1000,{||alltrim(str(i))+" of 1000"},;
            {||inkey()#27} )
       exit
     endif
   next
   ProgOff()

   //--------- this show indexing progress
   use Customer
   ProgOn("Index")
   dbcreateindex("Eraseme","(LNAME)", ;
    {||ProgDisp( recno(),recc() ),LNAME},.f.)
   ProgOff()
   // note the use of parentheses around LNAME.
   // see also PROGINDEX()

   //--------- this shows a count progress
   nCounted := 0
   nMatches := 0
   bDisplay := {||alltrim(str(nMatches))+" matches of "+;
             alltrim(str(nCounted)) }
   ProgOn("Counting")
   count for "S"$LNAME to ;
      nMatches while ProgDisp(++nCounted,recc(),bDisplay )
   ProgOff()

  Source:
  -------
  S_PROG.PRG

See also : PROGCOUNT(), PROGEVAL(), PROGINDEX(), PROGOFF(), PROGON()

SP_PROGCOUNT

PROGCOUNT()

  Short:
  ------
  PROGCOUNT() Perform a count with a progress box

  Returns:
  --------
  Nil

  Syntax:
  -------
  PROGCOUNT(expCondit,[cMessage],[lPause])

  Description:
  ------------
  Pops up a progress bar box with PROGON().
  Performs a COUNT on the current DBF using
  <expCondit> as the FOR condition. (can be passed as a
  codeblock or a string).

  [cMessage] is an optional box title for the progress
  box

  [lPause] if True will pause before removing the box
  with PROGOFF()- default is False.

  Examples:
  ---------

   use customer

   ProgCount("[S]$LNAME")
   ProgCount({||"S"$LNAME},"Counting",.t.)

  Source:
  -------
  S_PROG.PRG

See also : PROGDISP(), PROGEVAL(), PROGINDEX(), PROGOFF(), PROGON()

SP_FULLDIR

FULLDIR()

  Short:
  ------
  FULLDIR() Interactively navigate directories

  Returns:
  --------
  <lSelected> => Directory was selected

  Syntax:
  -------
  FULLDIR([lChange],[@cDirName])

  Description:
  ------------
  Interactively navigates directories on the current
  drive.

  Allows reading of a file ( with FILEREAD() ) in a
  directory.

  If file is DBF, does a DBEDIT browse (watch your
  memory..)

  [lChange]    True - change to selected directory
               False - don't change to selected directory
               Default is True - change

  [@cDirName] Char string passed by reference, will
  contain name of selected directory on return.

  Examples:
  ---------
   cNewDir := ""

   if FULLDIR(.F.,@cNewDir)
       SET DEFAULT TO (cNewDir)
       ?"New directory is:"
       ?Curdir()
   endif

   if FULLDIR(.t.)
       ?"New directory is:"
       ?Curdir()
   endif

  Source:
  -------
  S_FULLD.PRG

 

SP_FREQANAL

FREQANAL()

  Short:
  ------
  FREQANAL() Performs a frequency analysis on a DBF

  Returns:
  --------
  Nothing

  Syntax:
  -------
  FREQANAL()

  Description:
  ------------
  Performs a point&shoot frequency analysis on selected
  fields of the DBF.

  Allows for tallying of additional numeric fields.

  New to 3.5 - now allows fields of type C D and N to be added
  to the frequency string. Additional Summary fields are now named
  SUM_1, SUM_2...etc in the output results. (previously they retained
  their original name)

  Examples:
  ---------
   USE (cDbfName)

   FREQANAL()

  Source:
  -------
  S_FREQ.PRG

 

SP_DBSTATS

DBSTATS()

  Short:
  ------
  DBSTATS() Statistical report on dbf, including
  sum/avg/min/max/std/var/count

  Returns:
  --------
  Nothing

  Syntax:
  -------
  DBSTATS()

  Description:
  ------------
  This is a point & shoot metafunction which allows the
  user to get statistical data on a dbf, particularly with
  numeric fields.

  Statistics available are: count, sum, average,
  minimum, maximum, variance and standard deviation. the analysis
  may also be based on a conditional criteria.

  Examples:
  ---------
   use (cDbfName)

   DBSTATS()    // its a menu driven metafunction

  Source:
  -------
  S_DBSTAT.PRG