2 '\" Copyright (c) 2008 Pat Thoyts
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 .TH ttk::spinbox n 8.5 Tk "Tk Themed Widget"
8 .\" The -*- nroff -*- definitions below are for supplemental macros used
9 .\" in Tcl/Tk manual entries.
11 .\" .AP type name in/out ?indent?
12 .\" Start paragraph describing an argument to a library procedure.
13 .\" type is type of argument (int, etc.), in/out is either "in", "out",
14 .\" or "in/out" to describe whether procedure reads or modifies arg,
15 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
16 .\" needed; use .AS below instead)
19 .\" Give maximum sizes of arguments for setting tab stops. Type and
20 .\" name are examples of largest possible arguments that will be passed
21 .\" to .AP later. If args are omitted, default tab stops are used.
24 .\" Start box enclosure. From here until next .BE, everything will be
25 .\" enclosed in one large box.
28 .\" End of box enclosure.
31 .\" Begin code excerpt.
36 .\" .VS ?version? ?br?
37 .\" Begin vertical sidebar, for use in marking newly-changed parts
38 .\" of man pages. The first argument is ignored and used for recording
39 .\" the version when the .VS was added, so that the sidebars can be
40 .\" found and removed when they reach a certain age. If another argument
41 .\" is present, then a line break is forced before starting the sidebar.
44 .\" End of vertical sidebar.
47 .\" Begin an indented unfilled display.
50 .\" End of indented unfilled display.
53 .\" Start of list of standard options for a Tk widget. The manpage
54 .\" argument defines where to look up the standard options; if
55 .\" omitted, defaults to "options". The options follow on successive
56 .\" lines, in three columns separated by tabs.
59 .\" End of list of standard options for a Tk widget.
61 .\" .OP cmdName dbName dbClass
62 .\" Start of description of a specific option. cmdName gives the
63 .\" option's name as specified in the class command, dbName gives
64 .\" the option's name in the option database, and dbClass gives
65 .\" the option's class in the option database.
68 .\" Print arg1 underlined, then print arg2 normally.
71 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
74 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
75 .\" (for trailing punctuation) and then a closing parenthesis.
77 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
81 .\" # Start an argument description
85 . ie !"\\$2"" .TP \\n()Cu
90 \&\\$1 \\fI\\$2\\fP (\\$3)
103 .\" # define tabbing values for .AP
106 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
109 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
110 .nr )C \\n()Bu+\\w'(in/out)'u+2n
112 .AS Tcl_Interp Tcl_CreateInterp in/out
113 .\" # BS - start boxed text
114 .\" # ^y = starting y location
122 .if n \l'\\n(.lu\(ul'
125 .\" # BE - end boxed text (draw box now)
130 .ie n \l'\\n(^lu\(ul'
132 .\" Draw four-sided box normally, but don't draw top of
133 .\" box if the box started on an earlier page.
135 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
138 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
145 .\" # VS - start vertical sidebar
146 .\" # ^Y = starting y location
147 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
151 .ie n 'mc \s12\(br\s0
154 .\" # VE - end of vertical sidebar
162 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
169 .\" # Special macro to handle page bottom: finish off current
170 .\" # box/sidebar if in box/sidebar mode, then invoked standard
171 .\" # page bottom macro.
178 .\" Draw three-sided box if this is the box's first page,
179 .\" draw two sides but no top otherwise.
180 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
181 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
184 .nr ^x \\n(^tu+1v-\\n(^Yu
185 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
198 .\" # DS - begin display
204 .\" # DE - end display
210 .\" # SO - start of list of standard options
212 'ie '\\$1'' .ds So \\fBoptions\\fR
213 'el .ds So \\fB\\$1\\fR
214 .SH "STANDARD OPTIONS"
220 .\" # SE - end of list of standard options
225 See the \\*(So manual entry for details on the standard options.
227 .\" # OP - start of full description for a single option
232 Command-Line Name: \\fB\\$1\\fR
233 Database Name: \\fB\\$2\\fR
234 Database Class: \\fB\\$3\\fR
238 .\" # CS - begin code excerpt
244 .\" # CE - end code excerpt
249 .\" # UL - underline word
253 .\" # QW - apply quotation marks to word
255 .ie '\\*(lq'"' ``\\$1''\\$2
256 .\"" fix emacs highlighting
257 .el \\*(lq\\$1\\*(rq\\$2
259 .\" # PQ - apply parens and quotation marks to word
261 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
262 .\"" fix emacs highlighting
263 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
265 .\" # QR - quoted range
267 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
268 .\"" fix emacs highlighting
269 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
271 .\" # MT - "empty" string
277 ttk::spinbox \- Selecting text field widget
279 \fBttk::spinbox\fR \fIpathName \fR?\fIoptions\fR?
283 A \fBttk::spinbox\fR widget is a \fBttk::entry\fR widget with built-in
284 up and down buttons that are used to either modify a numeric value or
285 to select among a set of values. The widget implements all the features
286 of the \fBttk::entry\fR widget including support of the
287 \fB\-textvariable\fR option to link the value displayed by the widget
290 \-class \-cursor \-style
291 \-takefocus \-xscrollcommand
294 \-validate \-validatecommand
296 .SH "WIDGET-SPECIFIC OPTIONS"
298 A floating\-point value specifying the lowest value for the spinbox. This is
299 used in conjunction with \fB\-to\fR and \fB\-increment\fR to set a numerical
302 A floating\-point value specifying the highest permissible value for the
303 widget. See also \fB\-from\fR and \fB\-increment\fR.
305 .OP \-increment increment Increment
306 A floating\-point value specifying the change in value to be applied each
307 time one of the widget spin buttons is pressed. The up button applies a
308 positive increment, the down button applies a negative increment.
309 .OP \-values values Values
310 This must be a Tcl list of values. If this option is set then this will
311 override any range set using the \fB\-from\fR, \fB\-to\fR and
312 \fB\-increment\fR options. The widget will instead use the values
313 specified beginning with the first value.
315 Must be a proper boolean value. If on, the spinbox will wrap around the
316 values of data in the widget.
317 .OP \-format format Format
318 Specifies an alternate format to use when setting the string value
319 when using the \fB\-from\fR and \fB\-to\fR range.
320 This must be a format specifier of the form \fB%<pad>.<pad>f\fR,
321 as it will format a floating-point number.
322 .OP \-command command Command
323 Specifies a Tcl command to be invoked whenever a spinbutton is invoked.
326 See the \fBttk::entry\fR manual for information about indexing characters.
329 See the \fBttk::entry\fR manual for information about using the
330 \fB\-validate\fR and \fB\-validatecommand\fR options.
333 The following subcommands are possible for spinbox widgets in addition to
334 the commands described for the \fBttk::entry\fR widget:
336 \fIpathName \fBcurrent \fIindex\fR
338 \fIpathName \fBget\fR
339 Returns the spinbox's current value.
341 \fIpathName \fBset \fIvalue\fR
342 Set the spinbox string to \fIvalue\fR. If a \fB\-format\fR option has
343 been configured then this format will be applied. If formatting fails
344 or is not set or the \fB\-values\fR option has been used then the value
348 The spinbox widget generates a \fB<<Increment>>\fR virtual event when
349 the user presses <Up>, and a \fB<<Decrement>>\fR virtual event when the
352 ttk::widget(n), ttk::entry(n), spinbox(n)
354 entry, spinbox, widget, text field