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-File8.12.8  graf_rubberbox/graf_rubbox                                 TOS

 Name:         »Graphics rubberbox« - Draw 'rubber band' outline 
               rectangle on the screen.

 Opcode:       70

 Syntax:       int16_t graf_rubberbox ( int16_t gr_rx, int16_t gr_ry, 
               int16_t gr_minwidth, int16_t gr_minheight, int16_t 
               *gr_rlastwidth, int16_t *gr_rlastheight );

               or

               int16_t graf_rubbox ( ... );

 Description:  The call graf_rubberbox displays a 'rubber band' in the 
               form of a rectangle on the screen, whose top left 
               corner remains fixed and its bottom right corner can be 
               moved while the left mouse button is held down. The 
               following apply:

                Parameter       Meaning

                gr_rx           X-coordinate, and
                gr_ry           Y-coordinate of initial corner
                gr_minwidth     Minimum width of rubber band box
                gr_minheight    Minimum height of rubber band box
                gr_rlastwidth   Width, and
                gr_rlastheight  Height of rubber band box when 
                                releasing the mouse button

               Note: For the reasons mentioned above, the function 
               should only be called with an already pressed mouse 
               button, since it returns when the button is released. 
               It's interesting that the minimum width and height 
               parameters may also take negative values; the rubber 
               band may then be stretched from bottom right to top 
               left.

               In older GEM documentation this function is also called 
               'graf_rubbox'!

 Return value: An error has arisen only if the value 0 is returned.

 Availability: All AES versions.

 Group:        Graphics library

 See Also:     Binding