__XSaveScreen()

Template

Procedure

Name

__XSaveScreen()

Category

API

Subcategory

User interface

Oneliner

Save whole screen image and coordinate to an internal buffer

Syntax

      __XSaveScreen()

Arguments

none.

Description

__XSaveScreen() save the image of the whole screen into an internal buffer, it also save current cursor position. The information could later be restored by __XRestScreen(). Each call to __XSaveScreen() overwrite the internal buffer.

SAVE SCREEN command is preprocessed into __XSaveScreen() function during compile time. Note that SAVE SCREEN TO is preprocessed into SaveScreen() function.

__XSaveScreen() is a compatibility function, it is superseded by SaveScreen() which allow you to save part or all the screen into a variable.

Examples

      // save the screen,  display list of files than restore the screen
      SAVE SCREEN
      DIR *.*
      WAIT
      RESTORE SCREEN

Compliance

Clipper

Platforms

All(GT)

Files

Library is core

Seealso

RESTORE SCREEN, RestScreen(), SaveScreen()

SP_SS_WIPEV

SS_WIPEV()

  Short:
  ------
  SS_WIPEV() Restores screen in a wipe from top fashion.
  Alternative to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_WIPEV(nTop,nLeft,nBottom,nRight,cInScreen,[nDelay])

  Description:
  ------------
  Restores screen <cInScreen> in a wipe from top
  fashion.

  <cInscreen> is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>, <nRight> are the screen coordinates.

  [nDelay]  is a delay factor. Default is 50. (Smaller
  # is faster)

  Relative to the speed of the machine.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   SS_WIPEV(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG

 

SP_SS_WIPEH

SS_WIPEH()

  Short:
  ------
  SS_WIPEH() Restores screen in a wipe from left fashion.
  Alternative to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_WIPEH(nTop,nLeft,nBottom,nRight,cInScreen,[nDelay])

  Description:
  ------------
  Restores screen <cInScreen> in a wipe fromleft
  fashion.

  <cInscreen> is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>, <nRight> are the screen coordinates.

  [nDelay]  delay factor. Default is 100. (Smaller # is
  faster)

  Relative to the speed of the machine.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   SS_WIPEH(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG

 

SP_SS_VBLINDS

SS_VBLINDS()

  Short:
  ------
  SS_VBLINDS() Restores screen in a vertical blind fashion.
  Alternative to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_VBLINDS(nTop,nLeft,nBottom,nRight,cInScreen,[nDelay])

  Description:
  ------------
  Restores screen <cInScreen> in a horizontal blind
  fashion.

  <cInscreen>is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>,<nRight> are the screen coordinates.

  [nDelay]  delay factor. Default is 100. Higher number
  makes a slower

  screen restore. Lower number makes a faster screen
  restore. Relative to the speed of the machine.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   ss_vblinds(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG

 

SP_SS_SPLIT

SS_SPLIT()

  Short:
  ------
  SS_SPLIT() Restores screen in a split from middle fashion.
  Alternative to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_SPLIT(nTop,nLeft,nBottom,nRight,cInScreen,[nDelay])

  Description:
  ------------
  Restores screen <cInScreen> in a split from middle
  fashion. <cInscreen> is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>,<nRight> are the screen coordinates.

  [nDelay]  is a delay factor. Default is 5. (Larger #
  is faster)

  Relative to the speed of the machine.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   SS_SPLIT(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG

 

SP_SS_SLIDELEFT

SS_SLIDELEFT()

  Short:
  ------
  SS_SLIDELEFT() Restores screen in a slide left fashion.
  Alternative to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_SLIDELEFT(nTop,nLeft,nBottom,nRight,cInScreen)

  Description:
  ------------
  Restores screen <cInScreen> in a slide left fashion.

  <cInscreen> is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>,<nRight> are the screen coordinates.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   SS_SLIDELEFT(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG

 

SP_SS_SLICE

SS_SLICE()

  Short:
  ------
  SS_SLICE() Restores screen in a slicing fashion. Alternative
  to restscreen()

  Returns:
  --------
  Nothing

  Syntax:
  -------
  SS_SLICE(nTop,nLeft,nBottom,nRight,cInScreen,[nDelay])

  Description:
  ------------
  Restores screen <cInScreen> in a slicing fashion.
  <cInscreen>

  is a screen saved with SAVESCREEN().
  <nTop>,<nLeft>,<nBottom>,<nRight> are the screen coordinates.

  [nDelay]  is a delay factor. Default is 8. (Larger #
  is faster)

  Relative to the speed of the machine.

  Examples:
  ---------
   MainScreen := savescreen(0,0,24,79)

   DOSOMESCREENSTUFF()

   DOMORESCREENSTUFF()

   SS_SLICE(0,0,24,79,MainScreen)

  Source:
  -------
  S_SCREENS.PRG