•  Back 
  •  Output functions 
  •  Index 
  •  Tree View 
  •  Cross references 
  •  Help page 
  •  Show info about hypertext 
  •  View a new file 
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.5.33  v_justified                                                TOS

 Name:         »Justified graphics text« - Outputs positioned graphic 
               text.

 Opcode:       11 (GDP 10)

 Syntax:       void v_justified ( int16_t handle, int16_t x, int16_t 
               y, int8_t *string, int16_t length, int16_t word_space, 
               int16_t char_space, [int16_t *char_width] );

 Description:  The call v_justified outputs graphic text on a 
               workstation, lengthening or shortening the text string 
               to a specified length by modifying the inter-word or 
               inter-character spacing. If using a vector font, the 
               requested width of the string refers to the sum of the 
               character widths; it does not take remainder data or 
               characters extending outside the edges of the emsquare 
               into account. The following apply:

                Parameter   Meaning

                handle      Workstation identifier
                x           X-coordinate, and
                y           Y-coordinate of the text start point
                string      Character string as ASCII-codes (NULL- 
                            terminated)
                length      Requested length of the string, in X-axis 
                            pixels
                word_space  Inter-word spacing:
                               0 =  Do not allow VDI to modify inter- 
                                    word spacing
                             <>0 =  Allow VDI to modify inter-word 
                                    spacing
                char_space  Inter-character spacing:
                               0 =  Do not allow VDI to modify inter- 
                                    character spacing
                             <>0 =  Allow VDI to modify inter- 
                                    character spacing

               The text will be aligned left and right with reference 
               to the start point and the length. To bring the text to 
               the desired length, one has the choice of stretching 
               the word and/or the character interspaces.

               The text attributes and the writing mode will be 
               respected. Characters that are missing in the font will 
               be substituted by a replacement symbol (e.g. the 
               question-mark).

               For vector fonts the length specification refers to the 
               sum of the character widths - overhangs to left and 
               right are not taken into account.

               From GEM/3 on the function was changed appreciably. The 
               parameter char_width was added. It returns the number 
               of pixels of each character in the output character 
               string. With this, there has also been a change in the 
               parameters of word_space and char_space as follows:

                Parameter   Meaning

                word_space  Inter-word spacing:
                             0x0000 = No stretching of interspaces, no 
                                    output information returned
                             0x0001 = Stretch interspaces, no output 
                                    information returned
                             0x8000 = No stretching of interspaces, 
                                    output information (char_space) is 
                                    returned
                             0x8001 = Stretch interspaces, output 
                                    information (char_space) is 
                                    returned
                char_space  Inter-character spacing
                             0x0000 = No stretching of interspaces
                             0x0001 = Stretch interspaces

 Return value: The function does not return a result.

 Availability: Supported by all drivers. This function comprises one 
               of the 10 VDI GDP's (Generalized Drawing Primitives). 
               Although all current drivers support all GDP's, their 
               availability is not guaranteed and may vary. To check 
               for a particular GDP refer to the table returned by 
               v_opnvwk or v_opnwk.

 Group:        Output functions

 See Also:     Binding   vswr_mode   vs_color   vst_alignment 
               vst_height   vst_point   vst_rotation   vst_font 
               vst_color   vst_effects