summaryrefslogtreecommitdiffstats
path: root/doc/ttk_combobox.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_combobox.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_combobox.n')
-rw-r--r--doc/ttk_combobox.n24
1 files changed, 9 insertions, 15 deletions
diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n
index a027b50..6dee90f 100644
--- a/doc/ttk_combobox.n
+++ b/doc/ttk_combobox.n
@@ -4,18 +4,16 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ttk_combobox.n,v 1.9 2007/10/29 16:04:14 dkf Exp $
+'\" RCS: @(#) $Id: ttk_combobox.n,v 1.10 2007/11/01 10:59:42 dkf Exp $
'\"
.so man.macros
-.TH ttk_combobox n 8.5 Tk "Tk Themed Widget"
+.TH ttk::combobox n 8.5 Tk "Tk Themed Widget"
.BS
-.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk_combobox \- text field with popdown selection list
+ttk::combobox \- text field with popdown selection list
.SH SYNOPSIS
\fBttk::combobox\fR \fIpathName \fR?\fIoptions\fR?
.BE
-
.SH DESCRIPTION
A \fBttk::combobox\fR combines a text field with a pop-down list of values;
the user may select the value of the text field from among the
@@ -24,7 +22,6 @@ values in the list.
\-class \-cursor \-takefocus \-style
.SE
.\" ALSO: Other entry widget options
-
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-exportselection exportSelection ExportSelection
Boolean value.
@@ -57,16 +54,15 @@ Specifies the list of values to display in the drop-down listbox.
Specifies an integer value indicating the desired width of the entry window,
in average-size characters of the widget's font.
.BE
-
.SH "WIDGET COMMAND"
.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 \fBcurrent\fR ?\fInewIndex\fR?
If \fInewIndex\fR is supplied, sets the combobox value
@@ -83,30 +79,28 @@ or the empty string if the coordinates are outside the window.
.TP
\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR?
Test the widget state.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBset\fR \fIvalue\fR
Sets the value of the combobox to \fIvalue\fR.
.TP
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
Modify or query the widget state.
-See \fIttk_widget(n)\fR.
+See \fIttk::widget(n)\fR.
.PP
The combobox widget also supports the following \fIttk::entry\fR
-widget commands (see \fIttk_entry(n)\fR for details):
+widget commands (see \fIttk::entry(n)\fR for details):
.DS
.ta 5.5c 11c
bbox delete icursor
index insert selection
xview
.DE
-
.SH "VIRTUAL EVENTS"
The combobox widget generates a \fB<<ComboboxSelected>>\fR virtual event
when the user selects an element from the list of values.
This event is generated after the listbox is unposted.
-
.SH "SEE ALSO"
-ttk_widget(n), ttk_entry(n)
+ttk::widget(n), ttk::entry(n)
.SH KEYWORDS
choice, entry, list box, text box, widget