WIDGETPLUS(n)
โจ NAME โจ
okay bestie, this is widgetPlus(n) โ Enhanced Entry, Spinbox, and Combobox Widgets with Undo/Redo and other useful features. It is giving โyour regular Tk text-ish widgets but with the glow-up,โ and we are obsessed. ๐
๐ ๏ธ SYNOPSIS ๐ ๏ธ
package require Tcl 8.5
package require Tk 8.5
package require snit
package require widgetPlus ?1.0?
widgetPlus::entryPlus ?create? pathName
widgetPlus::spinboxPlus ?create? pathName
widgetPlus::ttkEntryPlus ?create? pathName
widgetPlus::ttkSpinboxPlus ?create? pathName
widgetPlus::ttkComboboxPlus ?create? pathName
widgetPlus::EnableBWidget
pathName edit ?arg arg ...?
pathName edit canredo
pathName edit canundo
pathName edit modified ?boolean?
pathName edit redo
pathName edit reset
pathName edit separator
pathName edit undo
๐ธ DESCRIPTION ๐ธ
The widgetPlus package adds new features to the widgets entry, spinbox, ttk::entry, ttk::spinbox, and ttk::combobox.
The new features are Undo and Redo operations, a <<Selection>> event, and for the Tk (unthemed) widgets an -inactiveselectbackground option, and some minor fixes to bindings. The new facilities closely follow those of the text widget.
The revised entry, spinbox, ttk::entry, ttk::spinbox, and ttk::combobox widgets are created by the commands widgetPlus::entryPlus, widgetPlus::spinboxPlus, widgetPlus::ttkEntryPlus, widgetPlus::ttkSpinboxPlus, and widgetPlus::ttkComboboxPlus respectively.
For example, the widgetPlus::entryPlus widget is implemented as a Snit snit::widgetadaptor that wraps a Tk entry widget. Its winfo class is Entry, and it uses a binding tag EntryPlus that replaces the Entry binding tag. The other widgets are implemented in a similar way.
The package uses the namespace ::widgetPlus, which exports (only) the five commands defined below that begin with a lower-case letter (EnableBWidget is not exported). These commands can be imported into the global namespace, and for simplicity, descriptive text in this manual will henceforth omit the namespace qualifier.
namespace import ::widgetPlus::*
๐ WIDGET OPTIONS ๐
In addition to the usual options of the entry, spinbox, ttk::entry, ttk::spinbox, and ttk::combobox widgets, the wrappers entryPlus, spinboxPlus, ttkEntryPlus, ttkSpinboxPlus, and ttkComboboxPlus provide the options below.
-inactiveselectbackgroundโ Command-Line Switch:-inactiveselectbackground; Database Name:inactiveSelectBackground; Database Class:Foreground. Specifies the color to use for the selection when the window does not have the input focus. If empty,{}, then no selection is shown when the window does not have the focus. The-inactiveselectbackgroundoption has no effect on the Ttk (themed) widgetsttkEntryPlus,ttkSpinboxPlus, andttkComboboxPlus.-maxundoโ Command-Line Switch:-maxundo; Database Name:maxUndo; Database Class:MaxUndo. Specifies the maximum number of compound undo actions on the undo stack. A zero or a negative value imply an unlimited undo stack.-undoโ Command-Line Switch:-undo; Database Name:undo; Database Class:Undo. Specifies a boolean that says whether the undo mechanism is active or not.
๐ COMMANDS ๐
widgetPlus::entryPlus ?create? pathNameโ Create anentryPluswidget; or convert an existingentrywidget into anentryPlus.widgetPlus::spinboxPlus ?create? pathNameโ Create aspinboxPluswidget; or convert an existingspinboxwidget into aspinboxPlus.widgetPlus::ttkEntryPlus ?create? pathNameโ Create attkEntryPluswidget; or convert an existingttk::entrywidget into attkEntryPlus.widgetPlus::ttkSpinboxPlus ?create? pathNameโ Create attkSpinboxPluswidget; or convert an existingttk::spinboxwidget into attkSpinboxPlus.widgetPlus::ttkComboboxPlus ?create? pathNameโ Create attkComboboxPluswidget; or convert an existingttk::comboboxwidget into attkComboboxPlus.widgetPlus::EnableBWidgetโ EnablewidgetPlusto modify BWidget Entry widgets and their compounds (such as the BWidget ComboBox). The command creates a bindtagBwEntryPlusto replace the default bindtagBwEntry. This operation is not performed when the package is loaded because it requires BWidget to be loaded first. This command is not exported from namespace::widgetPlus.
๐งธ WIDGET COMMANDS ๐งธ
In addition to the usual commands of the entry, spinbox, ttk::entry, ttk::spinbox, and ttk::combobox widgets, the wrappers entryPlus, ttkEntryPlus, spinboxPlus, ttkSpinboxPlus, and ttkComboboxPlus provide:
pathName edit ?arg arg ...?โ This command controls the undo mechanism and the modified flag. The exact behavior of the command depends on the option argument that follows theeditargument. The following forms of the command are currently supported:pathName edit canredoโ Returns a boolean true if redo is possible, i.e. when the redo stack is not empty. Otherwise returns false.pathName edit canundoโ Returns a boolean true if undo is possible, i.e. when the undo stack is not empty. Otherwise returns false.pathName edit modified ?boolean?โ Ifbooleanis not specified, returns the modified flag of the widget. Theinsert,delete,edit undoandedit redocommands, or (by using this command) the user, can set or clear the modified flag. Ifbooleanis specified, sets the modified flag of the widget toboolean.pathName edit redoโ When the-undooption is true, reapplies the last undone edits provided no other edits were done since then. Generates an error when the redo stack is empty. Does nothing when the-undooption is false.pathName edit resetโ Clears the undo stack and redo stack.pathName edit separatorโ Included for completeness, but has no effect.
N.B. An implicit separator is added to the undo stack for each call to a widget command (e.g.insertordelete) that changes the widget contents. These therefore separate the addition or removal of individual characters by typing, except that cut or paste operations are discrete.
pathName edit undoโ Undoes the last edit action when the-undooption is true. An edit action is defined as a singleinsertordeletecommand that is recorded on the undo stack. Generates an error when the undo stack is empty. Does nothing when the-undooption is false.
๐ฎ BINDINGS ๐ฎ
๐ซ CLASS BINDINGS ๐ซ
The class binding tag for different widgets has these default values:
entryusesEntryspinboxusesSpinboxttk::entryusesTEntryttk::spinboxusesTSpinboxttk::comboboxusesTComboboxentryPlususesEntryPlusspinboxPlususesSpinboxPlusttkEntryPlususesTEntryPlusttkSpinboxPlususesTSpinboxPlusttkComboboxPlususesTComboboxPlus
โจ๏ธ UNDO AND REDO โจ๏ธ
The <<Undo>> and <<Redo>> virtual events are mapped to these keyboard events:
- On X11 systems (Linuxยฎ, BSDยฎ, Solarisยฎ, etc):
<<Undo>>is mapped to<Control-z><<Redo>>is mapped to<Control-Shift-z>
- On Windowsยฎ systems:
<<Undo>>is mapped to<Control-z><<Redo>>is mapped to<Control-y>
- On Aquaยฎ systems (i.e. Appleยฎ macOSยฎ or OS Xยฎ):
<<Undo>>is mapped to<Command-z><<Redo>>is mapped to<Command-Shift-z>
๐ง ENTRYPLUS ๐ง
The EntryPlus bindings are based on those of the Entry bindtag, with these changes:
- New bindings to
<<Undo>>and<<Redo>>. - An adjustment to the
<<Paste>>binding, so that it behaves the same way on X11 as on other windowing systems (i.e. it deletes the existing selection, if any exists). - The removal of the antiquated
<Insert>binding. - New bindings to
<FocusIn>and<FocusOut>, to facilitate the implementation of the-inactiveselectbackgroundoption.
๐ SPINBOXPLUS ๐
The SpinboxPlus bindings are based on those of the Spinbox bindtag, with the same changes as are made when converting Entry to EntryPlus.
โจ TENTRYPLUS โจ
The TEntryPlus bindings are based on those of the TEntry bindtag, with these changes:
- New bindings to
<<Undo>>and<<Redo>>.
๐ TSPINBOXPLUS ๐
The TSpinboxPlus bindings are based on those of the TSpinbox bindtag, with these changes:
- New bindings to
<<Undo>>and<<Redo>>.
๐ฆ TCOMBOBOXPLUS ๐ฆ
The TComboboxPlus bindings are based on those of the TCombobox bindtag, with these changes:
- New bindings to
<<Undo>>and<<Redo>>.
๐ VIRTUAL EVENT <<SELECTION>> ๐
Each widgetPlus widget generates a virtual event <<Selection>> whenever the value of its selection changes. This allows other Tcl code, for example the package persistentSelection, to monitor the selection in these widgets.
๐ USE WITH MEGAWIDGETS ๐
When an entry, spinbox, ttk::entry, ttk::spinbox, or ttk::combobox is a component of a megawidget, it is often possible to apply widgetPlus to that component without modifying the megawidget code.
๐ COMBOBOX (BY BRYAN OAKLEY) ๐
A combobox with path $w includes an entry widget $w.entry, which uses the Entry binding tag. Thus widgetPlus can be applied to the combobox after creation, using the command (see EXAMPLES)
entryPlus $w.entry -undo 1 -maxundo 0
๐ซถ COMBOBOX (BWIDGET) ๐ซถ
A BWidget ComboBox with path $w includes an entry widget $w.e, which uses the BwEntry binding tag in place of the default tag Entry.
Package widgetPlus provides a replacement bindtag BwEntryPlus, but this is not computed when the package is loaded because it requires BWidget to be loaded first. The command ::widgetPlus::EnableBWidget must be called to provide BwEntryPlus, and then the BWidget ComboBox can be modified (see EXAMPLES)
::widgetPlus::EnableBWidget
entryPlus $w.e -undo 1 -maxundo 0
๐ธ TO DO ๐ธ
okay bestie, before you @ me โ here's the honest lil laundry list of stuff that's not done yet. not me exposing the package like this but transparency is iconic ๐
- Undo and Redo do not sync the value of the modified flag โ they always set the value to boolean
true. no thoughts, justtrue. ๐ - Undo and Redo do not sync the position of the insertion cursor โ the cursor is out here living its own life, fr fr.
- The
<<Modified>>event is not generated โ like, at all. it's giving ghost town. - Undo/Redo separators, and the
-autoseparatorsoption, as found in thetextwidget, are not implemented โ instead, an implicit separator gets added for each call to a widget command (likeinsertordelete) that changes the widget contents. also, theedit separatorcommand has no effect. ngl, separator functionality would be less useful for widgets such asentryPlusthan it is for atextwidget, so there's that. - Add an overwrite mode โ toggled by Insert on non-macOSยฎ systems. it's on the vision board ๐
๐ BUGS ๐
okay so, the compatibility tea โ โ this version of widgetPlus is intended to be compatible with all releases of Tk 8.5 and 8.6, and with the branches core-8-5-branch, core-8-6-branch, and trunk in the source code repository for Tk. any incompatibility with any of these versions, for any Tk windowing system, should be reported as a bug. periodt.
๐ซถ Please report such in the categorywidgetPlusof the Tklib Trackers [http://core.tcl.tk/tklib/reportlist].
โจ EXAMPLES โจ
this is the part where it gets good, bestie. copy-paste these and slay. ๐
To create and map an entryPlus widget .ep with an unlimited Undo/Redo stack:
package require widgetPlus
widgetPlus::entryPlus .ep -undo 1 -maxundo 0
pack .ep
the same but using namespace import:
package require widgetPlus
namespace import widgetPlus::*
entryPlus .ep -undo 1 -maxundo 0
pack .ep
To convert an existing entry widget .ee into an entryPlus with an unlimited Undo/Redo stack:
entry .ee
.
.
.
package require widgetPlus
widgetPlus::entryPlus .ee -undo 1 -maxundo 0
the same but using namespace import:
entry .ee
.
.
.
package require widgetPlus
namespace import widgetPlus::*
entryPlus .ee -undo 1 -maxundo 0
Apply widgetPlus to a Bryan Oakley combobox:
package require combobox
combobox::combobox .cb
.
.
.
package require widgetPlus
namespace import widgetPlus::*
entryPlus .cb.entry -undo 1 -maxundo 0
Apply widgetPlus to a BWidget ComboBox. ๐จ heads up โ the command ::widgetPlus::EnableBWidget must be called first:
package require BWidget
ComboBox .cb
.
.
.
package require widgetPlus
::widgetPlus::EnableBWidget
namespace import widgetPlus::*
entryPlus .cb.e -undo 1 -maxundo 0
๐ฆ BUGS, IDEAS, FEEDBACK ๐ฆ
real talk: this document, and the package it describes, will undoubtedly contain bugs and other problems. it's not a vibe, it's just life ๐ญ Please report such in the category widgetPlus of the Tklib Trackers [http://core.tcl.corg/tklib/reportlist] โ okay wait, it's [http://core.tcl.tk/tklib/reportlist], my bad, typos are not the move ๐. Please also report any ideas for enhancements you may have for either package and/or documentation. we love a good idea in this house ๐ซถ
๐ SEE ALSO ๐
your reading list, bestie โ go off:
BWidgetComboBoxEntryentrypersistentSelectionspinboxtextttk::comboboxttk::entryttk::spinbox
and that's the whole page, you made it to the end, I'm so proud ๐ญ๐ this one ships from tklib, version 1.0, and the footer date is the one and only widgetPlus(n)-flavoured timestamp on the page โ so go forth, undo your typos, redo your life, and remember: -maxundo 0 means unlimited, which is literally main character energy. periodt. ๐โจ๐
๐ฆ where this page comes from
- alpine 3.24: tk-lib-doc 0.7-r0 ยท TCL
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms