GPR_$COND_EVENT_WAIT              GPR Calls               GPR_$COND_EVENT_WAIT


NAME
     gpr_$cond_event_wait - returns event information without entering a wait
     state.

FORMAT
     unobscured := gpr_$cond_event_wait (event_type, event_data, position,
                           status)

DESCRIPTION
     This routine returns event information without entering a wait state.
     When called, this routine returns immediately and reports information
     about any event that has occurred.  Typically, this routine is called
     following return from an ec2_$wait call involving the eventcount returned
     by gpr_$get_ec.  The routine allows the program to obtain information
     about an event without having to suspend all of its activities.

     The input routines report button events as ASCII characters.  "Down"
     transitions range from "a" to "d"; "up" transitions range from "A" to
     "D".  The three mouse keys start with (a/A) on the left side.  As with
     keystroke events, button events can be selectively enabled by specifying
     a button keyset.

     Unless locator data has been processed since the last event was reported,
     "position" will be the last position given to gpr_$set_cursor_position.

     If locator data is received during this call, and gpr_$locator events are
     not enabled, the GPR software will display the arrow cursor and will set
     the keyboard cursor position.

     Unlike gpr_$event_wait, this call never releases the display.

   Return
     unobscured
          A Boolean value that indicates whether or not the window is
          obscured; a false value means that the window is obscured.  This
          value is always true unless the program has called
          gpr_$set_obscured_opt and specified an option of either
          gpr_$ok_if_obs or gpr_$input_ok_if_obs.

   Output Parameters
     event_type
          The type of event that occurred, in gpr_$event_t format.  This is a
          2-byte integer. One of the following values is returned:

          gpr_$coded_keys           Coded key input from a keyboard
          gpr_$function_keys        Function key input from a keyboard
          gpr_$physical_keys        Physical key input from a keyboard
          gpr_$keystroke            Keystroke key input from a keyboard
          gpr_$buttons              Input from mouse or bitpad puck buttons
          gpr_$locator              Input from a touchpad or mouse
          gpr_$locator_update       Most recent input from a touchpad or mouse
          gpr_$entered_window       Cursor has entered window
          gpr_$left_window          Cursor has left window
          gpr_$kbd_entered_window   Keyboard focus has entered window
          gpr_$kbd_left_window      Keyboard focus has left window
          gpr_$locator_stop         Input from a locator has stopped
          gpr_$dial                 Input from dial box
          gpr_$pfk                  Input from LPFK box
          gpr_$no_event             No event has occurred

     event_data
          The keystroke or button character associated with the event, or the
          character that identifies the window associated with an entered-
          window event.  Its datatype is a character (char).  This parameter
          is not modified for other events.

     position
          The position on the screen or within the window at which graphics
          input occurred, in gpr_$position_t format.  This data type is 4
          bytes long.

     status
          Completion status, in status_$t format.

SEE ALSO
     gpr_$event_wait.