summaryrefslogtreecommitdiffstats
path: root/doc/ttk_entry.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-11-01 10:59:40 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-11-01 10:59:40 (GMT)
commit83f6db972b3cbb518343cf41b23e9bf959339e8b (patch)
treea9fdb782fb5a267cd0d5385c6d95aae6bd26fe13 /doc/ttk_entry.n
parent3ab66bf90c3de1b2ffe2c7eef83f56e189c02337 (diff)
downloadtk-83f6db972b3cbb518343cf41b23e9bf959339e8b.zip
tk-83f6db972b3cbb518343cf41b23e9bf959339e8b.tar.gz
tk-83f6db972b3cbb518343cf41b23e9bf959339e8b.tar.bz2
Make documentation use the name that scripts use as much as possible.
[Bug 1640073]
Diffstat (limited to 'doc/ttk_entry.n')
-rw-r--r--doc/ttk_entry.n26
1 files changed, 9 insertions, 17 deletions
diff --git a/doc/ttk_entry.n b/doc/ttk_entry.n
index dcf46fc..c697c65 100644
--- a/doc/ttk_entry.n
+++ b/doc/ttk_entry.n
@@ -7,18 +7,16 @@
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" SOURCE: entry.n, r1.12
-'\" RCS: @(#) $Id: ttk_entry.n,v 1.7 2007/10/29 16:04:14 dkf Exp $
+'\" RCS: @(#) $Id: ttk_entry.n,v 1.8 2007/11/01 10:59:43 dkf Exp $
'\"
.so man.macros
-.TH ttk_entry n 8.5 Tk "Tk Themed Widget"
+.TH ttk::entry n 8.5 Tk "Tk Themed Widget"
.BS
-.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk_entry \- Editable text field widget
+ttk::entry \- Editable text field widget
.SH SYNOPSIS
\fBttk::entry\fR \fIpathName \fR?\fIoptions\fR?
.BE
-
.SH DESCRIPTION
.PP
An \fBttk::entry\fR widget displays a one-line text string and
@@ -31,7 +29,6 @@ standard \fB\-xscrollcommand\fR option and \fBxview\fR widget command.
\-class \-cursor \-style \-takefocus
\-xscrollcommand
.SE
-
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-exportselection exportSelection ExportSelection
A boolean value specifying whether or not
@@ -66,7 +63,7 @@ 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
-Compatibility option; see \fIttk_widget(n)\fR for details.
+Compatibility option; see \fIttk::widget(n)\fR for details.
Specifies one of three states for the entry,
\fBnormal\fR, \fBdisabled\fR, or \fBreadonly\fR.
See \fBWIDGET STATES\fR, below.
@@ -91,7 +88,6 @@ in average-size characters of the widget's font.
.\" Not in ttk: If the value is less than or equal to zero, the widget picks a
.\" Not in ttk: size just large enough to hold its current text.
.BE
-
.SH NOTES
A portion of the entry may be selected as described below.
If an entry is exporting its selection (see the \fBexportSelection\fR
@@ -109,7 +105,6 @@ 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).
-
.SH "INDICES"
Many of the \fBentry\fR widget commands take one or more indices as
arguments. An index specifies a particular character in the entry's
@@ -160,11 +155,11 @@ of the window.
.TP
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the specified \fIoption\fR.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
Modify or query widget options.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBdelete \fIfirst \fR?\fIlast\fR?
Delete one or more elements of the entry.
@@ -195,7 +190,7 @@ indicated by \fIindex\fR. Returns the empty string.
.TP
\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR?
Test the widget state.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBselection \fIoption arg\fR
This command is used to adjust the selection within an entry. It
@@ -221,7 +216,7 @@ earlier one, then the entry's selection is cleared.
.TP
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
Modify or query the widget state.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBvalidate\fR
Force revalidation, independent of the conditions specified
@@ -267,7 +262,6 @@ 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 VALIDATION
The \fB\-validate\fR, \fB\-validatecommand\fR, and \fB\-invalidcommand\fR
options are used to enable entry widget validation.
@@ -350,7 +344,6 @@ modifying the entry value in a validation script).
.IP \(bu
The standard entry widget invokes validation whenever the linked
\fB\-textvariable\fR is modified; the Tk themed entry widget does not.
-
.SH "DEFAULT BINDINGS"
The entry widget's default bindings enable the following behavior.
In the descriptions below,
@@ -432,7 +425,6 @@ Control-d deletes the character to the right of the insert cursor.
.IP \(bu
Control-k deletes all the characters to the right of the insertion
cursor.
-
.SH "WIDGET STATES"
In the \fBdisabled\fR state,
the entry cannot be edited and the text cannot be selected.
@@ -454,6 +446,6 @@ and a different background is used in the \fBreadonly\fR state.
The entry widget sets the \fBinvalid\fR state if revalidation fails,
and clears it whenever validation succeeds.
.SH "SEE ALSO"
-ttk_widget(n), entry(n)
+ttk::widget(n), entry(n)
.SH KEYWORDS
entry, widget, text field