itcl/iwidgets/doc/spintime.n

   1 '\"
   2 '\" Copyright (c) 1995 DSC Technologies Corporation
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" @(#) spintime.n
   8 '\"
   9 .so man.macros
  10 .HS iwidgets::spintime iwid
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 iwidgets::spintime \- Create and manipulate time spinner widgets
  15 .SH SYNOPSIS
  16 \fBiwidgets::spintime\fI \fIpathName \fR?\fIoptions\fR?
  17 .SH "INHERITANCE"
  18 itk::Widget <- iwidgets::Spintime
  19
  20 .SH "STANDARD OPTIONS"
  21 .LP
  22 .nf
  23 .ta 4c 8c 12c
  24 \fBbackground\fR        \fBcursor\fR    \fBforeground\fR        \fBrelief\fR
  25 .fi
  26 .LP
  27 See the "options" manual entry for details on the standard options.
  28 .SH "ASSOCIATED OPTIONS"
  29 .LP
  30 .nf
  31 .ta 4c 8c 12c
  32 \fBtextBackground\fR    \fBtextFont\fR
  33 .fi
  34 .LP
  35 See the "entryfield" manual entry for details on the above associated options.
  36 .LP
  37 .nf
  38 .ta 4c 8c 12c
  39 \fBlabelFont\fR \fBlabelMargin\fR
  40 .fi
  41 .LP
  42 See the "labeledwidget" manual entry for details on the above associated
  43 options.
  44 .LP
  45 .nf
  46 .ta 4c 8c 12c
  47 \fBarrowOrient\fR       \fBrepeatDelay\fR       \fBrepeatInterval\fR
  48 .fi
  49 .LP
  50 See the "spinner" manual entry for details on the above associated options.
  51
  52 .SH "WIDGET-SPECIFIC OPTIONS"
  53 .LP
  54 .nf
  55 Name:   \fBlabelPos\fR
  56 Class:  \fBPosition\fR
  57 Command-Line Switch:    \fB-labelpos\fR
  58 .fi
  59 .IP
  60 Specifies the position of the label along the sides of the various
  61 spinners: \fBn\fR, \fBe\fR, \fBs\fR, or \fBw\fR.  The default is w.
  62 .LP
  63 .nf
  64 Name:   \fBhourLabel\fR
  65 Class:  \fBText\fR
  66 Command-Line Switch:    \fB-hourlabel\fR
  67 .fi
  68 .IP
  69 Specifies the text of the label for the hour spinner.  The default is "Hour".
  70 .LP
  71 .nf
  72 Name:   \fBhourOn\fR
  73 Class:  \fBhourOn\fR
  74 Command-Line Switch:    \fB-houron\fR
  75 .fi
  76 .IP
  77 Specifies whether or not to display the hour spinner in any of the forms
  78 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
  79 .LP
  80 .nf
  81 Name:   \fBhourWidth\fR
  82 Class:  \fBWidth\fR
  83 Command-Line Switch:    \fB-hourwidth\fR
  84 .fi
  85 .IP
  86 Specifies the width of the hour spinner in any of the forms acceptable to
  87 \fBTcl_GetPixels\fR.  The default is 3 pixels.
  88 .LP
  89 .nf
  90 Name:   \fBmilitaryOn\fR
  91 Class:  \fBmilitaryOn\fR
  92 Command-Line Switch:    \fB-militaryon\fR
  93 .fi
  94 .IP
  95 Specifies use of a 24 hour clock for hour display in any of the forms
  96 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
  97 .LP
  98 .nf
  99 Name:   \fBminuteLabel\fR
 100 Class:  \fBText\fR
 101 Command-Line Switch:    \fB-minutelabel\fR
 102 .fi
 103 .IP
 104 Specifies the text of the label for the minute spinner.  The default is
 105 "Minute".
 106 .LP
 107 .nf
 108 Name:   \fBminuteOn\fR
 109 Class:  \fBminuteOn\fR
 110 Command-Line Switch:    \fB-minuteon\fR
 111 .fi
 112 .IP
 113 Specifies whether or not to display the minute spinner in any of the forms
 114 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
 115 .LP
 116 .nf
 117 Name:   \fBminuteWidth\fR
 118 Class:  \fBWidth\fR
 119 Command-Line Switch:    \fB-minutewidth\fR
 120 .fi
 121 .IP
 122 Specifies the width of the minute spinner in any of the forms acceptable to
 123 \fBTcl_GetPixels\fR.  The default is 3 pixels.
 124 .LP
 125 .nf
 126 Name:   \fBorient\fR
 127 Class:  \fBOrient\fR
 128 Command-Line Switch:    \fB-orient\fR
 129 .fi
 130 .IP
 131 Specifies the orientation of the hour, minute, and second spinners: \fBvertical\fR or \fBhorizontal\fR.  The default is horizontal.
 132 .LP
 133 .nf
 134 Name:   \fBsecondLabel\fR
 135 Class:  \fBText\fR
 136 Command-Line Switch:    \fB-secondlabel\fR
 137 .fi
 138 .IP
 139 Specifies the text of the label for the second spinner.  The default is
 140 "Second"
 141 .LP
 142 .nf
 143 Name:   \fBsecondOn\fR
 144 Class:  \fBsecondOn\fR
 145 Command-Line Switch:    \fB-secondon\fR
 146 .fi
 147 .IP
 148 Specifies whether or not to display the second spinner in any of the forms
 149 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
 150 .LP
 151 .nf
 152 Name:   \fBsecondWidth\fR
 153 Class:  \fBWidth\fR
 154 Command-Line Switch:    \fB-secondwidth\fR
 155 .fi
 156 .IP
 157 Specifies the width of the second spinner in any of the forms acceptable to
 158 \fBTcl_GetPixels\fR.  The default is 3 pixels.
 159 .LP
 160 .nf
 161 Name:   \fBtimeMargin\fR
 162 Class:  \fBMargin\fR
 163 Command-Line Switch:    \fB-timemargin\fR
 164 .fi
 165 .IP
 166 Specifies the margin space between the hour, minute, and second spinners is
 167 any of the forms accpetable to \fBTcl_GetPixels\fR.  The default is 1 pixel.
 168 .LP
 169 .nf
 170 .BE
 171
 172 .SH DESCRIPTION
 173 .PP
 174
 175 The \fBiwidgets::spintime\fR command creates a set of spinners for use in time value
 176 entry.  The set includes an hour, minute, and second spinner widget.
 177
 178 .SH "METHODS"
 179 .PP
 180 The \fBiwidgets::spintime\fR command creates a new Tcl command whose
 181 name is \fIpathName\fR. This
 182 command may be used to invoke various
 183 operations on the widget. It has the following general form:
 184 .DS C
 185 \fIpathName option \fR?\fIarg arg ...\fR?
 186 .DE
 187 \fIOption\fR and the \fIarg\fRs
 188 determine the exact behavior of the command. The following
 189 commands are possible for spintime widgets:
 190
 191 .SH "WIDGET-SPECIFIC METHODS"
 192 .TP
 193 \fIpathName \fBcget\fR \fIoption\fR
 194 Returns the current value of the configuration option given
 195 by \fIoption\fR.
 196 \fIOption\fR may have any of the values accepted by the \fBiwidgets::spintime\fR
 197 command.
 198 .TP
 199 \fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 200 Query or modify the configuration options of the widget.
 201 If no \fIoption\fR is specified, returns a list describing all of
 202 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
 203 information on the format of this list).  If \fIoption\fR is specified
 204 with no \fIvalue\fR, then the command returns a list describing the
 205 one named option (this list will be identical to the corresponding
 206 sublist of the value returned if no \fIoption\fR is specified).  If
 207 one or more \fIoption\-value\fR pairs are specified, then the command
 208 modifies the given widget option(s) to have the given value(s);  in
 209 this case the command returns an empty string.
 210 \fIOption\fR may have any of the values accepted by the \fBiwidgets::spintime\fR
 211 command.
 212 .TP
 213 \fIpathName \fBget\fR ?\fBformat\fR?
 214 Returns the current contents of the spintime widget in a format of
 215 string or as an integer clock value using the \fB-string\fR and \fB-clicks\fR
 216 format options respectively.  The default is by string.  Reference the
 217 clock command for more information on obtaining time and its
 218 formats.
 219 .TP
 220 \fIpathName \fBshow\fR \fItime\fR
 221 Changes the currently displayed time to be that of the time
 222 argument.  The time may be specified either as a string, an
 223 integer clock value or the keyword "now".  Reference the clock
 224 command for more information on obtaining times and its format.
 225
 226 .ta 4c
 227 .SH "COMPONENTS"
 228 .LP
 229 .nf
 230 Name:   \fBhour\fR
 231 Class:  \fBSpinint\fR
 232 .fi
 233 .IP
 234 The hour component is the hour spinner of the time spinner.  See the
 235 SpinInt widget manual entry for details on the hour component item.
 236 .LP
 237 .nf
 238 Name:   \fBminute\fR
 239 Class:  \fBSpinint\fR
 240 .fi
 241 .IP
 242 The minute component is the minute spinner of the time spinner.  See
 243 the SpinInt widget manual entry for details on the minute component item.
 244 .LP
 245 .nf
 246 Name:   \fBsecond\fR
 247 Class:  \fBSpinint\fR
 248 .fi
 249 .IP
 250 The second component is the second spinner of the time spinner.  See the
 251 SpinInt widget manual entry for details on the second component item.
 252 .fi
 253
 254 .SH EXAMPLE
 255 .DS
 256 package require Iwidgets 4.0
 257 iwidgets::spintime .st
 258 pack .st -padx 10 -pady 10
 259 .DE
 260 .SH AUTHOR
 261 Sue Yockey
 262 .DE
 263 Mark L. Ulferts
 264 .SH KEYWORDS
 265 spintime, spinint, spinner, entryfield, entry, widget
 266