Museum

PAD_$SET_VIEW                     Domain/OS                      PAD_$SET_VIEW


NAME
     pad_$set_view - define the pad region under a window

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/pad.h>

     void pad_$set_view(
          ios_$id_t &stream_id,
          short &window_no,
          long &line,
          short &x_offset,
          short &y_offset,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/pad.ins.pas';

     procedure pad_$set_view(
          in stream_id: ios_$id_t;
          in window_no: integer;
          in line: integer32;
          in x_offset: integer;
          in y_offset: integer;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/pad.ins.ftn'

           integer*4 status, line
           integer*2 stream_id, window_no, x_offset, y_offset

           call pad_$set_view(stream_id, window_no, line,
          &                   x_offset, y_offset, status)

DESCRIPTION
     Pad_$set_view places the pad region specified by line, x_offset, and
     y_offset under the window specified by window_no.

     stream_id
          The stream ID of the pad.

     window_no
          The number of the window viewing the pad.  Pad_$set_view sets the
          view of the window specified with window_no.  Window_no is an index
          into the window list returned by pad_$inq_windows.  A window_no of 1
          refers to the first window created to view the pad.

     line The number of the line in the pad that is to go at the top of the
          window.  The specified line will not be at the top of the window if
          the lines following the specified line cannot fill the window.  If
          the specified line is too near the bottom of the pad, the bottom
          line of the pad will appear at the bottom of the window, and the
          specified line will appear somewhere else within the window.

     x_offset
          The distance to scroll the pad horizontally.  Pad_$set_view will
          horizontally scroll a distance equal to x_offset multiplied by the
          current scale factor.

     y_offset
          The distance to scroll the pad vertically.  Pad_$set_view will vert-
          ically scroll a distance equal to y_offset multiplied by the current
          scale factor.  Only frames can be scrolled vertically.  If line does
          not fall on a frame, then y_offset is ignored.

     status
          The completion status.

NOTES
     Use pad_$inq_view to find out the current pad region under a window.

SEE ALSO
     pad_$set_scale.