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);

  (**
      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);

  (**
      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);

  (**
      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);

  (**
      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);

  (**
      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);

  (**
      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);

  (**
      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);

  (**
      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