Tk\_GetScrollInfo(3) Tk Library Procedures Tk\_GetScrollInfo(3)

```

```

# [NAME](#NAME)

Tk\_GetScrollInfoObj, Tk\_GetScrollInfo - parse arguments for scrolling commands

# [SYNOPSIS](#SYNOPSIS)

```
#include <tk.h>

int
Tk_GetScrollInfoObj(interp, objc, objv, fractionPtr, stepsPtr)

int
Tk_GetScrollInfo(interp, argc, argv, fractionPtr, stepsPtr)
```

# [ARGUMENTS](#ARGUMENTS)

Tcl\_Interp *\*interp* (in)

Interpreter to use for error reporting.

Tcl\_Size *objc* (in)

Number of Tcl\_Obj's in *objv* array.

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 **xview** or **yview**.

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 **xview** or **yview**.

double *\*fractionPtr* (out)

Filled in with fraction from **moveto** option, if any.

int *\*stepsPtr* (out)

Filled in with line or page count from **scroll** option, if any. The value may be negative.

```
    
```

# [DESCRIPTION](#DESCRIPTION)

**Tk\_GetScrollInfoObj** 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 *objv*\[2]. The words starting with *objv*\[2] must have one of the following forms:

```
moveto fraction
scroll number pages
scroll number units
```

Any of the **moveto**, **scroll**, **pages**, and **units** keywords may be abbreviated. If *objv* has the **moveto** form, **TK\_SCROLL\_MOVETO** is returned as result and *\*fractionPtr* is filled in with the *fraction* argument to the command, which must be a proper real value. If *objv* has the **scroll** form, **TK\_SCROLL\_PAGES** or **TK\_SCROLL\_UNITS** is returned and *\*stepsPtr* is filled in with the *number* value, which must be a integer or a float, but if it is a float then it is converted to an integer, rounded away from 0. If an error occurs in parsing the arguments, **TK\_SCROLL\_ERROR** is returned and an error message is left in interpreter *interp*'s result.

**Tk\_GetScrollInfo** is identical in function to **Tk\_GetScrollInfoObj**. However, **Tk\_GetScrollInfo** accepts string arguments, making it more appropriate for use with legacy widgets.

# [KEYWORDS](#KEYWORDS)

parse, scrollbar, scrolling command, xview, yview

8.0 Tk

---

Document: Tk_GetScrollInfoObj(3) from tk 9.1.0-r0 (Chainguard OS)
Source: https://downloads.sourceforge.net/sourceforge/tcl/tk9.1.0-src.tar.gz