diff options
Diffstat (limited to 'itcl/iwidgets/doc/timeentry.n')
-rw-r--r-- | itcl/iwidgets/doc/timeentry.n | 196 |
1 files changed, 196 insertions, 0 deletions
diff --git a/itcl/iwidgets/doc/timeentry.n b/itcl/iwidgets/doc/timeentry.n new file mode 100644 index 00000000000..5545eecf49d --- /dev/null +++ b/itcl/iwidgets/doc/timeentry.n @@ -0,0 +1,196 @@ +'\" +'\" Copyright (c) 1997 DSC Technologies Corporation +'\" +'\" See the file "license.terms" for information on usage and redistribution +'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. +'\" +'\" @(#) timeentry.n 1.0 97/04/30 16:04:44 +'\" +.so man.macros +.HS iwidgets::timeentry iwid +.BS +'\" Note: do not modify the .SH NAME line immediately below! +.SH NAME +iwidgets::timeentry \- Create and manipulate a timeentry widget +.SH SYNOPSIS +\fBiwidgets::timeentry\fI \fIpathName \fR?\fIoptions\fR? +.SH "INHERITANCE" +itk::Widget <- iwidgets::LabeledWidget <- iwidgets::Timefield <- iwidgets::Timeentry +.SH "STANDARD OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fB +background borderWidth cursor exportSelection +foreground highlightColor highlightThickness insertBackground +justify relief\fR +.fi +.LP +See the "options" manual entry for details on the standard options. +.SH "INHERITED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBdisabledForeground\fR \fBlabelBitmap\fR \fBlabelFont\fR \fBlabelImage\fR +\fBlabelMargin\fR \fBlabelPos\fR \fBlabelText\fR \fBlabelVariable\fR +\fBstate\fR \fBsticky\fR +.fi +.LP +See the "labeledwidget" class manual entry for details on these +inherited options. +.LP +.nf +.ta 4c 8c 12c +\fBcommand\fR \fBformat\fR \fBseconds\fR \fBtextBackground\fR +\fBtextFont\fR +.fi +.LP +See the "timefield" class manual entry for details on these +inherited options. +.SH "ASSOCIATED OPTIONS" +.LP +.nf +.ta 4c 8c 12c +\fBhourRadius\fR \fBhourColor\fR \fBminuteRadius\fR \fBminuteColor\fR +\fBpivotRadius\fR \fBpivotColor\fR \fBsecondRadius\fR \fBsecondColor\fR +\fBclockColor\fR \fBclockStipple\fR \fBtickColor\fR \fBwatchHeight\fR +\fBwatchWidth\fR +.fi +.LP +See the "watch" manual entry for details on the associated options. +.SH "WIDGET-SPECIFIC OPTIONS" +.LP +.nf +Name: \fBcloseText\fR +Class: \fBText\fR +Command-Line Switch: \fB-closetext\fR +.fi +.IP +Specifies the text to be displayed on the close button of the watch +popup. The default is Close. +.LP +.nf +Name: \fBgrab\fR +Class: \fBGrab\fR +Command-Line Switch: \fB-grab\fR +.fi +.IP +Specifies the grab level, \fBlocal\fR or \fBglobal\fR, to be obtained before +bringing up the popup watch. The default is global. For more information +concerning grab levels, consult the documentation for Tk's \fBgrab\fR command. +.LP +.nf +Name: \fBicon\fR +Class: \fBIcon\fR +Command-Line Switch: \fB-icon\fR +.fi +.IP +Specifies the watch icon image to be used in the timeentry. +This image must have been created previously with +the \fBimage create\fR command. Should one not be provided, +then one will be generated, pixmap if possible, bitmap otherwise. +.LP +.nf +Name: \fBstate\fR +Class: \fBState\fR +Command-Line Switch: \fB-state\fR +.fi +.IP +Specifies the state of the widget which may be \fBdisabled\fR or +\fBnormal\fR. A disabled state prevents selection of the timefield +or time icon button. +.LP +.BE + +.SH DESCRIPTION +.PP +The \fBiwidgets::timeentry\fR command creates a time entry field +with a popup watch by combining the timefield and watch +widgets together. This allows a user to enter the time via the +keyboard or by using the mouse and selecting the watch icon +which brings up a popup watch. +.DE + +.SH "METHODS" +.PP +The \fBiwidgets::timeentry\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 timeentry widgets: +.SH "INHERITED METHODS" +.LP +.nf +.ta 4c 8c 12c +\fBget\fR \fBisvalid\fR \fBshow\fR +.fi +.LP +See the "timefield" manual entry for details on the associated methods. +.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::timeentry\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::timeentry\fR +command. + +.SH "COMPONENTS" +.LP +.nf +Name: \fBlabel\fR +Class: \fBLabel\fR +.fi +.IP +The label component provides a label component to used to identify the time. +See the "label" widget manual entry for details on the label component item. +.LP +.nf +Name: \fBiconbutton\fR +Class: \fBLabel\fR +.fi +.IP +The iconbutton component provides a labelbutton component to act as a +lightweight button +displaying the watch icon. Upon pressing the labelbutton, the watch +appears. See the "label" widget manual entry for details on the +labelbutton component item. +.LP +.nf +Name: \fBtime\fR +Class: \fBEntry\fR +.fi +.IP +The time component provides the entry field for time input and display. +See the "entry" widget manual entry for details on the time component item. +.fi + +.SH EXAMPLE +.DS + package require Iwidgets 4.0 + iwidgets::timeentry .te + pack .te +.DE +.SH AUTHOR +Mark L. Ulferts +.LP +.SH KEYWORDS +timeentry, widget |