.TH ENTRY 9.SH NAMEentry \- Create and manipulate entry widgets.SH SYNOPSIS\f5entry\fI \fIpathName \fR?\fIoptions\fR?.SH STANDARD OPTIONS.EX-background  -highlightcolor     -selectbackground-borderwidth -highlightthickness -selectforeground-font        -justify            -takefocus-foreground  -relief             -xscrollcommand.EE.SH "WIDGET-SPECIFIC OPTIONS".TP.B -show \fIstring\fPIf this option is specified, then the true contents of the entryare not displayed in the window.Instead, each character in the entry's value will be displayed asthe first character in the value of this option, such as ``*''.This is useful, for example, if the entry is to be used to entera password..TP.B -state \fIstate\fPSpecifies one of two states for the entry:  \f5normal\fR or \f5disabled\fR.If the entry is disabled then the value may not be changed using widgetcommands and no insertion cursor will be displayed, even if the input focus isin the widget..TP.B -width \fIdist\fPSpecifies an integer value indicating the desired width of the entry window. .SH DESCRIPTIONThe \f5entry\fR command creates a new window (given by the\fIpathName\fR argument) and makes it into an entry widget.Additional options, described above, may be specified on thecommand lineto configure aspects of the entry such as its colours, font,and relief.  The \f5entry\fR command returns its\fIpathName\fR argument.  At the time this command is invoked,there must not exist a window named \fIpathName\fR..PPAn entry is a widget that displays a one-line text string andallows that string to be edited using widget commands described below, whichare typically bound to keystrokes and mouse actions.When first created, an entry's string is empty.A portion of the entry may be selected as described below.Entries observe the standard Tk rules for dealing with theinput focus.  When an entry has the input focus it displays an\fIinsertion cursor\fR to indicate where new characters will beinserted..PPEntries are capable of displaying strings that are too long tofit entirely within the widget's window.  In this case, only aportion of the string will be displayed;  commands described belowmay be used to change the view in the window.  Entries usethe standard \f5xscrollcommand\fR mechanism for interacting withscrollbars (see the description of the \f5xscrollcommand\fR optionfor details). .SH "WIDGET COMMAND"The \f5entry\fR command creates a new Tk command whosename is \fIpathName\fR.  Thiscommand may be used to invoke variousoperations on the widget.  It has the following general form:.RS.EX\fIpathName option \fR?\fIarg arg ...\fR?.EE.RE\fIOption\fR and the \fIarg\fRsdetermine the exact behaviour of the command..PPMany of the widget commands for entries take one or more indices asarguments.  An index specifies a particular character in the entry'sstring, in any of the following ways:.TP 12\fInumber\fRSpecifies the character as a numerical index, where 0 correspondsto the first character in the string..TP 12\f5anchor\fRIndicates the anchor point for the selection, which is set with the\f5select from\fR and \f5select adjust\fR widget commands..TP 12\f5end\fRIndicates the character just after the last one in the entry's string.This is equivalent to specifying a numerical index equal to the lengthof the entry's string..TP 12\f5insert\fRIndicates the character adjacent to and immediately following theinsertion cursor..TP 12\f5sel.first\fRIndicates the first character in the selection.  It is an error touse this form if the selection isn't in the entry window..TP 12\f5sel.last\fRIndicates the character just after the last one in the selection.It is an error to use this form if the selection isn't in theentry window..TP 12\f5@\fInumber\fRIn this form, \fInumber\fR is treated as an x-coordinate in theentry's window;  the character spanning that x-coordinate is used.For example, ``\f5@0\fR'' indicates the left-most character in thewindow..PPThe following commands are possible for entry widgets:.TP\fIpathName \f5bbox \fIindex\fRReturns a list of four numbers describing the bounding box of thecharacter given by \fIindex\fR.The first two elements of the list give the x and y coordinates ofthe upper-left corner of the screen area covered by the character(in pixels relative to the widget) and the last two elements givethe width and height of the character, in pixels.The bounding box may refer to a region outside the visible areaof the window..TP\fIpathName \f5cget\fR \fIoption\fRReturns the current value of the configuration option givenby \fIoption\fR.\fIOption\fR may have any of the values accepted by the \f5entry\fRcommand..TP\fIpathName \f5configure\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 of all ofthe available options for \fIpathName\fR.  Ifone or more \fIoption-value\fR pairs are specified, then the commandmodifies the given widget option(s) to have the given value(s);  inthis case the command returns an empty string.\fIOption\fR may have any of the values accepted by the \f5entry\fRcommand..TP\fIpathName \f5delete \fIfirst \fR?\fIlast\fR?Delete one or more elements of the entry.\fIFirst\fR is the index of the first character to delete, and\fIlast\fR is the index of the character just after the lastone to delete.If \fIlast\fR isn't specified it defaults to \fIfirst\fR+1,i.e. a single character is deleted.This command returns an empty string..TP\fIpathName \f5get\fRReturns the entry's string..TP\fIpathName \f5icursor \fIindex\fRArrange for the insertion cursor to be displayed just before the charactergiven by \fIindex\fR.  Returns an empty string..TP\fIpathName \f5index\fI index\fRReturns the numerical index corresponding to \fIindex\fR..TP\fIpathName \f5insert \fIindex string\fRInsert the characters of \fIstring\fR just before the characterindicated by \fIindex\fR.  Returns an empty string..TP\fIpathName \f5see \fIindex\fRAdjusts the view in the window so that the character given by \fIindex\fRis completely visible..TP\fIpathName \f5selection \fIoption arg\fRThis command is used to adjust the selection within an entry.  Ithas several forms, depending on \fIoption\fR:.RS.TP\fIpathName \f5selection adjust \fIindex\fRLocate the end of the selection nearest to the character given by\fIindex\fR, and adjust that end of the selection to be at \fIindex\fR(i.e including but not going beyond \fIindex\fR).  The otherend of the selection is made the anchor point for future\f5select to\fR commands.  If the selectionisn't currently in the entry, then a new selection is created toinclude the characters between \fIindex\fR and the most recentselection anchor point, inclusive.Returns an empty string..TP\fIpathName \f5selection clear\fRClear the selection if it is currently in this widget.  If theselection isn't in this widget then the command has no effect.Returns an empty string..TP\fIpathName \f5selection from \fIindex\fRSet the selection anchor point to just before the charactergiven by \fIindex\fR.  Doesn't change the selection.Returns an empty string..TP\fIpathName \f5selection present\fRReturns 1 if there are characters selected in the entry,0 if nothing is selected..TP\fIpathName \f5selection range \fIstart\fR \fIend\fRSets the selection to include the characters starting withthe one indexed by \fIstart\fR and ending with the one justbefore \fIend\fR.If \fIend\fR refers to the same character as \fIstart\fR or anearlier one, then the entry's selection is cleared..TP\fIpathName \f5selection to \fIindex\fRIf \fIindex\fR is before the anchor point, set the selectionto the characters from \fIindex\fR up to but not includingthe anchor point.If \fIindex\fR is the same as the anchor point, do nothing.If \fIindex\fR is after the anchor point, set the selectionto the characters from the anchor point up to but not including\fIindex\fR.The anchor point is determined by the most recent \f5select from\fRor \f5select adjust\fR command in this widget.If the selection isn't in this widget then a new selection iscreated using the most recent anchor point specified for the widget.Returns an empty string..RE.TP\fIpathName \f5xview \fIargs\fRThis command is used to query and change the horizontal position of thetext in the widget's window.  It can take any of the followingforms:.RS.TP\fIpathName \f5xview\fRReturns a list containing two elements.Each element is a real fraction between 0 and 1;  together they describethe horizontal span that is visible in the window.For example, if the first element is .2 and the second element is .6,20% of the entry's text is off-screen to the left, the middle 40% is visiblein the window, and 40% of the text is off-screen to the right.These are the same values passed to scrollbars via the \f5-xscrollcommand\fRoption..TP\fIpathName \f5xview\fR \fIindex\fRAdjusts the view in the window so that the character given by \fIindex\fRis displayed at the left edge of the window..TP\fIpathName \f5xview moveto\fI fraction\fRAdjusts the view in the window so that the character \fIfraction\fR of theway through the text appears at the left edge of the window.\fIFraction\fR must be a fraction between 0 and 1..TP\fIpathName \f5xview scroll \fInumber what\fRThis command shifts the view in the window left or right according to\fInumber\fR and \fIwhat\fR.\fINumber\fR must be an integer.\fIWhat\fR must be either \f5units\fR or \f5pages\fR.If \fIwhat\fR is \f5units\fR, the view adjusts left or right by\fInumber\fR average-width characters on the display;  if it is\f5pages\fR then the view adjusts by \fInumber\fR screenfuls.If \fInumber\fR is negative then characters farther to the leftbecome visible;  if it is positive then characters farther to the rightbecome visible..RE .SH "DEFAULT BINDINGS"Tk automatically creates bindings for entries that give themthe following default behaviour.In the descriptions below, ``word'' refers to a contiguous groupof letters, digits, or ``_'' characters, or any single characterother than these..IP [1]Clicking mouse button 1 positions the insertion cursorjust before the character underneath the mouse cursor, sets theinput focus to this widget, and clears any selection in the widget.Dragging with mouse button 1 strokes out a selection betweenthe insertion cursor and the character under the mouse..IP [2]Double-clicking with mouse button 1 selects the word under the mouseand positions the insertion cursor at the beginning of the word..IP [3]If any normal printing characters are typed in an entry, the currentselection is deleted, and they areinserted at the point of the insertion cursor.IP [4]The view in the entry can be adjusted by dragging with mouse button 2..IP [5]The Left and Right keys move the insertion cursor one character to theleft or right;  they also clear any selection in the entry and setthe selection anchor.Control-b and Control-f behave the same as Left and Right, respectively..IP [6]The Home key, or Control-a, will move the insertion cursor to thebeginning of the entry and clear any selection in the entry..IP [7]The End key, or Control-e, will move the insertion cursor to theend of the entry and clear any selection in the entry..IP [8]Control-/ selects all the text in the entry..IP [9]Control-\e clears any selection in the entry..IP [10]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 ofthe insertion cursor..IP [11]The BackSpace key and Control-h delete the selection, if there is onein the entry.If there is no selection, it deletes the character to the left ofthe insertion cursor..IP [12]Control-d deletes the character to the right of the insertion cursor..IP [13]Control-k deletes all the characters to the right of the insertioncursor..IP [14]Control-w deletes the word to the left of the insertion cursor..PPIf the entry is disabled using the \f5-state\fR option, then the entry'sview can still be adjusted and text in the entry can still be selected,but no insertion cursor will be displayed and no text modifications willtake place..PPThe behaviour of entries can be changed by defining new bindings forindividual widgets..SH SEE ALSO.IR options (9),.IR types (9)