iwidgets2.2.0 User Commands - spintime
NAME
spintime - Create and manipulate time spinner widgets
SYNOPSIS
spintime pathName ?options?
INHERITANCE
itk::Widget <- Spintime
STANDARD OPTIONS
background cursor foreground highlightColor
highlightThickness relief selectBackgroundselectBorderWidth
selectForeground
See the "options" manual entry for details on the standard
options.
ASSOCIATED OPTIONS
textBackground textFont
See the "entryfield" manual entry for details on the above
associated options.
labelFont labelMargin
See the "labeledwidget" manual entry for details on the
above associated options.
step
See the "spinint" manual entry for details on the above
associated options.
arrowOrient repeatDelay repeatInterval
See the "spinner" manual entry for details on the above
associated options.
WIDGET-SPECIFIC OPTIONS
Name: labelPos
Class: Position
Command-Line Switch: -labelpos
Specifies the position of the label along the sides of
the various spinners: n, e, s, or w. The default is w.
Name: hourLabel
Class: Text
Command-Line Switch: -hourlabel
Specifies the text of the label for the hour spinner.
The default is "Hour".
Name: hourOn
Class: hourOn
Command-Line Switch: -houron
Specifies whether or not to display the hour spinner in
any of the forms acceptable to Tcl_GetBoolean. The
default is true.
Name: hourWidth
Class: Width
Command-Line Switch: -hourwidth
Specifies the width of the hour spinner in any of the
forms acceptable to Tcl_GetPixels. The default is 3
pixels.
Name: militaryOn
Class: militaryOn
Command-Line Switch: -militaryon
Specifies use of a 24 hour clock for hour display in
any of the forms acceptable to Tcl_GetBoolean. The
default is true.
Name: minuteLabel
Class: Text
Command-Line Switch: -minutelabel
Specifies the text of the label for the minute spinner.
The default is "Minute".
Name: minuteOn
Class: minuteOn
Command-Line Switch: -minuteon
Specifies whether or not to display the minute spinner
in any of the forms acceptable to Tcl_GetBoolean. The
default is true.
Name: minuteWidth
Class: Width
Command-Line Switch: -minutewidth
Specifies the width of the minute spinner in any of the
forms acceptable to Tcl_GetPixels. The default is 3
pixels.
Name: orient
Class: Orient
Command-Line Switch: -orient
Specifies the orientation of the hour, minute, and
second spinners: vertical or horizontal. The default
is horizontal.
Name: secondLabel
Class: Text
Command-Line Switch: -secondlabel
Specifies the text of the label for the second spinner.
The default is "Second"
Name: secondOn
Class: secondOn
Command-Line Switch: -secondon
Specifies whether or not to display the second spinner
in any of the forms acceptable to Tcl_GetBoolean. The
default is true.
Name: secondWidth
Class: Width
Command-Line Switch: -secondwidth
Specifies the width of the second spinner in any of the
forms acceptable to Tcl_GetPixels. The default is 3
pixels.
Name: timeMargin
Class: Margin
Command-Line Switch: -timemargin
Specifies the margin space between the hour, minute,
and second spinners is any of the forms accpetable to
Tcl_GetPixels. The default is 1 pixel.
DESCRIPTION
The spintime command creates a set of spinners for use in
time value entry. The set includes an hour, minute, and
second spinner widget.
METHODS
The spintime command creates a new Tcl command whose name is
pathName. This command may be used to invoke various opera-
tions on the widget. It has the following general form:
pathName option ?arg arg ...?
Option and the args determine the exact behavior of the com-
mand. The following commands are possible for spintime widg-
ets:
WIDGET-SPECIFIC METHODS
pathName cget option
Returns the current value of the configuration option
given by option. Option may have any of the values
accepted by the spintime command.
pathName clear
Delete the contents of all spinner components.
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 correspond-
ing 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 spintime command.
pathName delete component first ?last?
Delete one or more characters of the specified com-
ponent, where component can be hour, minute, or second.
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.
pathName get ?component?
Get returns the value for the speicifed component:
hour, minute, or second. Without parameters the com-
mand returns the all three values as a list.
pathName insert component index string
Inserts the characters of string just before the char-
acter indicated by index in the component, where com-
ponent can be hour, minute, or second.
COMPONENTS
Name: hour
Class: Spinint
The hour component is the hour spinner of the time
spinner. See the SpinInt widget manual entry for
details on the hour component item.
Name: minute
Class: Spinint
The minute component is the minute spinner of the time
spinner. See the SpinInt widget manual entry for
details on the minute component item.
Name: second
Class: Spinint
The second component is the second spinner of the time
spinner. See the SpinInt widget manual entry for
details on the second component item.
EXAMPLE
spintime .st
pack .st -padx 10 -pady 10
AUTHOR
Sue Yockey
Mark L. Ulferts
KEYWORDS
spintime, spinint, spinner, entryfield, entry, widget