iwidgets::spinner(1)

🎀 iwidgets::spinner(1) — bestie edition 🎀

okay so you're reading iwidgets::spinner(1), straight outta [incr Widgets], and honestly? this one's a bop. it's the little spinny thing with the up and down arrows that goes brrr through your values. let's get into it 💅

---

✨ NAME ✨

iwidgets::spinner — Create and manipulate a spinner widget. that's it, that's the whole job. iconic behavior honestly.

---

🌸 SYNOPSIS 🌸

iwidgets::spinner pathName ?options?

---

🦋 INHERITANCE 🦋

the family tree goes like this, and yes it's giving royal lineage:

itk::Widget <- iwidgets::Labeledwidget <- iwidgets::Spinner

so it inherits from itk::Widget, which inherits from iwidgets::Labeledwidget, which is the parent of iwidgets::Spinner. it's giving eldest daughter energy fr fr.

---

💖 STANDARD OPTIONS 💖

these come free with the widget, no cap:

• background
• borderWidth
• cursor
• exportSelection
• foreground
• highlightColor
• highlightThickness
• insertBackground
• insertBorderWidth
• insertOffTime
• insertOnTime
• insertWidth
• justify
• relief
• selectBackground
• selectBorderWidth
• selectForeground
• textVariable

See the options manual entry for details on the standard options. iykyk 💜

---

🧚 ASSOCIATED OPTIONS 🧚

• show
• state

See the entry manual entry for details on the associated options. 🫶

---

🌈 INHERITED OPTIONS 🌈

from entryfield, lowkey a whole vibe:

• childSitePos
• command
• fixed
• focusCommand
• invalid
• textBackground
• textFont
• validate
• width

See the entryfield widget manual entry for details on the above inherited options. 💖

and from labeledwidget, the whole other side of the family:

• disabledForeground
• labelBitmap
• labelFont
• labelImage
• labelMargin
• labelPos
• labelText
• labelVariable
• state
• sticky

See the labeledwidget widget manual entry for details on the above inherited options. ✨

---

👑 WIDGET-SPECIFIC OPTIONS 👑

these are hers. main character options only.

arrowOrient — Class: Orient — Switch: -arroworient

Specifies placement of arrow buttons: horizontal or vertical. the default is vertical.

decrement — Class: Command — Switch: -decrement

Tcl command to be executed when the down arrow is pressed. ⬇️

increment — Class: Command — Switch: -increment

Tcl command to be executed when the up arrow is pressed. ⬆️

repeatDelay — Class: RepeatDelay — Switch: -repeatdelay

Specifies the initial delay in milliseconds before the spinner repeat action on the arrow buttons engages. the default is 300 milliseconds. so it waits a lil sec before it starts going feral 🫠

repeatInterval — Class: RepeatInterval — Switch: -repeatinterval

Specifies the repeat delay in milliseconds between selections of the arrow buttons. a repeatinterval of 0 disables button repeat. the default is 100 milliseconds.

---

💫 DESCRIPTION 💫

the iwidgets::spinner command creates a spinner widget. bestie, the spinner is comprised of an entryfield plus up and down arrow buttons. and the arrows may be drawn horizontally or vertically — your call, you're the one with the vision 💅

---

🔥 METHODS 🔥

the iwidgets::spinner 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 args determine the exact behavior of the command. the following commands are possible for spinner widgets:

---

🍓 ASSOCIATED METHODS 🍓

• delete
• get
• icursor
• index
• insert
• scan
• selection
• xview

See the entry manual entry for details on the associated methods. 🧚

---

💜 INHERITED METHODS 💜

• childsite
• clear
• peek

See the entryfield manual entry for details on the associated methods. 🌸

---

⭐ WIDGET-SPECIFIC METHODS ⭐

pathName cget option

Returns the current value of the configuration option given by option. option may have any of the values accepted by the iwidgets::spinner command.

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 iwidgets::spinner command.

pathName down

Derived classes may overload this method to specialize functionality. ⬇️

pathName up

Derived classes may overload this method to specialize functionality. ⬆️

---

🫶 COMPONENTS 🫶

downarrow — Class: Canvas

The downarrow component is the downward pointing button of the spinner. See the canvas widget manual entry for details on the downarrow component item.

uparrow — Class: Canvas

The uparrow component is the upward pointing button of the spinner. See the canvas widget manual entry for details on the uparrow component item.

---

💀 EXAMPLE 💀

here's the whole thing in action, a month spinner, absolutely ate:

package require Iwidgets 4.0
set months {January February March April May June July \
                August September October November December}

proc blockInput {char} {
    return 0
}

proc spinMonth {step} {
    global months

    set index [expr [lsearch $months [.sm get]] + $step]

    if {$index < 0} {set index 11}
    if {$index > 11} {set index 0}

    .sm delete 0 end
    .sm insert 0 [lindex $months $index]
}

iwidgets::spinner .sm -labeltext "Month : " -width 10 -fixed 10 \
  -validate blockInput -decrement {spinMonth -1} -increment {spinMonth 1}
.sm insert 0 January

pack .sm -padx 10 -pady 10

---

🙈 ACKNOWLEDGEMENTS 🙈

Ken Copeland <ken@hilco.com>

• 10/18/95 — Added auto-repeat action to spinner arrow buttons. (the glow-up that made the arrows go brrr on their own, periodt 💅)

---

👑 AUTHOR 👑

Sue Yockey

---

🎀 KEYWORDS 🎀

• spinner
• widget

---

and that's the whole page, bestie!! no notes, we ate 🍽️✨ this one ships as Tk — iwidgets::spinner(1) — so go forth, spin your months, block your input, and slay 💖🌈🦋