tixControl(n)

✨ NAME ✨

Okay so bestie, welcome to the tixControl(n) manual page 💖 — this is the one about tixControl, and it does exactly what it says on the tin: create and manipulate tixControl widgets. Periodt. 🎀 This page lives in the Tix Built-In Commands manual, iykyk.

🌸 SYNOPSIS 🌸

tixControl pathName ?options?

🦋 SUPER-CLASS 🦋

The TixControl class is derived from the TixLabelWidget class, and it inherits all the commands, options, and subwidgets of its super-class. No cap, it gets the whole inheritance package. 👑

🎀 STANDARD OPTIONS 🎀

The Control widget supports all the standard options of a frame widget. For the deets on those standard options, see the options(n) manual entry. Iykyk ✨

💅 WIDGET-SPECIFIC OPTIONS 💅

Okay now the main character energy: these are the options that are specific to this widget. Keep every single one, bestie.

• -allowempty (allowEmpty) — says whether the Control widget should allow the empty string as a valid input. 🫶
• -autorepeat (autorepeat) — says whether the Control widget should have autorepeat behavior. If it's set to "true", the value of the Control widget gets automatically incremented or decremented when the user holds down the mouse button over the arrow buttons. Only the values "true" and "false" are recognized. 💀
• -command (command) — the command to be called when the -value option of the Control widget is changed. The command is called with one argument — the new value of the Control widget. Lowkey important. 🎯
• -decrcmd (decrCmd) — a TCL command to be called when the user presses the down-arrow button subwidget. This command is called with one parameter — the current -value of this Control widget. Its job is to decrement this value by one step, according to its own definition of "decrement", and return the decremented value, which will be stored in the -value of this Control widget. 👇
• -disablecallback (disableCallback) — a boolean value indicating whether callbacks should be disabled. When set to true, the TCL command specified by the -command option is not executed when the -value of the Control widget changes. 🚫
• -disableforeground (disableForeground) — the foreground color to use for the entry subwidget when the Control widget is disabled. So it still looks cute but clearly unavailable. 🙈
• -incrcmd (incrCmd) — a TCL command to be called when the user presses the up-arrow button subwidget. This command is called with one parameter — the current -value of this Control widget. Its job is to increment this value by one step, according to its own definition of "increment", and return the incremented value, which will be stored in the -value of this Control widget. 👆
• -initwait (initwait) — how long the Control widget should wait initially before it starts to automatically increment or decrement its value in autorepeat mode. In milliseconds. ⏳
• -integer (integer) — a Boolean value specifying whether only integer numbers are accepted. 🔢
• -label (label) — the string to display as the label of this Control widget. 🏷️
• -labelside (labelSide) — where the label should be displayed relative to the entry subwidget. Valid options are: top, left, right, bottom, none or acrosstop. Main character label placement, fr fr. ✨
• max — Name: max; Class: Max; Switch: -max; Alias: -ulimit. Specifies the upper limit of the value of the Control widget. When set to the empty string, the Control widget has no upper limit. 🏔️
• min — Name: min; Class: Min; Switch: -min; Alias: -llimit. Specifies the lower limit of the value of the Control widget. When set to the empty string, the Control widget has no lower limit. 🌊
• -repeatrate (repeatRate) — how often the value of the Control widget should be incremented or decremented when it is in autorepeat mode. In milliseconds. 🔁
• -selectmode (selectMode) — how the Control widget should react to <KeyPress> events. When set to "immediate", any user keyboard inputs will immediately change the -value option. When set to "normal", the user keyboard inputs will be copied to the -value option only if the <Return> key is pressed or the keyboard focus is changed. The use of immediate mode is discouraged. For effective use of the Control widget, one should use normal mode together with the update widget command (see below). 🎹
• -state (state) — says whether the Control widget is normal or disabled. Only the values "normal" and "disabled" are recognized. 💅
• -step (step) — specifies by how much the value of the Control widget should be incremented or decremented when the user presses the arrow buttons. 🪜
• -validatecmd (validateCmd) — a TCL command to be called when the -value of the Control widget is about to change. This command is called with one parameter — the new -value entered by the user. Its job is to validate this new value by returning a value it deems valid. ✅
• -value (value) — specifies the value of the Control widget. The whole point, honestly. 💖
• -variable (variable) — specifies the global variable in which the value of the Control widget should be stored. The value of the Control widget will be automatically updated when this variable is changed. 🔄

Warning vibe: the -selectmode immediate mode is discouraged. The manual says to use normal mode together with the update widget command for effective use. 💀

🫶 SUBWIDGETS 🫶

These are the little subwidgets living inside, each with its own name and class:

• decr — Class: Button. The down arrow button. ⬇️
• entry — Class: Entry. The entry that shows the value of this Control widget. 📝
• incr — Class: Button. The up arrow button. ⬆️
• label — Class: Label. The label subwidget. 🏷️

🌈 DESCRIPTION 🌈

The tixControl command creates a new window (given by the pathName argument) and makes it into a Control widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the Control widget such as its cursor and relief. ✨

The Control widget is also known as the SpinBox widget. It is generally used to control a value. The user can adjust the value by pressing the two arrow buttons or by entering the value directly into the entry. The new value will be checked against the user-defined upper and lower limits. That's the whole vibe check, and honestly it slays. 💅

👑 WIDGET COMMANDS 👑

The tixControl command creates a new Tcl command whose name is the same as the path name of the Control widget's window. This command may be used to invoke various operations on the widget. It has the following general form:

pathName option ?arg arg ...?

PathName is the name of the command, which is the same as the Control widget's path name. Option and the args determine the exact behavior of the command. The following commands are possible for Control widgets:

• pathName cget option — returns the current value of the configuration option given by option. Option may have any of the values accepted by the tixControl 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 tixControl command. 🛠️
• pathName decr — decrements the value of the Control widget by the step specified by the -step option. ⬇️
• pathName incr — increments the value of the Control widget by the step specified by the -step option. ⬆️
• pathName invoke — causes the command specified by the -command option to be invoked. 📣
• pathName update — if the user has modified the entry using keyboard inputs, the update command will update the -value of this Control widget. When the Control widget's -selectmode option is set to "normal", one should call the update command on this widget before examining its -value option. This command has no effect if the -selectmode option is set to "immediate". 🔄
• pathName subwidget name ?args? — when no options are given, this command returns the pathname of the subwidget of the specified name. When options are given, the widget command of the specified subwidget will be called with these options. 🧩

🔥 BINDINGS 🔥

When the user presses the up/down arrow buttons (or presses the <Up> and <Down> arrow keys on the keyboard), the value of the tixControl widget is adjusted according to the -validatecmd, -incrcmd, -decrcmd, -step, -max and -min options. That's the bindings buffet, bestie. 🍓

⭐ KEYWORDS ⭐

Tix(n)

---

This page is from Tix 4.0, and the manual page is tixControl(n) — catch you in the group chat, mwah 💖🦋✨