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.6.13  edit_get_scrollinfo                                        TOS

 Name:         »Edit Object Get Scrollinformation« - Examine settings: 
               Scroll information

 Opcode:       216 (sub-opcode 9)

 Syntax:       void edit_get_scrollinfo ( OBJECT *tree, int16_t obj, 
               int32_t *nlines, int32_t *yscroll, int16_t *yvis, 
               int16_t *yval, int16_t *ncols, int16_t *xscroll, 
               int16_t *xvis );

 Description:  The call edit_get_scrollinfo obtains information about 
               scrollable text capabilities in an editable object. The 
               following apply:

                Parameter  Meaning

                tree       RSC-tree of object
                obj        Object index
                nlines     Number of lines in text
                yscroll    First visible line
                yvis       Number of max. visible lines
                yval       Number of currently visible lines
                ncols      Number of columns, or -1 (unknown)
                xscroll    Horizontal scroll offset in pixels
                xvis       Number of visible columns (in pixels)

               This information is required in order to set the 
               horizontal and vertical scroll bars. As the editable 
               object would have to make a vq_extend for each 
               individual line, actually at each alteration of a line, 
               the number of columns is currently not defined and the 
               call returns -1.
               MGEDIT here simply assumes a fixed width, in the same 
               way as other programs e.g. VIEW.PRG and PC.PRG do as 
               well. yval is always smaller or equal to yvis. If the 
               text has fewer lines that yvis, then yval is always 
               smaller.

 Return value: The function does not return a result.

 Availability: As of MagiC 5.20 by means of a shared library.

 Group:        Editable object functions

 See Also:     Binding