ttk::scrollbar(3tk)

💖 ttk::scrollbar — the it-girl of viewport control 💖

okay bestie, so this is the manual page for ttk::scrollbar, part of the Tk Themed Widget crew. It's giving "let me hold your document down while you scroll through it" energy, and honestly? Iconic. Let's get into it.

---

✨ NAME ✨

ttk::scrollbar — control the viewport of a scrollable widget. That's the whole job, and she does it flawlessly 💅

---

🌸 SYNOPSIS 🌸

ttk::scrollbar pathName ?options...?

---

🦋 DESCRIPTION 🦋

So like, ttk::scrollbar widgets are typically linked to an associated window that displays a document of some sort — think a file you're editing, or a drawing. You know the vibe.

A scrollbar shows a thumb in the middle portion of the scrollbar, and that thumb's position and size tell you stuff about the portion of the document that's currently visible in the associated window. The thumb can be dragged by the user to control the visible region. Obsessed with her.

And depending on the theme, two or more arrow buttons may also be present — those are for scrolling the visible region in discrete units. Little steps, you know? 🎀

---

⭐ STANDARD OPTIONS ⭐

• -class
• -cursor
• -style
• -takefocus

See the ttk_widget manual entry for the deets on all the standard options, bestie.

---

👑 WIDGET-SPECIFIC OPTIONS 👑

💜 -command

• Command-Line Name: -command
• Database Name: command
• Database Class: Command

A Tcl script prefix that gets evaluated to change the view in the widget associated with the scrollbar. Whenever the user requests a view change by messing with the scrollbar, additional arguments get appended to the value of this option — and the exact form of those is described down in SCROLLING COMMANDS, so don't skip that part 👀

This option typically consists of a two-element list: the name of a scrollable widget, followed by either xview (for horizontal scrollbars) or yview (for vertical scrollbars). That's the classic combo, no cap.

🌈 -orient

• Command-Line Name: -orient
• Database Name: orient
• Database Class: Orient

One of horizontal or vertical. Specifies the orientation of the scrollbar. That's it, that's the whole thing — she's decisive.

---

🎀 WIDGET COMMAND 🎀

On top of the standard cget, configure, identify element, instate, state and style commands (peep ttk::widget for those), scrollbar widgets also support these extra commands:

• pathName get — Returns the scrollbar settings as a list, and those elements are literally the arguments to the most recent set widget command. Like a little receipt of what you last told her 💖
• pathName set first last — This command is normally invoked by the scrollbar's associated widget from an -xscrollcommand or -yscrollcommand callback. It specifies the visible range to be displayed. first and last are real fractions between 0 and 1.

---

🔥 INTERNAL COMMANDS 🔥

These following widget commands are used internally by the TScrollbar widget class bindings. Not your business normally, but here they are anyway because we keep all the facts 🫶

• pathName delta deltaX deltaY — Returns a real number indicating the fractional change in the scrollbar setting that corresponds to a given change in thumb position. For example, if the scrollbar is horizontal, the result indicates how much the scrollbar setting must change to move the thumb deltaX pixels to the right (and deltaY is ignored in this case). If the scrollbar is vertical, the result indicates how much the scrollbar setting must change to move the thumb deltaY pixels down. The arguments and the result may be zero or negative. Math girl summer.
• pathName fraction x y — Returns a real number between 0 and 1 indicating where the point given by x and y lies in the trough area of the scrollbar, where 0.0 corresponds to the top or left of the trough and 1.0 corresponds to the bottom or right. x and y are pixel coordinates relative to the scrollbar widget. And if x and y refer to a point outside the trough, the closest point in the trough is used — she snaps to the nearest vibe ✨

---

💫 SCROLLING COMMANDS 💫

When the user interacts with the scrollbar — like dragging the thumb — the scrollbar notifies the associated widget that it must change its view. It does this by evaluating a Tcl command generated from the scrollbar's -command option. The command may take any of the following forms. In each case, prefix is the contents of the -command option, which usually has a form like .t yview.

• prefix moveto fraction — fraction is a real number between 0 and 1. The widget should adjust its view so that the point given by fraction appears at the beginning of the widget. If fraction is 0 it refers to the beginning of the document. 1.0 refers to the end of the document, 0.333 refers to a point one-third of the way through the document, and so on. Ratios, bestie, it's all ratios 📐
• prefix scroll number pages — The widget should adjust its view by number pages. It's up to the widget to define the meaning of a page; typically it's slightly less than what fits in the window, so that there's a slight overlap between the old and new views. number is either 1, which means the next page should become visible, or -1, which means the previous page should become visible.
• prefix scroll number units — The widget should adjust its view by number units. The units are defined in whatever way makes sense for the widget — like characters or lines in a text widget. number is either 1, which means one unit should scroll off the top or left of the window, or -1, which means one unit should scroll off the bottom or right of the window.

---

🌟 WIDGET STATES 🌟

The scrollbar automatically sets the disabled state bit when the entire range is visible (range is 0.0 to 1.0), and clears it otherwise. She also sets the active and pressed state flags of individual elements, based on the position and state of the mouse pointer. She's always watching 👀💅

---

🧚 EXAMPLE 🧚

Here's the whole setup, copy-paste ready:

set f [frame .f]
ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set]
grid $f.t -row 0 -column 0 -sticky nsew
grid $f.vsb -row 0 -column 1 -sticky nsew
grid $f.hsb -row 1 -column 0 -sticky nsew
grid columnconfigure $f 0 -weight 1
grid rowconfigure $f 0 -weight 1
pack $f

---

🎨 STYLING OPTIONS 🎨

The class name for a ttk::scrollbar is TScrollbar.

Dynamic states: active, disabled.

TScrollbar (or, more specifically, Vertical.TScrollbar and Horizontal.TScrollbar) styling options that are configurable with ttk::style are:

• -arrowcolor color
• -arrowsize amount
• -background color
• -bordercolor color
• -darkcolor color (color of the dark part of the 3D relief)
• -foreground color
• -gripsize size (number of screen units)
• -lightcolor color (color of the light part of the 3D relief)
• -troughcolor color

Heads up bestie: some of these options are only available for specific themes. Don't come for her if your theme doesn't do the thing 🫶

See the ttk::style manual page for info on how to configure ttk styles.

---

🔗 SEE ALSO 🔗

• ttk::widget(3tk)
• scrollbar(3tk)

---

🔑 KEYWORDS 🔑

scrollbar, widget

---

and that's the whole page, bestie — every last detail, no cap 💖

This one's from Tk 8.5, and it's the ttk::scrollbar(3tk) manual page, so go forth and scroll responsibly ✨🦋🎀