iwidgets::timefield(1) [incr Widgets] iwidgets::timefield(1)

NAME
       iwidgets::timefield - Create and manipulate a time field widget

SYNOPSIS
       iiwwiiddggeettss::::ttiimmeeffiieelldd pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Widget <- iwidgets::LabeledWidget <- iwidgets::Timefield

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       bbaacckkggrroouunndd  bboorrddeerrWWiiddtthh     ccuurrssoorr              eexxppoorrttSSeelleeccttiioonn
       ffoorreeggrroouunndd  hhiigghhlliigghhttCCoolloorr  hhiigghhlliigghhttTThhiicckknneessss  iinnsseerrttBBaacckkggrroouunndd
       jjuussttiiffyy     rreelliieeff

       See the "options" manual entry for details on the standard options.

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       ddiissaabblleeddFFoorreeggrroouunndd             llaabbeellBBiittmmaapp     llaabbeellFFoonnttllaabbeellIImmaaggee
       llaabbeellMMaarrggiinn     llaabbeellPPooss       llaabbeellTTeexxtt       llaabbeellVVaarriiaabbllee
       ssttaattee           ssttiicckkyy

       See the "labeledwidget" class manual entry for details on the inherited
       options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           cchhiillddSSiitteePPooss
       Class:          PPoossiittiioonn
       Command-Line Switch:           -cchhiillddssiitteeppooss

              Specifies the position of the child site in the time  field:  nn,
              ss, ee, or ww.  The default is e.

       Name:           ccoommmmaanndd
       Class:          CCoommmmaanndd
       Command-Line Switch:           -ccoommmmaanndd

              Specifies  a  Tcl  command  to  be  executed upon detection of a
              Return key press event.

       Name:           ggmmtt
       Class:          GGmmtt
       Command-Line Switch:           -ggmmtt

              Determines whether the time is calculated relative to  Greenwich
              Mean Time. Accepts a boolean value. The default is no.

              Name:           ssttaattee     Class:          SSttaattee     Command-Line
              Switch:           -ssttaattee

              Specifies one of two states for the timefield:  nnoorrmmaall  or  ddiiss-
              aabblleedd.  If the timefield is disabled then input is not accepted.
              The default is normal.

       Name:           tteexxttBBaacckkggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -tteexxttbbaacckkggrroouunndd

              Background color for inside textual portion of the entry  field.
              The value may be given in any of the forms acceptable to TTkkGGeett-
              CCoolloorr.

       Name:           tteexxttFFoonntt
       Class:          FFoonntt
       Command-Line Switch:           -tteexxttffoonntt

              Name of font to use for display of text in timefield.  The value
              may be given in any of the forms acceptable to TTkkGGeettFFoonntt.




DESCRIPTION
       The  iiwwiiddggeettss::::ttiimmeeffiieelldd  command creates an enhanced text entry widget
       for the purpose of time entry with various degrees of built-in intelli-
       gence.



MMEETTHHOODDSS
       The iiwwiiddggeettss::::ttiimmeeffiieelldd command creates a new Tcl command whose name is
       pathName.  This command may be used to invoke various operations on the
       widget.  It has the following general form:

              pathName option ?arg arg ...?

       Option  and  the args determine the exact behavior of the command.  The
       following commands are possible for timefield widgets:

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName ccggeett option
              Returns the current value of the configuration option  given  by
              option.  Option may have any of the values accepted by the iiwwiidd-
              ggeettss::::ttiimmeeffiieelldd command.

       pathName ccoonnffiigguurree ?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 avail-
              able options for pathName (see TTkkCCoonnffiigguurreeIInnffoo 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 corresponding 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 iiwwiiddggeettss::::ttiimmeeffiieelldd command.

       pathName ggeett ?ffoorrmmaatt?
              Returns the current contents of the timefield  in  a  format  of
              string  or  as  an  integer  clock  value  using the -ssttrriinngg and
              -cclliicckkss format options respectively.  The default is by  string.
              Reference  the  clock  command for more information on obtaining
              times and their formats.

       pathName iissvvaalliidd
              Returns a boolean indication of the validity  of  the  currently
              displayed  time  value.   For example, 12:59:59 is valid whereas
              25:59:59 is invalid.

       pathName sshhooww time
              Changes the currently displayed time to  be  that  of  the  time
              argument.   The  time  may  be  specified either as a string, an
              integer clock value or the keyword "now" (the default).   Refer-
              ence  the  clock command for more information on obtaining times
              and their formats.


CCOOMMPPOONNEENNTTSS
       Name:           ttiimmee
       Class:          EEnnttrryy

              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.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               proc returnCmd {} {
                 puts [.tf get]
               }

               iwidgets::timefield .tf -command returnCmd
               pack .tf -fill x -expand yes -padx 10 -pady 10


AUTHOR       John A. Tucker

       Mark L. Ulferts


KKEEYYWWOORRDDSS
       timefield, widget



Tk                                                      iwidgets::timefield(1)