Tk_GetScrollInfo (3)
parse arguments for scrolling commands
SYNOPSIS
#include <tk.h>
int
Tk_GetScrollInfo(interp, argc, argv, dblPtr, intPtr)
ARGUMENTS
"Tcl_Interp" *dblPtr
Tcl_Interp *interp in
Interpreter to use for error reporting.
int argc in
Number of strings in argv array.
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 xview or yview. This procedure parses
arguments starting with argv[2].
double *dblPtr out
Filled in with fraction from moveto option, if any.
int *intPtr out
Filled in with line or page count from scroll option, if any.
The value may be negative.
DESCRIPTION
Tk_GetScrollInfo parses the arguments expected by widget
scrolling commands such as xview and yview.
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 following forms:
moveto fraction
scroll number units
scroll number pages
Any of the moveto, scroll, units, and pages
keywords may be abbreviated.
If argv has the moveto form, TK_SCROLL_MOVETO
is returned as result and *dblPtr is filled in with the
fraction argument to the command, which must be a proper real
value.
If argv has the scroll form, TK_SCROLL_UNITS
or TK_SCROLL_PAGES 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, TK_SCROLL_ERROR
is returned and an error message is left in interp->result.
KEYWORDS
parse, scrollbar, scrolling command, xview, yview
'\"
'\" Copyright (c) 1990-1994 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: GetSelect.3,v 1.2 1998/09/14 18:22:51 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
