entry(n)		     Ck Built-In Commands		      entry(n)



______________________________________________________________________________

NAME
       entry - Create and manipulate entry widgets

SYNOPSIS
       entry pathName ?options?

STANDARD OPTIONS
       attributes      justify	      selectForegroundxScrollCommand
       background      selectAttributes		      takeFocus
       foreground      selectBackground		      textVariable

       See the ``options'' manual entry for details on the standard options.

WIDGET-SPECIFIC OPTIONS
       Name:	       show
       Class:	       Show
       Command-Line Switch:-show

	      If this option is specified, then the true contents of the entry
	      are not displayed in the window.	Instead, each character in the
	      entry's  value  will  be displayed as the first character in the
	      value of this option, such as ``*''.  This is useful, for	 exam-
	      ple, if the entry is to be used to enter a password.

       Name:	       state
       Class:	       State
       Command-Line Switch:-state

	      Specifies	 one of two states for the entry:  normal or disabled.
	      If the entry is disabled then the value may not be changed using
	      widget  commands and no insertion cursor will be displayed, even
	      if the input focus is in the widget.

       Name:	       width
       Class:	       Width
       Command-Line Switch:-width

	      Specifies an integer value indicating the desired width  of  the
	      entry  window,  in  screen columns. If the value is less than or
	      equal to zero, the widget picks a size just large enough to hold
	      its current text. The default width is 16.
_________________________________________________________________


DESCRIPTION
       The entry command creates a new window (given by the pathName argument)
       and makes it into  an  entry  widget.   Additional  options,  described
       above,  may  be specified on the command line or in the option database
       to configure aspects of the entry such as its  colors  and  attributes.
       The entry command returns its pathName argument.	 At the time this com-
       mand is invoked, there must not exist  a	 window	 named	pathName,  but
       pathName's parent must exist.

       An  entry  is  a widget that displays a one-line text string and allows
       that string to be edited using widget commands described	 below,	 which
       are  typically  bound to keystrokes and mouse actions.  When first cre-
       ated, an entry's string is empty.   A  portion  of  the	entry  may  be
       selected	 as  described	below.	 Entries  also observe the standard Ck
       rules for dealing with the input focus.	When an entry  has  the	 input
       focus  it displays an insertion cursor to indicate where new characters
       will be inserted.

       Entries are capable of displaying strings that  are  too	 long  to  fit
       entirely	 within	 the widget's window.  In this case, only a portion of
       the string will be displayed;  commands described below may be used  to
       change the view in the window.  Entries use the standard xScrollCommand
       mechanism for interacting with scrollbars (see the description  of  the
       xScrollCommand option for details).


WIDGET COMMAND
       The  entry  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.

       Many of the widget commands for entries take one	 or  more  indices  as
       arguments.   An	index  specifies a particular character in the entry's
       string, in any of the following ways:

       number	   Specifies the character as a numerical index, where 0  cor-
		   responds to the first character in the string.

       anchor	   Indicates  the anchor point for the selection, which is set
		   with the select from and select adjust widget commands.

       end	   Indicates the character just after  the  last  one  in  the
		   entry's string.  This is equivalent to specifying a numeri-
		   cal index equal to the length of the entry's string.

       insert	   Indicates the character adjacent to and immediately follow-
		   ing the insertion cursor.

       sel.first   Indicates  the  first character in the selection.  It is an
		   error to use this form if the selection isn't in the	 entry
		   window.

       sel.last	   Indicates  the  character  just  after  the last one in the
		   selection.  It is an error to use this form if  the	selec-
		   tion isn't in the entry window.

       @number	   In  this  form, number is treated as an x-coordinate in the
		   entry's window;  the character spanning  that  x-coordinate
		   is used.  For example, ``@0'' indicates the left-most char-
		   acter in the window.

       Abbreviations may be used for any of the forms  above,  e.g.  ``e''  or
       ``sel.f''.   In general, out-of-range indices are automatically rounded
       to the nearest legal value.

       The following commands are possible for entry widgets:

       pathName cget option
	      Returns the current value of the configuration option  given  by
	      option.  Option may have any of the values accepted by the entry
	      command.

       pathName configure ?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. 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 entry command.

       pathName delete first ?last?
	      Delete one or more elements of the entry.	 First is the index of
	      the first character to delete, and last  is  the	index  of  the
	      character	 just  after  the  last	 one to delete.	 If last isn't
	      specified it defaults to first+1, i.e.  a	 single	 character  is
	      deleted.	This command returns an empty string.

       pathName get
	      Returns the entry's string.

       pathName icursor index
	      Arrange for the insertion cursor to be displayed just before the
	      character given by index.	 Returns an empty string.

       pathName index index
	      Returns the numerical index corresponding to index.

       pathName insert index string
	      Insert the characters of string just before the character	 indi-
	      cated by index.  Returns an empty string.

       pathName selection option arg
	      This  command  is	 used to adjust the selection within an entry.
	      It has several forms, depending on option:

	      pathName selection adjust index
		     Locate the end of the selection nearest to the  character
		     given  by	index, and adjust that end of the selection to
		     be at index (i.e including but not going  beyond  index).
		     The  other	 end of the selection is made the anchor point
		     for future select to commands.  If	 the  selection	 isn't
		     currently	in  the entry, then a new selection is created
		     to include the characters	between	 index	and  the  most
		     recent  selection	anchor	point,	inclusive.  Returns an
		     empty string.

	      pathName selection clear
		     Clear the selection if it is currently  in	 this  widget.
		     If	 the  selection	 isn't in this widget then the command
		     has no effect.  Returns an empty string.

	      pathName selection from index
		     Set the selection anchor point to just before the charac-
		     ter  given	 by  index.   Doesn't  change  the  selection.
		     Returns an empty string.

	      pathName selection present
		     Returns 1 if there is  are	 characters  selected  in  the
		     entry, 0 if nothing is selected.

	      pathName selection range start end
		     Sets  the	selection  to  include the characters starting
		     with the one indexed by start and	ending	with  the  one
		     just  before end.	If end refers to the same character as
		     start or an earlier one, then the	entry's	 selection  is
		     cleared.

	      pathName selection to index
		     If index is before the anchor point, set the selection to
		     the characters from index up to  but  not	including  the
		     anchor  point.  If index is the same as the anchor point,
		     do nothing.  If index is after the anchor point, set  the
		     selection	to  the characters from the anchor point up to
		     but not including index.  The anchor point is  determined
		     by	 the  most recent select from or select adjust command
		     in this widget.  If the selection isn't  in  this	widget
		     then  a  new  selection  is created using the most recent
		     anchor point specified for the widget.  Returns an	 empty
		     string.

       pathName xview args
	      This command is used to query and change the horizontal position
	      of the text in the widget's window.  It can take any of the fol-
	      lowing forms:

	      pathName xview
		     Returns  a list containing two elements.  Each element is
		     a real fraction between 0 and 1;  together they  describe
		     the  horizontal  span that is visible in the window.  For
		     example, if the first element is .2 and the  second  ele-
		     ment  is .6, 20% of the entry's text is off-screen to the
		     left, the middle 40% is visible in the window, and 40% of
		     the  text is off-screen to the right.  These are the same
		     values  passed  to	 scrollbars  via  the  -xscrollcommand
		     option.

	      pathName xview index
		     Adjusts  the  view	 in  the  window so that the character
		     given by index is displayed at the left edge of the  win-
		     dow.

	      pathName xview moveto fraction
		     Adjusts  the  view	 in  the  window so that the character
		     fraction of the way through the text appears at the  left
		     edge  of the window.  Fraction must be a fraction between
		     0 and 1.

	      pathName xview scroll number what
		     This command shifts the view in the window left or	 right
		     according to number and what.  Number must be an integer.
		     What must be either units or pages or an abbreviation  of
		     one of these.  If what is units, the view adjusts left or
		     right by number average-width characters on the  display;
		     if	 it  is	 pages then the view adjusts by number screen-
		     fuls.  If number is negative then characters  farther  to
		     the  left become visible;	if it is positive then charac-
		     ters farther to the right become visible.


DEFAULT BINDINGS
       Ck automatically creates class bindings for entries that give them  the
       following default behavior.

       [1]    Clicking	mouse  button  1  positions  the insertion cursor just
	      before the character underneath the mouse cursor, sets the input
	      focus to this widget, and clears any selection in the widget.

       [2]    If  any  normal  printing characters are typed in an entry, they
	      are inserted at the point of the insertion cursor.

       [3]    The Left and Right keys move the insertion cursor one  character
	      to  the  left  or	 right;	  they also clear any selection in the
	      entry and set the selection  anchor.   Control-b	and  Control-f
	      behave the same as Left and Right, respectively.

       [4]    The  Home	 key,  or Control-a, will move the insertion cursor to
	      the beginning of the entry and clear any selection in the entry.

       [5]    The End key, or Control-e, will move the insertion cursor to the
	      end of the entry and clear any selection in the entry.

       [6]    The  Select key sets the selection anchor to the position of the
	      insertion cursor. It doesn't affect the current selection.

       [7]    The Delete key deletes the selection, if there  is  one  in  the
	      entry.   If  there  is no selection, it deletes the character to
	      the right of the insertion cursor.

       [8]    The BackSpace key and Control-h delete the selection,  if	 there
	      is  one  in the entry.  If there is no selection, it deletes the
	      character to the left of the insertion cursor.

       [9]    Control-d deletes the character to the right  of	the  insertion
	      cursor.

       [10]   Control-k	 deletes all the characters to the right of the inser-
	      tion cursor.

       [11]   Control-t reverses the order of the two characters to the	 right
	      of the insertion cursor.

       If the entry is disabled using the -state option, then the entry's view
       can still be adjusted and text in the entry can still be selected,  but
       no  insertion  cursor  will be displayed and no text modifications will
       take place.

       The behavior of entries can be changed by  defining  new	 bindings  for
       individual widgets or by redefining the class bindings.


KEYWORDS
       entry, widget



Ck				      8.0			      entry(n)
