ttk::spinbox(n)

📦
version 9.0.3 · 6 versions
, in alpine 3.23, alpine 3.24, fedora 43, fedora 44, nixos 26.05

ttk::spinbox(n) 🦋 — Tk Themed Widget, bestie edition 💅

NAME 🎀

ttk::spinbox — Selecting text field widget. It’s giving “entry but with lil up/down buttons,” and we’re obsessed.

SYNOPSIS ✨

ttk::spinbox pathName ?options?

DESCRIPTION 💖

A ttk::spinbox widget is basically a ttk::entry widget wearing built-in up and down buttons. Those buttons either modify a numeric value or let you select among a set of values. It has all the features of the ttk::entry widget, including support for the -textvariable option, which links the value shown by the widget to a Tcl variable. Main character behavior, no cap.

STANDARD OPTIONS 🌸 — the ttk_widget basics

  • -class
  • -cursor
  • -state
  • -style
  • -takefocus
  • -xscrollcommand
  • -placeholder
  • -placeholderforeground

See the ttk_widget manual entry for details on the standard options.

STANDARD OPTIONS 🫶 — the ttk_entry validation girlies

  • -validate
  • -validatecommand

See the ttk_entry manual entry for details on the standard options.

WIDGET-SPECIFIC OPTIONS 💅

🎀 -command

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

Specifies a Tcl command to be invoked whenever a spinbutton is invoked. Like, every time that lil button gets pressed, this command gets the call. ✨

🎀 -format

  • Command-Line Name: -format
  • Database Name: format
  • Database Class: Format

Specifies an alternate format to use when setting the string value while using the -from and -to range. It must be a format specifier of the form %<pad>.<pad>f, because it will format a floating-point number. Periodt.

🎀 -from

  • Command-Line Name: -from
  • Database Name: from
  • Database Class: From

A floating-point value that specifies the lowest value for the spinbox. It works together with -to and -increment to set a numerical range.

🎀 -increment

  • Command-Line Name: -increment
  • Database Name: increment
  • Database Class: Increment

A floating-point value that specifies the change in value applied each time one of the widget spin buttons is pressed. The up button applies a positive increment; the down button applies a negative increment. Up is up, down is down. Iconic.

🎀 -to

  • Command-Line Name: -to
  • Database Name: to
  • Database Class: To

A floating-point value that specifies the highest permissible value for the widget. See also -from and -increment. And yes, the stray range. stays at the end, bestie — details are details 😭

🎀 -values

  • Command-Line Name: -values
  • Database Name: values
  • Database Class: Values

This must be a Tcl list of values. If this option is set, it overrides any range set using the -from, -to, and -increment options. The widget will instead use the values specified, beginning with the first value.

🎀 -wrap

  • Command-Line Name: -wrap
  • Database Name: wrap
  • Database Class: Wrap

Must be a proper boolean value. If on, the spinbox will wrap around the values of data in the widget. It’s giving circular little vibe check 🔁

INDICES 🔎

See the ttk::entry manual for information about indexing characters.

VALIDATION ✅

See the ttk::entry manual for information about using the -validate and -validatecommand options.

WIDGET COMMAND 🫡

The following subcommands are possible for spinbox widgets in addition to the commands described for the ttk::entry widget:

  • pathName get — Returns the spinbox’s current value.
  • pathName set value — Set the spinbox string to value. If a -format option has been configured, then this format will be applied. If formatting fails, or is not set, or the -values option has been used, then the value is set directly.

VIRTUAL EVENTS 🦋

The spinbox widget generates a <<Increment>> virtual event when the user presses <Up>, and a <<Decrement>> virtual event when the user presses <Down>. Keyboard queen behavior.

STYLING OPTIONS 🌈

The class name for a ttk::spinbox is TSpinbox.

Dynamic states: active, disabled, focus, readonly.

TSpinbox styling options configurable with ttk::style are:

  • -arrowcolor color
  • -arrowsize amount
  • -background color — For backwards compatibility, when using the aqua theme (for macOS), this option behaves as an alias for the -fieldbackground provided that no value is specified for -fieldbackground. Otherwise it is ignored. Bestie, read that twice: only when no -fieldbackground value is set 💀
  • -bordercolor color
  • -darkcolor color
  • -fieldbackground color
  • -foreground color
  • -insertcolor color
  • -insertwidth amount
  • -lightcolor color
  • -padding padding
  • -placeholderforeground color
  • -selectbackground color
  • -selectforeground color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles. Styling era, fr fr.

SEE ALSO 👀

ttk::widget(n), ttk::entry(n), spinbox(n)

KEYWORDS 🔑

entry, spinbox, widget, text field

Source/version tea: Tk 8.5 · page: ttk::spinbox(n) · date: not printed in the footer, so we’re not inventing one, bestie 💅✨

📦 where this page comes from