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.6.37  vqt_extent                                                 TOS

 Name:         »Inquire text extent« - Obtain the length of a text 
               string.

 Opcode:       116

 Syntax:       void vqt_extent ( int16_t handle, int8_t *string, 
               int16_t *extent );

 Description:  The call vqt_extent returns the minimal bounding box of 
               a string of text in pixels. Correct bounding 
               information is also output for rotated text.

               Example:




               The function is passed the following parameters:

                Parameter  Meaning

                handle     Workstation identifier
                string     Character string
                extent[0]  X-coordinate, and
                extent[1]  Y-coordinate of the bottom left corner
                extent[2]  X-coordinate, and
                extent[3]  Y-coordinate of the bottom right corner
                extent[4]  X-coordinate, and
                extent[5]  Y-coordinate of the top right corner
                extent[6]  X-coordinate, and
                extent[7]  Y-coordinate of the top left corner

               Notes: If the selected font is an outline (vector) 
               font, the character widths (vqt_width) will be added 
               and the string (especially the leftmost and the right- 
               most character) might exceed the returned rectangle. 
               For this reason it may be better to fall back on the 
               vqt_f_extent function which provides more accurate 
               information by taking special factors into account, or 
               the vqt_real_extent function if working under NVDI.

               In old GEM versions, incidentally, the function does 
               not work correctly if the text string contains umlauts, 
               as old GEM versions could not yet handle these 
               properly.

 Return value: The function does not return a result.

 Availability: Supported by all drivers.

 Group:        Inquire functions

 See Also:     Binding   vst_height   vst_point   vst_rotation 
               vst_font   vst_effects   vqt_f_extent   vqt_real_extent