---
name: "gk_scrollbar"
section: "3gk"
platform: "linux"
package: "groupkit"
version: "3.2-1"
release: "Debian 1.3 (Bo)"
platforms: ["linux"]
url: "https://new.carta.tech/gk_scrollbar"
---

# gk\_scrollbar(3gk)

Create a multi-user scrollbar

## NAME

gk\_scrollbar - Create a multi-user scrollbar

## SYNOPSIS

- **gk\_scrollbar** *pathname* ?*options*?

  ## STANDARD OPTIONS

```
activeForeground	highlightBackground	jump	takeFocus
activeRelief	highlightColor	orient	troughColor
background	highlightThickness	relief	xScrollCommand
borderWidth	insertBackground	repeatDelay	yScrollCommmand
command	insertBorderWidth	repeatInterval	width
cursor	insertOffTime	selectBackground
elementBorderwidth	insertOnTime	selectBorderWidth
foreground	insertWidth	selectForeground
```

**See the \`\`options'', \`\`canvas'', and \`\`scrollbar'' manual entries for**  **details on the standard options.**  **The default method for applying the standard options, is too apply them** **to either the local or remote scrollbars.  If both of these cause an** **error then an error occurs.**

## WIDGET-SPECIFIC OPTIONS

```
Name:	barWidth
Class:	BarWidth
Command-Line Switch:	-barwidth
```

-

  Specifies the width of the display (non-manipulatable) area of the group scrollbar.

```
Name:	color
Class:	Color
Command-Line Switch:	-color
```

-

  Specifies the color of the local users scrollbar on the remote portion of the group scrollbar.  Any valid Tk color may be used.  The default value is chosen by gk\_getMyColour.

```
Name:	multiUser
Class:	MultiUser
Command-Line Switch:	-multiuser
```

-

  Specifies whether or not the multi-user (remote) scrollbar is shown.   If true then there is a  multi-user scrollbar; if false then there is not. Any Tk boolean value is valid and the default value is true.

```
Name:	scrollid
Class:	ScrollId
Command-Line Switch:	-scrollid
```

-

  Specifies the scrollid for the scrollbar; scrollbars attached to different parts of the application should have a different scrollid.  The default is \`\`gkGroupScroll''.  It is possible to have both vertical scrollbar  and a horizontal scrollbar within an application without side effects, although they will be sharing information.

## DESCRIPTION

This widget combines a conventional Tk scrollbar with a display area, which shows the scrollbar positions of any number of users.  When users manipulate their own scrollbars, their position in the document is displayed in this area on all users' screens.

## WIDGET COMMAND

The **gk\_scrollbar** command creates a new Tcl command whose name is *pathName*.  This command may be used to invoke various operations on the widget.  It has the following general form:

-

  *pathName option* ?*arg arg ...*?

*Option* and the *arg*s determine the exact behavior of the command.  Since the group scroll bar inherits subcommands from both the Tk canvas widget and the Tk scrollbar, all of these subcommands can be used with this widget.  See the appropriate manual entries for more information.  In addition to these subcommands the  following commands  are possible for gk\_scrollbar widgets:

- *pathName* **configure** ?*option*? ?*value option value ...*?

  Query or modify the configuration options of the widget. If no *option* is specified, returns a list describing all of the available options for *pathName* (see **Tk\_ConfigureInfo** for information on the format of this list).  If *option* is specified with no *value*, then the command returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no *option* is specified).  If one or more *option-value* pairs are specified, then the command modifies the given widget option(s) to have the given value(s);  in this case the command returns an empty string. *Option* may have any of the values accepted by the **gk\_scrollbar** command.

- *pathName* **component local**

  Return the path name of the local user's Tk scrollbar about the program.

- *pathName* **component remote**

  Return the path name of the canvas widget used to represent the  non-manipulatable display area.

- *pathName* **set** *first last*

  Set the scrollbar to display the indicated view area.  *first* and *last* are floating point values between 0.0 and 1.0.

## DEFAULT BINDINGS

Mouse button 1 in the display area will display the name of the user associated with a particular bar.  The Tk scrollbar retains its normal bindings.

## NOTE

This widget is built using the GroupKit class builder; see the GroupKit User Manual for more information.

## \`\`SEE ALSO''

classBuilder(n)

## AUTHOR

Shannon Jaeger (jaeger@cpsc.ucalgary.ca)