itcl/iwidgets3.0.0/doc/spindate.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 '\" @(#) spindate.n
   8 '\"
   9 .so man.macros
  10 .HS spindate iwid
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 spindate \- Create and manipulate time spinner widgets
  15 .SH SYNOPSIS
  16 \fBspindate\fI \fIpathName \fR?\fIoptions\fR?
  17 .SH "INHERITANCE"
  18 itk::Widget <- Spindate
  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:   \fBdateMargin\fR
  56 Class:  \fBMargin\fR
  57 Command-Line Switch:    \fB-datemargin\fR
  58 .fi
  59 .IP
  60 Specifies the margin space between the month, day, and year spinners is
  61 any of the forms accpetable to \fBTcl_GetPixels\fR.  The default is 1 pixel.
  62 .LP
  63 .nf
  64 Name:   \fBdayLabel\fR
  65 Class:  \fBText\fR
  66 Command-Line Switch:    \fB-daylabel\fR
  67 .fi
  68 .IP
  69 Specifies the text of the label for the day spinner.  The default is
  70 "Day".
  71 .LP
  72 .nf
  73 Name:   \fBdayOn\fR
  74 Class:  \fBdayOn\fR
  75 Command-Line Switch:    \fB-dayon\fR
  76 .fi
  77 .IP
  78 Specifies whether or not to display the day spinner in any of the forms
  79 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
  80 .LP
  81 .nf
  82 Name:   \fBdayWidth\fR
  83 Class:  \fBWidth\fR
  84 Command-Line Switch:    \fB-daywidth\fR
  85 .fi
  86 .IP
  87 Specifies the width of the day spinner in any of the forms acceptable to
  88 \fBTcl_GetPixels\fR.  The default is 3 pixels.
  89 .LP
  90 .nf
  91 Name:   \fBlabelPos\fR
  92 Class:  \fBPosition\fR
  93 Command-Line Switch:    \fB-labelpos\fR
  94 .fi
  95 .IP
  96 Specifies the position of the label along the sides of the various
  97 spinners: \fBn\fR, \fBe\fR, \fBs\fR, or \fBw\fR.  The default is w.
  98 .LP
  99 .nf
 100 Name:   \fBmonthFormat\fR
 101 Class:  \fBMonthFormat\fR
 102 Command-Line Switch:    \fB-monthformat\fR
 103 .fi
 104 .IP
 105 Specifies the format of month display, \fBinteger\fR (1-12) or \fBbrief\fR
 106 strings (Jan - Dec), or \fBfull\fR strings (January - December).
 107 .LP
 108 .nf
 109 Name:   \fBmonthLabel\fR
 110 Class:  \fBText\fR
 111 Command-Line Switch:    \fB-monthlabel\fR
 112 .fi
 113 .IP
 114 Specifies the text of the label for the month spinner.  The default is "Month".
 115 .LP
 116 .nf
 117 Name:   \fBmonthOn\fR
 118 Class:  \fBmonthOn\fR
 119 Command-Line Switch:    \fB-monthon\fR
 120 .fi
 121 .IP
 122 Specifies whether or not to display the month spinner in any of the forms
 123 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
 124 .LP
 125 .nf
 126 Name:   \fBmonthWidth\fR
 127 Class:  \fBWidth\fR
 128 Command-Line Switch:    \fB-monthwidth\fR
 129 .fi
 130 .IP
 131 Specifies the width of the month spinner in any of the forms acceptable to
 132 \fBTcl_GetPixels\fR.  The default is 3 pixels.
 133 .LP
 134 .nf
 135 Name:   \fBorient\fR
 136 Class:  \fBOrient\fR
 137 Command-Line Switch:    \fB-orient\fR
 138 .fi
 139 .IP
 140 Specifies the orientation of the month, day, and year spinners: \fBvertical\fR or \fBhorizontal\fR.  The default is horizontal.
 141 .LP
 142 .nf
 143 Name:   \fByearDigits\fR
 144 Class:  \fBYearDigits\fR
 145 Command-Line Switch:    \fB-yeardigits\fR
 146 .fi
 147 .IP
 148 Specifies the number of digits to be displayed as the value for the year
 149 spinner.  The valid values are 2 and 4.  The default is 2.
 150 .LP
 151 .nf
 152 Name:   \fByearLabel\fR
 153 Class:  \fBText\fR
 154 Command-Line Switch:    \fB-yearlabel\fR
 155 .fi
 156 .IP
 157 Specifies the text of the label for the year spinner.  The default is
 158 "Year"
 159 .LP
 160 .nf
 161 Name:   \fByearOn\fR
 162 Class:  \fByearOn\fR
 163 Command-Line Switch:    \fB-yearon\fR
 164 .fi
 165 .IP
 166 Specifies whether or not to display the year spinner in any of the forms
 167 acceptable to \fBTcl_GetBoolean\fR.  The default is true.
 168 .LP
 169 .nf
 170 Name:   \fByearWidth\fR
 171 Class:  \fBWidth\fR
 172 Command-Line Switch:    \fB-yearwidth\fR
 173 .fi
 174 .IP
 175 Specifies the width of the year spinner in any of the forms acceptable to
 176 \fBTcl_GetPixels\fR.  The default is 3 pixels.
 177 .LP
 178 .nf
 179 .BE
 180
 181 .SH DESCRIPTION
 182 .PP
 183
 184 The \fBspindate\fR command creates a set of spinners for use in date value
 185 entry.  The set includes an month, day, and year spinner widget.
 186
 187 .SH "METHODS"
 188 .PP
 189 The \fBspindate\fR command creates a new Tcl command whose
 190 name is \fIpathName\fR. This
 191 command may be used to invoke various
 192 operations on the widget. It has the following general form:
 193 .DS C
 194 \fIpathName option \fR?\fIarg arg ...\fR?
 195 .DE
 196 \fIOption\fR and the \fIarg\fRs
 197 determine the exact behavior of the command. The following
 198 commands are possible for spindate widgets:
 199
 200 .SH "WIDGET-SPECIFIC METHODS"
 201 .TP
 202 \fIpathName \fBcget\fR \fIoption\fR
 203 Returns the current value of the configuration option given
 204 by \fIoption\fR.
 205 \fIOption\fR may have any of the values accepted by the \fBspindate\fR
 206 command.
 207 .TP
 208 \fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
 209 Query or modify the configuration options of the widget.
 210 If no \fIoption\fR is specified, returns a list describing all of
 211 the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
 212 information on the format of this list).  If \fIoption\fR is specified
 213 with no \fIvalue\fR, then the command returns a list describing the
 214 one named option (this list will be identical to the corresponding
 215 sublist of the value returned if no \fIoption\fR is specified).  If
 216 one or more \fIoption\-value\fR pairs are specified, then the command
 217 modifies the given widget option(s) to have the given value(s);  in
 218 this case the command returns an empty string.
 219 \fIOption\fR may have any of the values accepted by the \fBspindate\fR
 220 command.
 221 .TP
 222 \fIpathName \fBget\fR ?\fBformat\fR?
 223 Returns the current contents of the spindate widget in a format of
 224 string or as an integer clock value using the \fB-string\fR and \fB-clicks\fR
 225 format options respectively.  The default is by string.  Reference the
 226 clock command for more information on obtaining dates and their
 227 formats.
 228 .TP
 229 \fIpathName \fBshow\fR \fIdate\fR
 230 Changes the currently displayed date to be that of the date
 231 argument.  The date may be specified either as a string, an
 232 integer clock value or the keyword "now".  Reference the clock
 233 command for more information on obtaining dates and their formats.
 234
 235 .ta 4c
 236 .SH "COMPONENTS"
 237 .LP
 238 .nf
 239 Name:   \fBmonth\fR
 240 Class:  \fBSpinner\fR
 241 .fi
 242 .IP
 243 The month spinner component is the month spinner of the date spinner.
 244 See the Spinner widget manual entry for details on the month component item.
 245 .LP
 246 .nf
 247 Name:   \fBday\fR
 248 Class:  \fBSpinint\fR
 249 .fi
 250 .IP
 251 The day spinner component is the day spinner of the date spinner.
 252 See the SpinInt widget manual entry for details on the day component item.
 253 .LP
 254 .nf
 255 Name:   \fByear\fR
 256 Class:  \fBSpinint\fR
 257 .fi
 258 .IP
 259 The year spinner component is the year spinner of the date spinner.
 260 See the SpinInt widget manual entry for details on the year component item.
 261 .fi
 262
 263 .SH EXAMPLE
 264 .DS
 265 spindate .sd
 266 pack .sd -padx 10 -pady 10
 267 .DE
 268 .SH AUTHOR
 269 Sue Yockey
 270 .DE
 271 Mark L. Ulferts
 272 .SH KEYWORDS
 273 spindate, spinint, spinner, entryfield, entry, widget
 274