Subversion Repositories or1k

'\"

'\" Copyright (c) 1990-1994 The Regents of the University of California.

'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.

'\"

'\" See the file "license.terms" for information on usage and redistribution

'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.

'\"

'\" RCS: @(#) $Id: entry.n,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $

'\"

.so man.macros

.TH entry n 4.1 Tk "Tk Built-In Commands"

.BS

'\" Note:  do not modify the .SH NAME line immediately below!

.SH NAME

entry \- Create and manipulate entry widgets

.SH SYNOPSIS

\fBentry\fR \fIpathName \fR?\fIoptions\fR?

.SO

\-background    \-highlightbackground   \-insertontime  \-selectforeground

\-borderwidth   \-highlightcolor        \-insertwidth   \-takefocus

\-cursor        \-highlightthickness    \-justify       \-textvariable

\-exportselection       \-insertbackground      \-relief        \-xscrollcommand

\-font  \-insertborderwidth     \-selectbackground

\-foreground    \-insertofftime \-selectborderwidth

.SE

.SH "WIDGET-SPECIFIC OPTIONS"

.OP \-show show 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 example, if the entry is to be used to enter

a password.

If characters in the entry are selected and copied elsewhere, the

information copied will be what is displayed, not the true contents

of the entry.

.OP \-state state State

Specifies one of two states for the entry:  \fBnormal\fR or \fBdisabled\fR.

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.

.OP \-width width Width

Specifies an integer value indicating the desired width of the entry window,

in average-size characters of the widget's font.

If the value is less than or equal to zero, the widget picks a

size just large enough to hold its current text.

.BE

.SH DESCRIPTION

.PP

The \fBentry\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 the

command line or in the option database

to configure aspects of the entry such as its colors, font,

and relief.  The \fBentry\fR command returns its

\fIpathName\fR argument.  At the time this command is invoked,

there must not exist a window named \fIpathName\fR, but

\fIpathName\fR's parent must exist.

.PP

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 created, an entry's string is empty.

A portion of the entry may be selected as described below.

If an entry is exporting its selection (see the \fBexportSelection\fR

option), then it will observe the standard X11 protocols for handling the

selection;  entry selections are available as type \fBSTRING\fR.

Entries also observe the standard Tk rules for dealing with the

input focus.  When an entry has the input focus it displays an

\fIinsertion cursor\fR to indicate where new characters will be

inserted.

.PP

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 \fBxScrollCommand\fR mechanism for interacting with

scrollbars (see the description of the \fBxScrollCommand\fR option

for details).  They also support scanning, as described below.

.SH "WIDGET COMMAND"

.PP

The \fBentry\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:

.CS

\fIpathName option \fR?\fIarg arg ...\fR?

.CE

\fIOption\fR and the \fIarg\fRs

determine the exact behavior of the command.

.PP

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:

.TP 12

\fInumber\fR

Specifies the character as a numerical index, where 0 corresponds

to the first character in the string.

.TP 12

\fBanchor\fR

Indicates the anchor point for the selection, which is set with the

\fBselect from\fR and \fBselect adjust\fR widget commands.

.TP 12

\fBend\fR

Indicates the character just after the last one in the entry's string.

This is equivalent to specifying a numerical index equal to the length

of the entry's string.

.TP 12

\fBinsert\fR

Indicates the character adjacent to and immediately following the

insertion cursor.

.TP 12

\fBsel.first\fR

Indicates the first character in the selection.  It is an error to

use this form if the selection isn't in the entry window.

.TP 12

\fBsel.last\fR

Indicates the character just after the last one in the selection.

It is an error to use this form if the selection isn't in the

entry window.

.TP 12

\fB@\fInumber\fR

In this form, \fInumber\fR is treated as an x-coordinate in the

entry's window;  the character spanning that x-coordinate is used.

For example, ``\fB@0\fR'' indicates the left-most character in the

window.

.LP

Abbreviations may be used for any of the forms above, e.g. ``\fBe\fR''

or ``\fBsel.f\fR''.  In general, out-of-range indices are automatically

rounded to the nearest legal value.

.PP

The following commands are possible for entry widgets:

.TP

\fIpathName \fBbbox \fIindex\fR

Returns a list of four numbers describing the bounding box of the

character given by \fIindex\fR.

The first two elements of the list give the x and y coordinates of

the upper-left corner of the screen area covered by the character

(in pixels relative to the widget) and the last two elements give

the width and height of the character, in pixels.

The bounding box may refer to a region outside the visible area

of the window.

.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 \fBentry\fR

command.

.TP

\fIpathName \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 \fBentry\fR

command.

.TP

\fIpathName \fBdelete \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 last

one 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 \fBget\fR

Returns the entry's string.

.TP

\fIpathName \fBicursor \fIindex\fR

Arrange for the insertion cursor to be displayed just before the character

given by \fIindex\fR.  Returns an empty string.

.TP

\fIpathName \fBindex\fI index\fR

Returns the numerical index corresponding to \fIindex\fR.

.TP

\fIpathName \fBinsert \fIindex string\fR

Insert the characters of \fIstring\fR just before the character

indicated by \fIindex\fR.  Returns an empty string.

.TP

\fIpathName \fBscan\fR \fIoption args\fR

This command is used to implement scanning on entries.  It has

two forms, depending on \fIoption\fR:

.RS

.TP

\fIpathName \fBscan mark \fIx\fR

Records \fIx\fR and the current view in the entry window;  used in

conjunction with later \fBscan dragto\fR commands.  Typically this

command is associated with a mouse button press in the widget.  It

returns an empty string.

.TP

\fIpathName \fBscan dragto \fIx\fR

This command computes the difference between its \fIx\fR argument

and the \fIx\fR argument to the last \fBscan mark\fR command for

the widget.  It then adjusts the view left or right by 10 times the

difference in x-coordinates.  This command is typically associated

with mouse motion events in the widget, to produce the effect of

dragging the entry at high speed through the window.  The return

value is an empty string.

.RE

.TP

\fIpathName \fBselection \fIoption arg\fR

This command is used to adjust the selection within an entry.  It

has several forms, depending on \fIoption\fR:

.RS

.TP

\fIpathName \fBselection adjust \fIindex\fR

Locate 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 other

end of the selection is made the anchor point for future

\fBselect to\fR commands.  If the selection

isn't currently in the entry, then a new selection is created to

include the characters between \fIindex\fR and the most recent

selection anchor point, inclusive.

Returns an empty string.

.TP

\fIpathName \fBselection clear\fR

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.

.TP

\fIpathName \fBselection from \fIindex\fR

Set the selection anchor point to just before the character

given by \fIindex\fR.  Doesn't change the selection.

Returns an empty string.

.TP

\fIpathName \fBselection present\fR

Returns 1 if there is are characters selected in the entry,

.TP

\fIpathName \fBselection range \fIstart\fR \fIend\fR

Sets the selection to include the characters starting with

the one indexed by \fIstart\fR and ending with the one just

before \fIend\fR.

If \fIend\fR refers to the same character as \fIstart\fR or an

earlier one, then the entry's selection is cleared.

.TP

\fIpathName \fBselection to \fIindex\fR

If \fIindex\fR is before the anchor point, set the selection

to the characters from \fIindex\fR up to but not including

the anchor point.

If \fIindex\fR is the same as the anchor point, do nothing.

If \fIindex\fR is after the anchor point, set the selection

to the characters from the anchor point up to but not including

\fIindex\fR.

The anchor point is determined by the most recent \fBselect from\fR

or \fBselect adjust\fR 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.

.RE

.TP

\fIpathName \fBxview \fIargs\fR

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 following

forms:

.RS

.TP

\fIpathName \fBxview\fR

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 element 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 \fB\-xscrollcommand\fR

option.

.TP

\fIpathName \fBxview\fR \fIindex\fR

Adjusts the view in the window so that the character given by \fIindex\fR

is displayed at the left edge of the window.

.TP

\fIpathName \fBxview moveto\fI fraction\fR

Adjusts the view in the window so that the character \fIfraction\fR of the

way through the text appears at the left edge of the window.

\fIFraction\fR must be a fraction between 0 and 1.

.TP

\fIpathName \fBxview scroll \fInumber what\fR

This 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 \fBunits\fR or \fBpages\fR or an abbreviation

of one of these.

If \fIwhat\fR is \fBunits\fR, the view adjusts left or right by

\fInumber\fR average-width characters on the display;  if it is

\fBpages\fR then the view adjusts by \fInumber\fR screenfuls.

If \fInumber\fR is negative then characters farther to the left

become visible;  if it is positive then characters farther to the right

become visible.

.RE

.SH "DEFAULT BINDINGS"

.PP

Tk automatically creates class bindings for entries that give them

the following default behavior.

In the descriptions below, ``word'' refers to a contiguous group

of letters, digits, or ``_'' characters, or any single character

other than these.

.IP [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.

Dragging with mouse button 1 strokes out a selection between

the insertion cursor and the character under the mouse.

.IP [2]

Double-clicking with mouse button 1 selects the word under the mouse

and positions the insertion cursor at the beginning of the word.

Dragging after a double click will stroke out a selection consisting

of whole words.

.IP [3]

Triple-clicking with mouse button 1 selects all of the text in the

entry and positions the insertion cursor before the first character.

.IP [4]

The ends of the selection can be adjusted by dragging with mouse

button 1 while the Shift key is down;  this will adjust the end

of the selection that was nearest to the mouse cursor when button

1 was pressed.

If the button is double-clicked before dragging then the selection

will be adjusted in units of whole words.

.IP [5]

Clicking mouse button 1 with the Control key down will position the

insertion cursor in the entry without affecting the selection.

.IP [6]

If any normal printing characters are typed in an entry, they are

inserted at the point of the insertion cursor.

.IP [7]

The view in the entry can be adjusted by dragging with mouse button 2.

If mouse button 2 is clicked without moving the mouse, the selection

is copied into the entry at the position of the mouse cursor.

.IP [8]

If the mouse is dragged out of the entry on the left or right sides

while button 1 is pressed, the entry will automatically scroll to

make more text visible (if there is more text off-screen on the side

where the mouse left the window).

.IP [9]

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.

If Left or Right is typed with the Shift key down, then the insertion

cursor moves and the selection is extended to include the new character.

Control-Left and Control-Right move the insertion cursor by words, and

Control-Shift-Left and Control-Shift-Right move the insertion cursor

by words and also extend the selection.

Control-b and Control-f behave the same as Left and Right, respectively.

Meta-b and Meta-f behave the same as Control-Left and Control-Right,

respectively.

.IP [10]

The Home key, or Control-a, will move the insertion cursor to the

beginning of the entry and clear any selection in the entry.

Shift-Home moves the insertion cursor to the beginning of the entry

and also extends the selection to that point.

.IP [11]

The End key, or Control-e, will move the insertion cursor to the

end of the entry and clear any selection in the entry.

Shift-End moves the cursor to the end and extends the selection

to that point.

.IP [12]

The Select key and Control-Space set the selection anchor to the position

of the insertion cursor.  They don't affect the current selection.

Shift-Select and Control-Shift-Space adjust the selection to the

current position of the insertion cursor, selecting from the anchor

to the insertion cursor if there was not any selection previously.

.IP [13]

Control-/ selects all the text in the entry.

.IP [14]

Control-\e clears any selection in the entry.

.IP [15]

The F16 key (labelled Copy on many Sun workstations) or Meta-w

copies the selection in the widget to the clipboard, if there is a selection.

.IP [16]

The F20 key (labelled Cut on many Sun workstations) or Control-w

copies the selection in the widget to the clipboard and deletes

the selection.

If there is no selection in the widget then these keys have no effect.

.IP [17]

The F18 key (labelled Paste on many Sun workstations) or Control-y

inserts the contents of the clipboard at the position of the

insertion cursor.

.IP [18]

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.

.IP [19]

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.

.IP [20]

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

.IP [21]

Meta-d deletes the word to the right of the insertion cursor.

.IP [22]

Control-k deletes all the characters to the right of the insertion

cursor.

.IP [23]

Control-t reverses the order of the two characters to the right of

the insertion cursor.

.PP

If the entry is disabled using the \fB\-state\fR 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.

.PP

The behavior of entries can be changed by defining new bindings for

individual widgets or by redefining the class bindings.

.SH KEYWORDS

entry, widget