diff options
Diffstat (limited to 'itcl/iwidgets/doc/spindate.n')
| -rw-r--r-- | itcl/iwidgets/doc/spindate.n | 275 |
1 files changed, 275 insertions, 0 deletions
diff --git a/itcl/iwidgets/doc/spindate.n b/itcl/iwidgets/doc/spindate.n new file mode 100644 index 00000000000..2e3a89dfcb9 --- /dev/null +++ b/itcl/iwidgets/doc/spindate.n @@ -0,0 +1,275 @@ +'\" +'\" Copyright (c) 1995 DSC Technologies Corporation +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" @(#) spindate.n +'\" +.so man.macros +.HS iwidgets::spindate iwid +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +iwidgets::spindate \- Create and manipulate time spinner widgets +.SH SYNOPSIS +\fBiwidgets::spindate\fI \fIpathName \fR?\fIoptions\fR? +.SH "INHERITANCE" +itk::Widget <- iwidgets::Spindate + +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBbackground\fR \fBcursor\fR \fBforeground\fR \fBrelief\fR +.fi +.LP +See the "options" manual entry for details on the standard options. +.SH "ASSOCIATED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBtextBackground\fR \fBtextFont\fR +.fi +.LP +See the "entryfield" manual entry for details on the above associated options. +.LP +.nf +.ta 4c 8c 12c +\fBlabelFont\fR \fBlabelMargin\fR +.fi +.LP +See the "labeledwidget" manual entry for details on the above associated +options. +.LP +.nf +.ta 4c 8c 12c +\fBarrowOrient\fR \fBrepeatDelay\fR \fBrepeatInterval\fR +.fi +.LP +See the "spinner" manual entry for details on the above associated options. + +.SH "WIDGET-SPECIFIC OPTIONS" +.LP +.nf +Name: \fBdateMargin\fR +Class: \fBMargin\fR +Command-Line Switch: \fB-datemargin\fR +.fi +.IP +Specifies the margin space between the month, day, and year spinners is +any of the forms accpetable to \fBTcl_GetPixels\fR. The default is 1 pixel. +.LP +.nf +Name: \fBdayLabel\fR +Class: \fBText\fR +Command-Line Switch: \fB-daylabel\fR +.fi +.IP +Specifies the text of the label for the day spinner. The default is +"Day". +.LP +.nf +Name: \fBdayOn\fR +Class: \fBdayOn\fR +Command-Line Switch: \fB-dayon\fR +.fi +.IP +Specifies whether or not to display the day spinner in any of the forms +acceptable to \fBTcl_GetBoolean\fR. The default is true. +.LP +.nf +Name: \fBdayWidth\fR +Class: \fBWidth\fR +Command-Line Switch: \fB-daywidth\fR +.fi +.IP +Specifies the width of the day spinner in any of the forms acceptable to +\fBTcl_GetPixels\fR. The default is 3 pixels. +.LP +.nf +Name: \fBlabelPos\fR +Class: \fBPosition\fR +Command-Line Switch: \fB-labelpos\fR +.fi +.IP +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. +.LP +.nf +Name: \fBmonthFormat\fR +Class: \fBMonthFormat\fR +Command-Line Switch: \fB-monthformat\fR +.fi +.IP +Specifies the format of month display, \fBinteger\fR (1-12) or \fBbrief\fR +strings (Jan - Dec), or \fBfull\fR strings (January - December). +.LP +.nf +Name: \fBmonthLabel\fR +Class: \fBText\fR +Command-Line Switch: \fB-monthlabel\fR +.fi +.IP +Specifies the text of the label for the month spinner. The default is "Month". +.LP +.nf +Name: \fBmonthOn\fR +Class: \fBmonthOn\fR +Command-Line Switch: \fB-monthon\fR +.fi +.IP +Specifies whether or not to display the month spinner in any of the forms +acceptable to \fBTcl_GetBoolean\fR. The default is true. +.LP +.nf +Name: \fBmonthWidth\fR +Class: \fBWidth\fR +Command-Line Switch: \fB-monthwidth\fR +.fi +.IP +Specifies the width of the month spinner in any of the forms acceptable to +\fBTcl_GetPixels\fR. The default is 3 pixels. +.LP +.nf +Name: \fBorient\fR +Class: \fBOrient\fR +Command-Line Switch: \fB-orient\fR +.fi +.IP +Specifies the orientation of the month, day, and year spinners: \fBvertical\fR or \fBhorizontal\fR. The default is horizontal. +.LP +.nf +Name: \fByearDigits\fR +Class: \fBYearDigits\fR +Command-Line Switch: \fB-yeardigits\fR +.fi +.IP +Specifies the number of digits to be displayed as the value for the year +spinner. The valid values are 2 and 4. The default is 2. +.LP +.nf +Name: \fByearLabel\fR +Class: \fBText\fR +Command-Line Switch: \fB-yearlabel\fR +.fi +.IP +Specifies the text of the label for the year spinner. The default is +"Year" +.LP +.nf +Name: \fByearOn\fR +Class: \fByearOn\fR +Command-Line Switch: \fB-yearon\fR +.fi +.IP +Specifies whether or not to display the year spinner in any of the forms +acceptable to \fBTcl_GetBoolean\fR. The default is true. +.LP +.nf +Name: \fByearWidth\fR +Class: \fBWidth\fR +Command-Line Switch: \fB-yearwidth\fR +.fi +.IP +Specifies the width of the year spinner in any of the forms acceptable to +\fBTcl_GetPixels\fR. The default is 3 pixels. +.LP +.nf +.BE + +.SH DESCRIPTION +.PP + +The \fBiwidgets::spindate\fR command creates a set of spinners for use in date value +entry. The set includes an month, day, and year spinner widget. + +.SH "METHODS" +.PP +The \fBiwidgets::spindate\fR command creates a new Tcl command whose +name is \fIpathName\fR. This +command may be used to invoke various +operations on the widget. It has the following general form: +.DS C +\fIpathName option \fR?\fIarg arg ...\fR? +.DE +\fIOption\fR and the \fIarg\fRs +determine the exact behavior of the command. The following +commands are possible for spindate widgets: + +.SH "WIDGET-SPECIFIC METHODS" +.TP +\fIpathName \fBcget\fR \fIoption\fR +Returns the current value of the configuration option given +by \fIoption\fR. +\fIOption\fR may have any of the values accepted by the \fBiwidgets::spindate\fR +command. +.TP +\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR? +Query or modify the configuration options of the widget. +If no \fIoption\fR is specified, returns a list describing all of +the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for +information on the format of this list). If \fIoption\fR is specified +with no \fIvalue\fR, then the command returns a list describing the +one named option (this list will be identical to the corresponding +sublist of the value returned if no \fIoption\fR is specified). If +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 +this case the command returns an empty string. +\fIOption\fR may have any of the values accepted by the \fBiwidgets::spindate\fR +command. +.TP +\fIpathName \fBget\fR ?\fBformat\fR? +Returns the current contents of the spindate widget in a format of +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 +clock command for more information on obtaining dates and their +formats. +.TP +\fIpathName \fBshow\fR \fIdate\fR +Changes the currently displayed date to be that of the date +argument. The date may be specified either as a string, an +integer clock value or the keyword "now". Reference the clock +command for more information on obtaining dates and their formats. + +.ta 4c +.SH "COMPONENTS" +.LP +.nf +Name: \fBmonth\fR +Class: \fBSpinner\fR +.fi +.IP +The month spinner component is the month spinner of the date spinner. +See the Spinner widget manual entry for details on the month component item. +.LP +.nf +Name: \fBday\fR +Class: \fBSpinint\fR +.fi +.IP +The day spinner component is the day spinner of the date spinner. +See the SpinInt widget manual entry for details on the day component item. +.LP +.nf +Name: \fByear\fR +Class: \fBSpinint\fR +.fi +.IP +The year spinner component is the year spinner of the date spinner. +See the SpinInt widget manual entry for details on the year component item. +.fi + +.SH EXAMPLE +.DS +package require Iwidgets 4.0 +iwidgets::spindate .sd +pack .sd -padx 10 -pady 10 +.DE +.SH AUTHOR +Sue Yockey +.DE +Mark L. Ulferts +.SH KEYWORDS +spindate, spinint, spinner, entryfield, entry, widget + |