2 '\" Copyright (c) 1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: GetScroll.3,v 1.5 2002/08/05 04:30:38 dgp Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tk_GetScrollInfo 3 8.0 Tk "Tk Library Procedures"
249 Tk_GetScrollInfo, Tk_GetScrollInfoObj \- parse arguments for scrolling commands
252 \fB#include <tk.h>\fR
255 \fBTk_GetScrollInfo(\fIinterp, argc, argv, dblPtr, intPtr\fB)\fR
258 \fBTk_GetScrollInfoObj(\fIinterp, objc, objv, dblPtr, intPtr\fB)\fR
260 .AS "Tcl_Interp" *dblPtr
261 .AP Tcl_Interp *interp in
262 Interpreter to use for error reporting.
264 Number of strings in \fIargv\fR array.
265 .AP "CONST char" *argv[] in
266 Argument strings. These represent the entire widget command, of
267 which the first word is typically the widget name and the second
268 word is typically \fBxview\fR or \fByview\fR.
270 Number of Tcl_Obj's in \fIobjv\fR array.
271 .AP "Tcl_Obj *CONST" objv[] in
272 Argument objects. These represent the entire widget command, of
273 which the first word is typically the widget name and the second
274 word is typically \fBxview\fR or \fByview\fR.
275 .AP double *dblPtr out
276 Filled in with fraction from \fBmoveto\fR option, if any.
278 Filled in with line or page count from \fBscroll\fR option, if any.
279 The value may be negative.
284 \fBTk_GetScrollInfo\fR parses the arguments expected by widget
285 scrolling commands such as \fBxview\fR and \fByview\fR.
286 It receives the entire list of words that make up a widget command
287 and parses the words starting with \fIargv\fR[2].
288 The words starting with \fIargv\fR[2] must have one of the following forms:
290 \fBmoveto \fIfraction\fR
291 \fBscroll \fInumber\fB units\fR
292 \fBscroll \fInumber\fB pages\fR
295 Any of the \fBmoveto\fR, \fBscroll\fR, \fBunits\fR, and \fBpages\fR
296 keywords may be abbreviated.
297 If \fIargv\fR has the \fBmoveto\fR form, \fBTK_SCROLL_MOVETO\fR
298 is returned as result and \fI*dblPtr\fR is filled in with the
299 \fIfraction\fR argument to the command, which must be a proper real
301 If \fIargv\fR has the \fBscroll\fR form, \fBTK_SCROLL_UNITS\fR
302 or \fBTK_SCROLL_PAGES\fR is returned and \fI*intPtr\fR is filled
303 in with the \fInumber\fR value, which must be a proper integer.
304 If an error occurs in parsing the arguments, \fBTK_SCROLL_ERROR\fR
305 is returned and an error message is left in \fIinterp->result\fR.
307 \fBTk_GetScrollInfoObj\fR is identical in function to
308 \fBTk_GetScrollInfo\fR. However, \fBTk_GetScrollInfoObj\fR accepts
309 Tcl_Obj style arguments, making it more appropriate for use with new
313 parse, scrollbar, scrolling command, xview, yview