tpad_inquire()

TPAD_$INQUIRE                     Domain/OS                      TPAD_$INQUIRE


NAME
     tpad_$inquire - get information about the current locator response

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

     void tpad_$inquire(
          tpad_$mode_t *mode,
          short *x_scale,
          short *y_scale,
          short *hysteresis,
          smd_$pos_t *origin)

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

     procedure tpad_$inquire(
          out mode: tpad_$mode_t;
          out x_scale: integer;
          out y_scale: integer;
          out hysteresis: integer;
          out origin: smd_$pos_t);

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

           integer*2 mode, x_scale, y_scale, hysteresis
           integer*2 line, column, origin(2)

           equivalence (line, origin(1)), (column, origin(2))

           call tpad_$inquire(mode, x_scale, y_scale, hysteresis, origin)

DESCRIPTION
     This call supplies information about the response of the current locator
     device.  Use the information from this call to save the locator confi-
     guration for later restoration with the tpad_$set_mode call, or to change
     one aspect of the locator response without changing any other aspects.

     mode The cursor mode.  It can be one of the following predefined values:

          tpad_$absolute
               Absolute mode maps the locator to a part of the screen dictated
               by the scaling factor and the origin value.  Thus, there is a
               one-to-one mapping between points in the locator space and a
               subset of points on the screen.

          tpad_$relative
               In relative mode, the cursor responds only to locator movement
               relative to the current position.  The response of the cursor
               simulates response to mouse movement.

          tpad_$rel_abs
               In relative/absolute mode, the cursor responds as in absolute
               mode on first contact to establish a new current position.
               After first contact, the cursor responds as in relative mode.
               Momentary lifting of the finger from a touchpad (for less than
               about half a second) does not affect the current cursor posi-
               tion.

     x_scale
          The scale factor in the x-dimension.

     y_scale
          The scale factor in the y-dimension.

     hysteresis
          The hysteresis factor, in pixels.

          The hysteresis factor prevents minor, unintentional movements from
          changing the cursor location.  It effectively defines a box around
          the current location.  The cursor does not move while the current
          location stays within the hysteresis box.

          If the current location moves beyond the box, the distance the cur-
          sor moves is the difference between the new location and the past
          location less the hysteresis factor.  The default hysteresis factor
          is 5.

     origin
          The scale origin for x- and y-dimensions in smd_$pos_t format.

SEE ALSO
     tpad_$inq_dtype, tpad_$re_range, tpad_$set_cursor, tpad_$set_mode.
Museum
