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.17  vrq_locator                                                TOS

 Name:         »Input locator, Request mode« - Obtain the mouse 
               position when a key was pressed.

 Opcode:       28

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

 Description:  The call vrq_locator ascertains or sets the position of 
               the graphic cursor (the 'locator') in REQUEST mode. The 
               following apply:

                Parameter  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       The low byte contains a character 
                           terminator. For keyboard-terminated locator 
                           input, this is the ASCII character code of 
                           the key struck to terminate input. For 
                           nonkeyboard-terminated input (tablet, 
                           mouse, and so on), valid locator termina- 
                           tors begin with 20 Hex (space) and increase 
                           from there.

               The user only gets the result when a key is pressed. 
               The graphic cursor is always visible on the screen at 
               the specified position in the current form. One should 
               note that any desired key (including the mouse buttons) 
               may be pressed.

               Normally the movement of the graphic cursor takes place 
               in large steps when the cursor keys are pressed, or in 
               small steps when these are pressed in combination with 
               the Shift key. On the Atari, however, the Alternate key 
               is required as well.

 Return value: The function does not return a result.

 Availability: The function is not supported by all device drivers. 
               The input functions of the VDI work only on the 
               physical workstation, which is normally used by the 
               AES.

 Group:        Input functions

 See Also:     Binding   vsm_locator   vsin_mode