Topic       : TOS - The Operating System
Author      : 
Version     : tos.hyp (December 19, 2008)
Subject     : Programmieren/Atari
Nodes       : 3010
Index Size  : 93790
HCP-Version : 5
Compiled on : Atari
@charset    : atarist
@lang       : 
@default    : Title
@help       : 
@options    : +g -i -s +x +zz -t4
@width      : 70
View Ref-File7.7.29  vsm_locator                                                TOS

 Name:         »Input locator, Sample mode« - Obtain the position of 
               the graphic cursor.

 Opcode:       28

 Syntax:       int16_t vsm_locator ( int16_t handle, int16_t x, 
               int16_t y, int16_t *xout, int16_t *yout, int16_t *term 
               );

 Description:  The call vsm_locator sets or obtains the position of 
               the 'locator' (graphic cursor) in SAMPLE mode. The 
               following apply:

                Position   Meaning

                handle     Workstation identifier
                x          Initial X-coordinate, and
                y          Y-coordinate of the graphic cursor
                xout       Final X-coordinate, and
                yout       Y-coordinate of graphic cursor on return
                term       In the low byte, the ASCII code of the 
                           terminating key will be filled in; since 
                           special keys (mouse buttons, etc.) are 
                           assigned values from 32 (left button) and 
                           33 (right button), they cannot be 
                           differentiated directly from keys of the 
                           keyboard

               This function does not make the graphic cursor visible; 
               key presses or cursor movements will only be reported 
               if they have actually taken place.

               Notes: The input functions of the VDI work only on the 
               physical workstation, which is normally used by the 
               AES.

               Using this call will confuse the AES.

 Return value: The function returns coded information about whether 
               the cursor position has changed (bit 0 set) and whether 
               a key was pressed (bit 1 set).

 Availability: The function is not supported by all device drivers.

 Group:        Input functions

 See Also:     Binding   vrq_locator   vsin_mode