pad_icon_wait()

PAD_$ICON_WAIT                    Domain/OS                     PAD_$ICON_WAIT


NAME
     pad_$icon_wait - wait until an icon expands or moves

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

     void pad_$icon_wait(
          ios_$id_t &stream_id,
          short &window_no,
          boolean *icon_moved,
          pad_$position_t *icon_pos,
          status_$t *status)

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

     procedure pad_$icon_wait(
          in stream_id: ios_$id_t;
          in window_no: integer;
          out icon_moved: boolean;
          out icon_pos: pad_$position_t;
          out status: status_$t);

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

           integer*4 status
           integer*2 stream_id, window_no
           integer*2 icon_pos(2), x_coord, y_coord
           logical icon_moved

           equivalence (x_coord, icon_pos(1)), (y_coord, icon_pos(2))

           call pad_$icon_wait(stream_id, window_no, icon_moved,
          &                    icon_pos, status)

DESCRIPTION
     Pad_$icon_wait suspends program execution until the icon specified by
     stream_id and window_no is either moved or expanded to full size.
     Pad_$icon_wait may be used on any type of pad, but it returns immediately
     when the window specified by stream_id and window_no is not an icon.

     stream_id
          The stream ID of the pad viewed by the window to wait on.

     window_no
          The number of the window to wait on.  Window_no is an index into the
          window list returned by pad_$inq_windows.  A window_no of 1 always
          refers to the first window created to view the pad.

     icon_moved
          A Boolean value indicating icon-window movement.  Its value is true
          if pad_$icon_wait returned due to icon movement.  Its value is false
          if pad_$icon_wait returns for some other reason.

     icon_pos
          The new position, in pad_$position_t format, of the moved icon.

     status
          The completion status.

SEE ALSO
     pad_$edit_wait, pad_$force_prompt, pad_$inq_icon, pad_$is_icon,
     pad_$make_icon, pad_$make_invisible, pad_$set_icon_pos.
Museum
