TkGetScrollInfo(3) Tk Library Procedures TkGetScrollInfo(3)

NAME
       TkGetScrollInfo,  TkGetScrollInfoObj  - parse arguments for scrolling
       commands

SYNOPSIS
       ##iinncclluuddee <>

       int
       TTkkGGeettSSccrroollllIInnffoo((interp, argc, argv, dblPtr, intPtr))

       int
       TTkkGGeettSSccrroollllIInnffooOObbjj((interp, objc, objv, dblPtr, intPtr))

AARRGGUUMMEENNTTSS
       TclInterp   *interp   (in)      Interpreter to use for  error  report-
                                        ing.

       int          argc      (in)      Number of strings in argv array.

       CONST char   *argv[]   (in)      Argument strings.  These represent the
                                        entire widget command,  of  which  the
                                        first  word  is  typically  the widget
                                        name and the second word is  typically
                                        xxvviieeww or yyvviieeww.

       int          objc      (in)      Number of TclObj's in objv array.

       TclObj *CONST         objv[](in)
                                        Argument objects.  These represent the
                                        entire widget command,  of  which  the
                                        first  word  is  typically  the widget
                                        name and the second word is  typically
                                        xxvviieeww or yyvviieeww.

       double       *dblPtr   (out)     Filled  in  with  fraction from mmoovveettoo
                                        option, if any.

       int          *intPtr   (out)     Filled in with line or page count from
                                        ssccrroollll  option, if any.  The value may
                                        be negative.



DESCRIPTION
       TTkkGGeettSSccrroollllIInnffoo parses the arguments expected by widget scrolling com-
       mands  such  as  xxvviieeww and yyvviieeww.  It receives the entire list of words
       that make up a widget  command  and  parses  the  words  starting  with
       argv[2].   The words starting with argv[2] must have one of the follow-
       ing forms:
              mmoovveettoo fraction
              ssccrroollll number uunniittss
              ssccrroollll number ppaaggeess

       Any of the mmoovveettoo, ssccrroollll, uunniittss, and ppaaggeess keywords  may  be  abbrevi-
       ated.   If  argv  has  the mmoovveettoo form, TTKKSSCCRROOLLLLMMOOVVEETTOO is returned as
       result and *dblPtr is filled in with the fraction argument to the  com-
       mand,  which must be a proper real value.  If argv has the ssccrroollll form,
       TTKKSSCCRROOLLLLUUNNIITTSS or TTKKSSCCRROOLLLLPPAAGGEESS is returned and *intPtr is filled in
       with  the  number  value,  which must be a proper integer.  If an error
       occurs in parsing the arguments, TTKKSSCCRROOLLLLEERRRROORR  is  returned  and  an
       error message is left in interp->result.

       TTkkGGeettSSccrroollllIInnffooOObbjj is identical in function to TTkkGGeettSSccrroollllIInnffoo.  How-
       ever, TTkkGGeettSSccrroollllIInnffooOObbjj accepts TclObj style  arguments,  making  it
       more appropriate for use with new development.


KKEEYYWWOORRDDSS
       parse, scrollbar, scrolling command, xview, yview



Tk                                    8.0                  TkGetScrollInfo(3)