_________________________________________________________________
spinbox - Create and manipulate spinbox widgets
spinbox pathName ?options?
See the options manual entry for details on the standard options.
Command-Line Name:-buttonbackground
Database Name: buttonBackground
Database Class: Background
The background color to be used for the spin buttons.
Command-Line Name:-buttoncursor
Database Name: buttonCursor
Database Class: Cursor
The cursor to be used when over the spin buttons. If this is empty (the default), a default cursor will be used.
Command-Line Name:-buttondownrelief
Database Name: buttonDownRelief
Database Class: Relief
The relief to be used for the upper spin button.
Command-Line Name:-buttonuprelief
Database Name: buttonUpRelief
Database Class: Relief
The relief to be used for the lower spin button.
Command-Line Name:-command
Database Name: command
Database Class: Command
Specifies a Tcl command to invoke whenever a spinbutton is invoked. The command recognizes several percent substitutions: %W for the widget path, %s for the current value of the widget, and %d for the direction of the button pressed (up or down).
Command-Line Name:-format
Database Name: format
Database Class: Format
Specifies an alternate format to use when setting the string value when using the -from and -to range. This must be a format specifier of the form %<pad>.<pad>f, as it will format a floating-point number.
Command-Line Name:-from
Database Name: from
Database Class: From
A floating-point value corresponding to the lowest value for a spinbox, to be used in conjunction with -to and -increment. When all are specified correctly, the spinbox will use these values to control its contents. This value must be less than the -to option. If -values is specified, it supercedes this option.
Command-Line Name:-invalidcommand or -invcmd
Database Name: invalidCommand
Database Class: InvalidCommand
Specifies a script to eval when validateCommand returns 0. Setting it to an empty string disables this feature (the default). The best use of this option is to set it to bell. See Validation below for more information.
Command-Line Name:-increment
Database Name: increment
Database Class: Increment
A floating-point value specifying the increment. When used with -from and -to, the value in the widget will be adjusted by -increment when a spin button is pressed (up adds the value, down subtracts the value).
Command-Line Name:-state
Database Name: state
Database Class: State
Specifies one of states for the spinbox: normal, uneditable or disabled. If the spinbox is disabled then the value may not be changed using widget commands and no insertion cursor will be displayed, even if the input focus is in the widget, and the spinbox will be displayed with a disabled foreground. If the spinbox is uneditable, then you can only interact with it by pressing the spin buttons.
Command-Line Name:-to
Database Name: to
Database Class: To
A floating-point value corresponding to the highest value for the spinbox, to be used in conjunction with -from and -increment. When all are specified correctly, the spinbox will use these values to control its contents. This value must be greater than the -from option. If -values is specified, it supercedes this option.
Command-Line Name:-validate
Database Name: validate
Database Class: Validate
Specifies the mode in which validation should operate: none, focus, focusin, focusout, key, or all. It defaults to none. When you want validation, you must explicitly state which mode you wish to use. See Validation below for more.
Command-Line Name:-validatecommand or -vcmd
Database Name: validateCommand
Database Class: ValidateCommand
Specifies a script to evaluate when you want to validate the input in the widget. Setting it to an empty string disables this feature (the default). Validation occurs according to the value of -validate. This command must return a valid Tcl boolean value. If it returns 0 (or the valid Tcl boolean equivalent) then the value of the widget will not change and the invalidCommand will be evaluated if it is set. If it returns 1, then value will be changed. See Validation below for more information.
Command-Line Name:-values
Database Name: values
Database Class: Values
Must be a proper list value. If specified, the spinbox will use these values as to control its contents, starting with the first value. This option has precedence over the -from and -to range.
Command-Line Name:-width
Database Name: width
Database Class: Width
Specifies an integer value indicating the desired width of the spinbox window, in average-size characters of the widget's font. If the value is less than or equal to zero, the widget picks a size just large enough to hold its current text.
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. _________________________________________________________________
The spinbox command creates a new window (given by the pathName argument) and makes it into a spinbox widget. Additional options, described above, may be specified on the command line or in the option database to configure aspects of the spinbox such as its colors, font, and relief. The spinbox command returns its pathName argument. At the time this command is invoked, there must not exist a window named pathName, but pathName's parent must exist.
A spinbox is a widget that displays a one-line text string and allows that string to be edited using widget commands described below, which are typically bound to keystrokes and mouse actions. Also created are two spin buttons that can modify the data in the text string. This is handled automatically when using the right combination of options. When first created, a spinbox's string is empty. A portion of the spinbox may be selected as described below. If a spinbox is exporting its selection (see the exportSelection option), then it will observe the standard protocols for handling the selection; spinbox selections are available as type STRING. Spinboxes also observe the standard Tk rules for dealing with the input focus. When a spinbox has the input focus it displays an insertion cursor to indicate where new characters will be inserted.
Spinboxes are capable of displaying strings that are too long to fit entirely within the widget's window. In this case, only a portion of the string will be displayed; commands described below may be used to change the view in the window. Spinboxes use the standard xScrollCommand mechanism for interacting with scrollbars (see the description of the xScrollCommand option for details). They also support scanning, as described below.
Validation works by setting the validateCommand option to a script which will be evaluated according to the validate option as follows:
focusin validateCommand will be called when the spinbox receives focus.
focusout validateCommand will be called when the spinbox loses focus.
It is posible to perform percent substitutions on the validateCommand and invalidCommand, just as you would in a bind script. The following substitutions are recognized:
%i Index of char string to be inserted/deleted, if any, otherwise -1.
%P The value of the spinbox should edition occur. If you are configuring the spinbox widget to have a new textvariable, this will be the value of that textvariable.
%S The text string being inserted/deleted, if any. Otherwise it is an empty string.
%V The type of validation that triggered the callback (key, focusin, focusout, forced).
In general, the textVariable and validateCommand can be dangerous to mix. Any problems have been overcome so that using the validateCommand will not interfere with the traditional behavior of the spinbox widget. Using the textVariable for read-only purposes will never cause problems. The danger comes when you try set the textVariable to something that the validateCommand would not accept, which causes validate to become none (the invalidCommand will not be triggered). The same happens when an error occurs evaluating the validateCommand.
Primarily, an error will occur when the validateCommand or
invalidCommand encounters an error in its script while
evaluating or validateCommand does not return a valid Tcl
boolean value. The validate option will also set itself
to none when you edit the spinbox widget from within
either the validateCommand or the invalidCommand. Such
editions will override the one that was being validated.
If you wish to edit the value of the widget during validation
and still have the validate option set, you should
include the command
%W config -validate %v
in the validateCommand or invalidCommand (whichever one
you were editing the spinbox widget from). It is also
recommended to not set an associated textVariable during
validation, as that can cause the spinbox widget to become
out of sync with the textVariable.
The spinbox 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.
Many of the widget commands for spinboxes take one or more indices as arguments. An index specifies a particular character in the spinbox's string, in any of the following ways:
immediately following the insertion cursor.
sel.first Indicates the first character in the selection. It is an error to use this form if the selection isn't in the spinbox window.
Abbreviations may be used for any of the forms above, e.g. ``e'' or ``sel.f''. In general, out-of-range indices are automatically rounded to the nearest legal value.
The following commands are possible for spinbox widgets:
pathName bbox index
Returns a list of four numbers describing the
bounding box of the character given by index. The
first two elements of the list give the x and y
coordinates of the upper-left corner of the screen
area covered by the character (in pixels relative
to the widget) and the last two elements give the
width and height of the character, in pixels. The
bounding box may refer to a region outside the visible
area of the window.
pathName cget option
Returns the current value of the configuration
option given by option. Option may have any of the
values accepted by the spinbox 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 path_Name (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 spinbox command.
pathName delete first ?last?
Delete one or more elements of the spinbox. First
is the index of the first character to delete, and
last is the index of the character just after the
last one to delete. If last isn't specified it
defaults to first+1, i.e. a single character is
deleted. This command returns an empty string.
pathName get
Returns the spinbox's string.
pathName icursor index
Arrange for the insertion cursor to be displayed
just before the character given by index. Returns
an empty string.
pathName identify x y
Returns the name of the window element corresponding
to coordinates x and y in the spinbox. Return
value is one of: none, spindown, spinup, entry.
pathName index index
Returns the numerical index corresponding to index.
pathName insert index string
Insert the characters of string just before the
character indicated by index. Returns an empty
string.
pathName invoke element
Causes the specified element, either spindown or
spinup, to be invoked, triggering the action associated
with it.
pathName scan option args
This command is used to implement scanning on spinboxes.
It has two forms, depending on option:
pathName scan mark x
Records x and the current view in the spinbox
window; used in conjunction with later
scan dragto commands. Typically this command
is associated with a mouse button press
in the widget. It returns an empty string.
pathName scan dragto x
This command computes the difference between
its x argument and the x argument to the
last scan mark command for the widget. It
then adjusts the view left or right by 10
times the difference in x-coordinates. This
command is typically associated with mouse
motion events in the widget, to produce the
effect of dragging the spinbox at high speed
through the window. The return value is an
empty string.
pathName selection option arg
This command is used to adjust the selection within
a spinbox. It has several forms, depending on
option:
pathName selection adjust index
Locate the end of the selection nearest to
the character given by index, and adjust
that end of the selection to be at index
(i.e including but not going beyond index).
The other end of the selection is made the
anchor point for future select to commands.
If the selection isn't currently in the
spinbox, then a new selection is created to
include the characters between index and the
most recent selection anchor point, inclusive.
Returns an empty string.
pathName selection clear
Clear the selection if it is currently in
this widget. If the selection isn't in this
widget then the command has no effect.
Returns an empty string.
pathName selection element ?element? Sets or gets the currently selected element. If a spinbutton element is specified, it will be displayed depressed.
pathName selection from index
Set the selection anchor point to just
before the character given by index.
Doesn't change the selection. Returns an
empty string.
pathName selection present
Returns 1 if there is are characters
selected in the spinbox, 0 if nothing is
selected.
pathName selection range start end Sets the selection to include the characters starting with the one indexed by start and ending with the one just before end. If end refers to the same character as start or an earlier one, then the spinbox's selection is cleared.
pathName selection to index
If index is before the anchor point, set the
selection to the characters from index up to
but not including the anchor point. If
index is the same as the anchor point, do
nothing. If index is after the anchor
point, set the selection to the characters
from the anchor point up to but not including
index. The anchor point is determined
by the most recent select from or select
adjust command in this widget. If the
selection isn't in this widget then a new
selection is created using the most recent
anchor point specified for the widget.
Returns an empty string.
pathName set ?string?
If string is specified, the spinbox will try and
set it to this value, otherwise it just returns the
spinbox's string. If validation is on, it will
occur when setting the string.
pathName validate
This command is used to force an evaluation of the
validateCommand independent of the conditions specified
by the validate option. This is done by temporarily
setting the validate option to all. It
returns 0 or 1.
pathName xview args
This command is used to query and change the horizontal
position of the text in the widget's window.
It can take any of the following forms:
pathName xview
Returns a list containing two elements.
Each element is a real fraction between 0
and 1; together they describe the horizontal
span that is visible in the window. For
example, if the first element is .2 and the
second element is .6, 20% of the spinbox's
text is off-screen to the left, the middle
40% is visible in the window, and 40% of the
text is off-screen to the right. These are
the same values passed to scrollbars via the
-xscrollcommand option.
pathName xview index
Adjusts the view in the window so that the
character given by index is displayed at the
left edge of the window.
pathName xview moveto fraction
Adjusts the view in the window so that the
character fraction of the way through the
text appears at the left edge of the window.
Fraction must be a fraction between 0 and 1.
pathName xview scroll number what This command shifts the view in the window left or right according to number and what. Number must be an integer. What must be either units or pages or an abbreviation of one of these. If what is units, the view adjusts left or right by number averagewidth characters on the display; if it is pages then the view adjusts by number screenfuls. If number is negative then characters farther to the left become visible; if it is positive then characters farther to the right become visible.
Tk automatically creates class bindings for spinboxes that give them the following default behavior. In the descriptions below, ``word'' refers to a contiguous group of letters, digits, or ``_'' characters, or any single character other than these.
[11] The End key, or Control-e, will move the insertion cursor to the end of the spinbox and clear any selection in the spinbox. Shift-End moves the cursor to the end and extends the selection to that point.
[12] The Select key and Control-Space set the selection anchor to the position of the insertion cursor. They don't affect the current selection. ShiftSelect and Control-Shift-Space adjust the selection to the current position of the insertion cursor, selecting from the anchor to the insertion cursor if there was not any selection previously.
[15] The F16 key (labelled Copy on many Sun workstations) or Meta-w copies the selection in the widget to the clipboard, if there is a selection.
[17] The F18 key (labelled Paste on many Sun workstations) or Control-y inserts the contents of the clipboard at the position of the insertion cursor.
[18] The Delete key deletes the selection, if there is one in the spinbox. If there is no selection, it deletes the character to the right of the insertion cursor.
[19] The BackSpace key and Control-h delete the selection, if there is one in the spinbox. If there is no selection, it deletes the character to the left of the insertion cursor.
[21] Meta-d deletes the word to the right of the insertion cursor.
[22] Control-k deletes all the characters to the right of the insertion cursor.
[23] Control-t reverses the order of the two characters to the right of the insertion cursor.
If the spinbox is disabled using the -state option, then the spinbox's view can still be adjusted and text in the spinbox can still be selected, but no insertion cursor will be displayed and no text modifications will take place.
The behavior of spinboxes can be changed by defining new bindings for individual widgets or by redefining the class bindings.
spinbox, entry, widget