Sage-ST ä

Fx

Documentation

ClearWindow ClipForm FadeInForm MoveForm
ScatterForm ScatterWindow SetColor SwitchColors




  procedure ClearWindow
             (const row1 : cardinal;
              const row2 : cardinal;
              const col1 : cardinal;
              const col2 : cardinal); stdcall;

  exports ClearWindow name 'FX_ClearWindow';

  //*
  //  ClearWindow - Clear a portion of the screen to the current color.
  //
  //
  //  This procedure clears a portion of the screen to the current color
  //  as defined by the rows and columns which are the boundaries of
  //  the desired area to be cleared.
  //
  //  CALLING SEQUENCE -
  //
  //    ClearWindow (row1, row2, col1, col2)
  //
  //  ENTRY -
  //
  //    row1 : cardinal
  //      The top row of the area (1 .. 25).
  //
  //    row2 : cardinal
  //      The bottom row of the area (row1 .. 25).
  //
  //    col1 : cardinal
  //      The left column of the area (1 .. 80).
  //
  //    col2 : cardinal
  //      The right column of the area (col1 .. 80).
  //




  procedure ClipForm
             (const FormName  : array of char;
              const topRow    : cardinal;
              const bottomRow : cardinal;
              const leftCol   : cardinal;
              const rightCol  : cardinal;
              const startRow  : cardinal;
              const startCol  : cardinal;
              const endRow    : cardinal;
              const endCol    : cardinal;
              const millisec  : cardinal;
              const trace     : boolean); stdcall;

  exports ClipForm name 'FX_ClipForm';

  //*
  //  ClipForm - Display and optionally move a portion of a form.
  //
  //
  //  This procedure displays and optionally moves a portion of a
  //  form as defined by its boundary rows and columns.
  //
  //  CALLING SEQUENCE -
  //
  //    ClipForm (formName, topRow, bottomRow, leftCol, rightCol,
  //              startRow, startCol, endRow, endCol, millisec, trace)
  //
  //  ENTRY -
  //
  //    formName : array of char
  //      Name of form to be used
  //
  //    topRow : cardinal
  //      Top row of defined area (1 .. 24).
  //
  //    bottomRow : cardinal
  //      Bottom row of defined area (topRow .. 24)
  //
  //    leftCol : cardinal
  //      Left column of defined area (1 .. 80)
  //
  //    rightCol : cardinal
  //      Right column of defined area (leftCol .. 80)
  //
  //    startRow : cardinal
  //      Optional new location (if other than topRow, leftCol) where
  //      the clipped area should be displayed.  Set to 0 if the
  //      location is not different.
  //
  //    startCol : cardinal
  //      Optional new location where area should be displayed.
  //
  //    endRow : cardinal
  //      Optional final location if a moving display is desired.
  //      Set to 0 (zero) if non-moving form is desired.
  //
  //    endCol : cardinal
  //      Optional final location if a moving display if desired.
  //      Set to 0 (zero) if non-moving form is desired.
  //
  //    millisec : cardinal
  //      The time desired to move the area from start to final loc.
  //
  //    trace : boolean
  //      Display a trace of the moving area (True).
  //




  procedure MoveForm
             (const FormName : array of char;
              const startRow : cardinal;
              const startCol : cardinal;
              const endRow   : cardinal;
              const endCol   : cardinal;
              const millisec : cardinal;
              const trace    : boolean); stdcall;

  exports MoveForm name 'FX_MoveForm';

  //*
  //  MoveForm - Display and optionally move a form.
  //
  //
  //  This procedure displays and optionally moves a form.  The
  //  display of the form follows the rules of 'Sage.DisplayBackground'.
  //
  //  CALLING SEQUENCE -
  //
  //    MoveForm (formName, startRow, startCol, endRow, endCol, millisec, trace)
  //
  //  ENTRY -
  //
  //    formName : array of char
  //      Name of form to be used
  //
  //    startRow : cardinal
  //      Location to begin move from
  //
  //    startCol : cardinal
  //      Location to begin move from.
  //
  //    endRow : cardinal
  //      Final location of the moving display.
  //
  //    endCol : cardinal
  //      Final location of the moving display.
  //
  //    millisec : cardinal
  //      The time desired to move the form from start to final loc.
  //
  //    trace : boolean
  //      Display a trace of the moving form (True).
  //




  procedure SetColor
             (const foreGround : array of char;
              const backGround : array of char;
              const intensity  : boolean;
              const blink      : boolean); stdcall;

  exports SetColor name 'FX_SetColor';

  //*
  //  SetColor - Set the color of the screen.
  //
  //
  //  This procedure allows the setting of the current screen
  //  color.  The foreground and background colors as well as
  //  the foreground intensity and blinking attributes may
  //  be specified.
  //
  //  CALLING SEQUENCE -
  //
  //    SetColor (foreGround, backGround, intensity, blink)
  //
  //  ENTRY -
  //
  //    foreGround : array of char
  //      Foreground color to use.
  //      BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, WHITE
  //
  //    backGround : array of char
  //      Background color to use.
  //      BLACK, BLUE, GREEN, CYAN, RED, MAGENTA, YELLOW, WHITE
  //
  //    intensity : boolean
  //      Set the foreground intensity to high (True) or low (False).
  //
  //    blink : boolean
  //      Blink the foreground (True).
  //




  procedure SwitchColors
             (const oldColor  : cardinal;
              const newColor  : cardinal;
              const millisec  : cardinal;
              const topRow    : cardinal;
              const bottomRow : cardinal;
              const leftCol   : cardinal;
              const rightCol  : cardinal); stdcall;

  exports SwitchColors name 'FX_SwitchColors';

  //*
  //  SwitchColors - Switch colors on the screen.
  //
  //
  //  This procedure switches the indicated color on the screen in
  //  a top to bottom sweep to the new color.  The time in milliseconds
  //  may be specified to complete the sweep.  If the sweep time is
  //  very small, it will appear to happen suddenly.
  //
  //  CALLING SEQUENCE -
  //
  //    SwitchColors (oldColor, newColor, millisec, topRow, bottomRow,
  //                  leftCol, rightCol)
  //
  //  ENTRY -
  //
  //    oldColor : cardinal
  //      The old color to switch from.
  //
  //    newColor : cardinal
  //      The new color to switch to.
  //
  //    millisec : cardinal
  //      The number of milliseconds to take to switch colors.
  //
  //    topRow : cardinal
  //      The first row to begin the switch (1 .. n).
  //
  //    bottomRow : cardinal
  //      The last row to switch (topRow .. n).
  //
  //    leftCol : cardinal
  //      The left most column to switch (1 .. n).
  //
  //    rightCol : cardinal
  //      The right most column to switch (leftCol .. n).
  //




  procedure ScatterWindow
             (const row1 : cardinal;
              const row2 : cardinal;
              const col1 : cardinal;
              const col2 : cardinal); stdcall;

  exports ScatterWindow name 'FX_ScatterWindow';

  //*
  //  ScatterWindow - Scatter and reconstruct the indicated window.
  //
  //
  //  This procedure scatters and then reconstructs the window
  //  specified by the indicated rows and columns.  The scatter
  //  occurs almost instantaneously, but the reconstruction
  //  is a longer event to give the appropriate effect.
  //
  //  CALLING SEQUENCE -
  //
  //    ScatterWindow (row1, row2, col1, col2)
  //
  //  ENTRY -
  //
  //    row1 : cardinal
  //      The top row of the area (1 .. 25).
  //
  //    row2 : cardinal
  //      The bottom row of the area (row1 .. 25).
  //
  //    col1 : cardinal
  //      The left column of the area (1 .. 80).
  //
  //    col2 : cardinal
  //      The right column of the area (col1 .. 80).
  //




  procedure ScatterForm
             (const FormName : array of char); stdcall;

  exports ScatterForm name 'FX_ScatterForm';

  //*
  //  ScatterForm - Scatter and reconstruct the indicated form.
  //
  //
  //  This procedure scatters and then reconstructs the specified
  //  form.  The display of the form follows the rules of
  //  'Sage.DisplayBackground'.
  //
  //  CALLING SEQUENCE -
  //
  //    ScatterForm (formName);
  //
  //  ENTRY -
  //
  //    formName : array of char
  //      Name of form to reconstruct from a scattered appearance.
  //
  //  EXIT -
  //
  //    Sage.SageError : cardinal
  //      Errors in the operation.
  //




  procedure FadeInForm
             (const FormName : array of char); stdcall;

  exports FadeInForm name 'FX_FadeInForm';

  //*
  //  FadeInForm - Fade in a form.
  //
  //
  //  This procedure fades in a form.  The display of the form
  //  follows the rules of 'Sage.DisplayBackground'.
  //
  //  CALLING SEQUENCE -
  //
  //    FadeInForm (formName);
  //
  //  ENTRY -
  //
  //    formName : array of char
  //      Name of form to fade in.
  //
  //  EXIT -
  //
  //    Sage.SageError : cardinal
  //      Errors in the operation.
  //




Send mail to   warren.merrill@inl.gov with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance