'\"
|
'\"
|
'\" Copyright (c) 1995 DSC Technologies Corporation
|
'\" Copyright (c) 1995 DSC Technologies Corporation
|
'\"
|
'\"
|
'\" See the file "license.terms" for information on usage and redistribution
|
'\" See the file "license.terms" for information on usage and redistribution
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
'\"
|
'\"
|
'\" @(#) spintime.n
|
'\" @(#) spintime.n
|
'\"
|
'\"
|
.so man.macros
|
.so man.macros
|
.HS spintime iwid
|
.HS spintime iwid
|
.BS
|
.BS
|
'\" Note: do not modify the .SH NAME line immediately below!
|
'\" Note: do not modify the .SH NAME line immediately below!
|
.SH NAME
|
.SH NAME
|
spintime \- Create and manipulate time spinner widgets
|
spintime \- Create and manipulate time spinner widgets
|
.SH SYNOPSIS
|
.SH SYNOPSIS
|
\fBspintime\fI \fIpathName \fR?\fIoptions\fR?
|
\fBspintime\fI \fIpathName \fR?\fIoptions\fR?
|
.SH "INHERITANCE"
|
.SH "INHERITANCE"
|
itk::Widget <- Spintime
|
itk::Widget <- Spintime
|
|
|
.SH "STANDARD OPTIONS"
|
.SH "STANDARD OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBbackground\fR \fBcursor\fR \fBforeground\fR \fBrelief\fR
|
\fBbackground\fR \fBcursor\fR \fBforeground\fR \fBrelief\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "options" manual entry for details on the standard options.
|
See the "options" manual entry for details on the standard options.
|
.SH "ASSOCIATED OPTIONS"
|
.SH "ASSOCIATED OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBtextBackground\fR \fBtextFont\fR
|
\fBtextBackground\fR \fBtextFont\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "entryfield" manual entry for details on the above associated options.
|
See the "entryfield" manual entry for details on the above associated options.
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBlabelFont\fR \fBlabelMargin\fR
|
\fBlabelFont\fR \fBlabelMargin\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "labeledwidget" manual entry for details on the above associated
|
See the "labeledwidget" manual entry for details on the above associated
|
options.
|
options.
|
.LP
|
.LP
|
.nf
|
.nf
|
.ta 4c 8c 12c
|
.ta 4c 8c 12c
|
\fBarrowOrient\fR \fBrepeatDelay\fR \fBrepeatInterval\fR
|
\fBarrowOrient\fR \fBrepeatDelay\fR \fBrepeatInterval\fR
|
.fi
|
.fi
|
.LP
|
.LP
|
See the "spinner" manual entry for details on the above associated options.
|
See the "spinner" manual entry for details on the above associated options.
|
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBlabelPos\fR
|
Name: \fBlabelPos\fR
|
Class: \fBPosition\fR
|
Class: \fBPosition\fR
|
Command-Line Switch: \fB-labelpos\fR
|
Command-Line Switch: \fB-labelpos\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the position of the label along the sides of the various
|
Specifies the position of the label along the sides of the various
|
spinners: \fBn\fR, \fBe\fR, \fBs\fR, or \fBw\fR. The default is w.
|
spinners: \fBn\fR, \fBe\fR, \fBs\fR, or \fBw\fR. The default is w.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBhourLabel\fR
|
Name: \fBhourLabel\fR
|
Class: \fBText\fR
|
Class: \fBText\fR
|
Command-Line Switch: \fB-hourlabel\fR
|
Command-Line Switch: \fB-hourlabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text of the label for the hour spinner. The default is "Hour".
|
Specifies the text of the label for the hour spinner. The default is "Hour".
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBhourOn\fR
|
Name: \fBhourOn\fR
|
Class: \fBhourOn\fR
|
Class: \fBhourOn\fR
|
Command-Line Switch: \fB-houron\fR
|
Command-Line Switch: \fB-houron\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies whether or not to display the hour spinner in any of the forms
|
Specifies whether or not to display the hour spinner in any of the forms
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBhourWidth\fR
|
Name: \fBhourWidth\fR
|
Class: \fBWidth\fR
|
Class: \fBWidth\fR
|
Command-Line Switch: \fB-hourwidth\fR
|
Command-Line Switch: \fB-hourwidth\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the width of the hour spinner in any of the forms acceptable to
|
Specifies the width of the hour spinner in any of the forms acceptable to
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBmilitaryOn\fR
|
Name: \fBmilitaryOn\fR
|
Class: \fBmilitaryOn\fR
|
Class: \fBmilitaryOn\fR
|
Command-Line Switch: \fB-militaryon\fR
|
Command-Line Switch: \fB-militaryon\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies use of a 24 hour clock for hour display in any of the forms
|
Specifies use of a 24 hour clock for hour display in any of the forms
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBminuteLabel\fR
|
Name: \fBminuteLabel\fR
|
Class: \fBText\fR
|
Class: \fBText\fR
|
Command-Line Switch: \fB-minutelabel\fR
|
Command-Line Switch: \fB-minutelabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text of the label for the minute spinner. The default is
|
Specifies the text of the label for the minute spinner. The default is
|
"Minute".
|
"Minute".
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBminuteOn\fR
|
Name: \fBminuteOn\fR
|
Class: \fBminuteOn\fR
|
Class: \fBminuteOn\fR
|
Command-Line Switch: \fB-minuteon\fR
|
Command-Line Switch: \fB-minuteon\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies whether or not to display the minute spinner in any of the forms
|
Specifies whether or not to display the minute spinner in any of the forms
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBminuteWidth\fR
|
Name: \fBminuteWidth\fR
|
Class: \fBWidth\fR
|
Class: \fBWidth\fR
|
Command-Line Switch: \fB-minutewidth\fR
|
Command-Line Switch: \fB-minutewidth\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the width of the minute spinner in any of the forms acceptable to
|
Specifies the width of the minute spinner in any of the forms acceptable to
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBorient\fR
|
Name: \fBorient\fR
|
Class: \fBOrient\fR
|
Class: \fBOrient\fR
|
Command-Line Switch: \fB-orient\fR
|
Command-Line Switch: \fB-orient\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the orientation of the hour, minute, and second spinners: \fBvertical\fR or \fBhorizontal\fR. The default is horizontal.
|
Specifies the orientation of the hour, minute, and second spinners: \fBvertical\fR or \fBhorizontal\fR. The default is horizontal.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBsecondLabel\fR
|
Name: \fBsecondLabel\fR
|
Class: \fBText\fR
|
Class: \fBText\fR
|
Command-Line Switch: \fB-secondlabel\fR
|
Command-Line Switch: \fB-secondlabel\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the text of the label for the second spinner. The default is
|
Specifies the text of the label for the second spinner. The default is
|
"Second"
|
"Second"
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBsecondOn\fR
|
Name: \fBsecondOn\fR
|
Class: \fBsecondOn\fR
|
Class: \fBsecondOn\fR
|
Command-Line Switch: \fB-secondon\fR
|
Command-Line Switch: \fB-secondon\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies whether or not to display the second spinner in any of the forms
|
Specifies whether or not to display the second spinner in any of the forms
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
acceptable to \fBTcl_GetBoolean\fR. The default is true.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBsecondWidth\fR
|
Name: \fBsecondWidth\fR
|
Class: \fBWidth\fR
|
Class: \fBWidth\fR
|
Command-Line Switch: \fB-secondwidth\fR
|
Command-Line Switch: \fB-secondwidth\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the width of the second spinner in any of the forms acceptable to
|
Specifies the width of the second spinner in any of the forms acceptable to
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
\fBTcl_GetPixels\fR. The default is 3 pixels.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBtimeMargin\fR
|
Name: \fBtimeMargin\fR
|
Class: \fBMargin\fR
|
Class: \fBMargin\fR
|
Command-Line Switch: \fB-timemargin\fR
|
Command-Line Switch: \fB-timemargin\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
Specifies the margin space between the hour, minute, and second spinners is
|
Specifies the margin space between the hour, minute, and second spinners is
|
any of the forms accpetable to \fBTcl_GetPixels\fR. The default is 1 pixel.
|
any of the forms accpetable to \fBTcl_GetPixels\fR. The default is 1 pixel.
|
.LP
|
.LP
|
.nf
|
.nf
|
.BE
|
.BE
|
|
|
.SH DESCRIPTION
|
.SH DESCRIPTION
|
.PP
|
.PP
|
|
|
The \fBspintime\fR command creates a set of spinners for use in time value
|
The \fBspintime\fR command creates a set of spinners for use in time value
|
entry. The set includes an hour, minute, and second spinner widget.
|
entry. The set includes an hour, minute, and second spinner widget.
|
|
|
.SH "METHODS"
|
.SH "METHODS"
|
.PP
|
.PP
|
The \fBspintime\fR command creates a new Tcl command whose
|
The \fBspintime\fR command creates a new Tcl command whose
|
name is \fIpathName\fR. This
|
name is \fIpathName\fR. This
|
command may be used to invoke various
|
command may be used to invoke various
|
operations on the widget. It has the following general form:
|
operations on the widget. It has the following general form:
|
.DS C
|
.DS C
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
.DE
|
.DE
|
\fIOption\fR and the \fIarg\fRs
|
\fIOption\fR and the \fIarg\fRs
|
determine the exact behavior of the command. The following
|
determine the exact behavior of the command. The following
|
commands are possible for spintime widgets:
|
commands are possible for spintime widgets:
|
|
|
.SH "WIDGET-SPECIFIC METHODS"
|
.SH "WIDGET-SPECIFIC METHODS"
|
.TP
|
.TP
|
\fIpathName \fBcget\fR \fIoption\fR
|
\fIpathName \fBcget\fR \fIoption\fR
|
Returns the current value of the configuration option given
|
Returns the current value of the configuration option given
|
by \fIoption\fR.
|
by \fIoption\fR.
|
\fIOption\fR may have any of the values accepted by the \fBspintime\fR
|
\fIOption\fR may have any of the values accepted by the \fBspintime\fR
|
command.
|
command.
|
.TP
|
.TP
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
Query or modify the configuration options of the widget.
|
Query or modify the configuration options of the widget.
|
If no \fIoption\fR is specified, returns a list describing all of
|
If no \fIoption\fR is specified, returns a list describing all of
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
information on the format of this list). If \fIoption\fR is specified
|
information on the format of this list). If \fIoption\fR is specified
|
with no \fIvalue\fR, then the command returns a list describing the
|
with no \fIvalue\fR, then the command returns a list describing the
|
one named option (this list will be identical to the corresponding
|
one named option (this list will be identical to the corresponding
|
sublist of the value returned if no \fIoption\fR is specified). If
|
sublist of the value returned if no \fIoption\fR is specified). If
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
modifies the given widget option(s) to have the given value(s); in
|
modifies the given widget option(s) to have the given value(s); in
|
this case the command returns an empty string.
|
this case the command returns an empty string.
|
\fIOption\fR may have any of the values accepted by the \fBspintime\fR
|
\fIOption\fR may have any of the values accepted by the \fBspintime\fR
|
command.
|
command.
|
.TP
|
.TP
|
\fIpathName \fBget\fR ?\fBformat\fR?
|
\fIpathName \fBget\fR ?\fBformat\fR?
|
Returns the current contents of the spintime widget in a format of
|
Returns the current contents of the spintime widget in a format of
|
string or as an integer clock value using the \fB-string\fR and \fB-clicks\fR
|
string or as an integer clock value using the \fB-string\fR and \fB-clicks\fR
|
format options respectively. The default is by string. Reference the
|
format options respectively. The default is by string. Reference the
|
clock command for more information on obtaining time and its
|
clock command for more information on obtaining time and its
|
formats.
|
formats.
|
.TP
|
.TP
|
\fIpathName \fBshow\fR \fItime\fR
|
\fIpathName \fBshow\fR \fItime\fR
|
Changes the currently displayed time to be that of the time
|
Changes the currently displayed time to be that of the time
|
argument. The time may be specified either as a string, an
|
argument. The time may be specified either as a string, an
|
integer clock value or the keyword "now". Reference the clock
|
integer clock value or the keyword "now". Reference the clock
|
command for more information on obtaining times and its format.
|
command for more information on obtaining times and its format.
|
|
|
.ta 4c
|
.ta 4c
|
.SH "COMPONENTS"
|
.SH "COMPONENTS"
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBhour\fR
|
Name: \fBhour\fR
|
Class: \fBSpinint\fR
|
Class: \fBSpinint\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The hour component is the hour spinner of the time spinner. See the
|
The hour component is the hour spinner of the time spinner. See the
|
SpinInt widget manual entry for details on the hour component item.
|
SpinInt widget manual entry for details on the hour component item.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBminute\fR
|
Name: \fBminute\fR
|
Class: \fBSpinint\fR
|
Class: \fBSpinint\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The minute component is the minute spinner of the time spinner. See
|
The minute component is the minute spinner of the time spinner. See
|
the SpinInt widget manual entry for details on the minute component item.
|
the SpinInt widget manual entry for details on the minute component item.
|
.LP
|
.LP
|
.nf
|
.nf
|
Name: \fBsecond\fR
|
Name: \fBsecond\fR
|
Class: \fBSpinint\fR
|
Class: \fBSpinint\fR
|
.fi
|
.fi
|
.IP
|
.IP
|
The second component is the second spinner of the time spinner. See the
|
The second component is the second spinner of the time spinner. See the
|
SpinInt widget manual entry for details on the second component item.
|
SpinInt widget manual entry for details on the second component item.
|
.fi
|
.fi
|
|
|
.SH EXAMPLE
|
.SH EXAMPLE
|
.DS
|
.DS
|
spintime .st
|
spintime .st
|
pack .st -padx 10 -pady 10
|
pack .st -padx 10 -pady 10
|
.DE
|
.DE
|
.SH AUTHOR
|
.SH AUTHOR
|
Sue Yockey
|
Sue Yockey
|
.DE
|
.DE
|
Mark L. Ulferts
|
Mark L. Ulferts
|
.SH KEYWORDS
|
.SH KEYWORDS
|
spintime, spinint, spinner, entryfield, entry, widget
|
spintime, spinint, spinner, entryfield, entry, widget
|
|
|
|
|
