summaryrefslogtreecommitdiffstats
path: root/doc/GetScroll.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/GetScroll.3')
-rw-r--r--doc/GetScroll.323
1 files changed, 18 insertions, 5 deletions
diff --git a/doc/GetScroll.3 b/doc/GetScroll.3
index a07e0d0..6e7acc8 100644
--- a/doc/GetScroll.3
+++ b/doc/GetScroll.3
@@ -5,19 +5,22 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: GetScroll.3,v 1.2 1998/09/14 18:22:51 stanton Exp $
+'\" RCS: @(#) $Id: GetScroll.3,v 1.3 2000/04/25 17:25:27 ericm Exp $
'\"
.so man.macros
-.TH Tk_GetScrollInfo 3 4.0 Tk "Tk Library Procedures"
+.TH Tk_GetScrollInfo 3 8.0 Tk "Tk Library Procedures"
.BS
.SH NAME
-Tk_GetScrollInfo \- parse arguments for scrolling commands
+Tk_GetScrollInfo, Tk_GetScrollInfoObj \- parse arguments for scrolling commands
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
int
\fBTk_GetScrollInfo(\fIinterp, argc, argv, dblPtr, intPtr\fB)\fR
+.sp
+int
+\fBTk_GetScrollInfoObj(\fIinterp, objc, objv, dblPtr, intPtr\fB)\fR
.SH ARGUMENTS
.AS "Tcl_Interp" *dblPtr
.AP Tcl_Interp *interp in
@@ -27,8 +30,13 @@ Number of strings in \fIargv\fR array.
.AP 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 \fBxview\fR or \fByview\fR. This procedure parses
-arguments starting with \fIargv\fR[2].
+word is typically \fBxview\fR or \fByview\fR.
+.AP int objc in
+Number of Tcl_Obj's in \fIobjv\fR array.
+.AP Tcl_Obj *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 \fBxview\fR or \fByview\fR.
.AP double *dblPtr out
Filled in with fraction from \fBmoveto\fR option, if any.
.AP int *intPtr out
@@ -60,6 +68,11 @@ or \fBTK_SCROLL_PAGES\fR is returned and \fI*intPtr\fR is filled
in with the \fInumber\fR value, which must be a proper integer.
If an error occurs in parsing the arguments, \fBTK_SCROLL_ERROR\fR
is returned and an error message is left in \fIinterp->result\fR.
+.PP
+\fBTk_GetScrollInfoObj\fR is identical in function to
+\fBTk_GetScrollInfo\fR. However, \fBTk_GetScrollInfoObj\fR accepts
+Tcl_Obj style arguments, making it more appropriate for use with new
+development.
.SH KEYWORDS
parse, scrollbar, scrolling command, xview, yview