This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

history(n)                          Provides a history for Entry widgets                          history(n)



____________________________________________________________________________________________________________

NAME
       history - Provides a history for Entry widgets

SYNOPSIS
       package require Tcl  8.4

       package require Tk  8.4

       package require history  ?0.1?

       ::history::init pathName ?length?

       ::history::remove pathName

       ::history::add pathName text

       ::history::get pathName

       ::history::clear pathName

       ::history::configure pathName option ?value?

       bell

____________________________________________________________________________________________________________

DESCRIPTION
       This  package provides a convenient history mechanism for Entry widgets.  The history may be accessed
       with the up and down arrow keys.


       ::history::init pathName ?length?
              Arranges to remember the history of the named Entry widget. An optional length determines  the
              number  of  history entries to keep. This may be changed later with ::history::configure. His-tory History
              tory entries must be added with the ::history::add command before they can be seen.

       ::history::remove pathName
              Forgets all history entries for the Entry pathName and removes the history bindings.

       ::history::add pathName text
              This command is used to add history entries  to  an  Entry  that  has  previously  had  ::his-tory::init ::history::init
              tory::init  called  on it. This command should be called from your Entry handler with the con-tents contents
              tents of the entry (or whatever you wish to add to the history).

       ::history::get pathName
              This command returns a list containing the history entries for the Entry pathName

       ::history::clear pathName
              This command clears the history list for the named Entry.

       ::history::configure pathName option ?value?
              This command queries or sets configuration  options.  Currently  the  options  recognized  are
              length  and alert. Setting the length determines the number of history entries to keep for the
              named Entry. Alert specifies the command to run when the user reaches the end of the  history,
              it defaults to

       bell

              entry .e
              bind .e <Return> [list ProcessEntry %W]
              ::history::init .e
              pack .e

              proc ProcessEntry {w} {
                  set text [$w get]
                  if {$text == ""} { return }
                  ::history::add $w $text
                  puts $text
                  $w delete 0 end
              }



KEYWORDS
       entry, history



history                                              0.1                                          history(n)