summaryrefslogtreecommitdiffstats
path: root/doc/ttk_combobox.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-10-22 14:33:13 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-10-22 14:33:13 (GMT)
commit5787fe560c93a6350d21481301843f811fe912b0 (patch)
tree140cdc3cc35622196837dfa37d3abf5c27df2da1 /doc/ttk_combobox.n
parentdfdf99ed53285ece3a7ca2ca269a205b4c3b69e2 (diff)
downloadtk-5787fe560c93a6350d21481301843f811fe912b0.zip
tk-5787fe560c93a6350d21481301843f811fe912b0.tar.gz
tk-5787fe560c93a6350d21481301843f811fe912b0.tar.bz2
Documentation improvements, all minor.
Diffstat (limited to 'doc/ttk_combobox.n')
-rw-r--r--doc/ttk_combobox.n82
1 files changed, 41 insertions, 41 deletions
diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n
index 85b2a24..598ea0f 100644
--- a/doc/ttk_combobox.n
+++ b/doc/ttk_combobox.n
@@ -3,8 +3,8 @@
'\"
'\" 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.5 2007/08/28 15:16:11 dkf Exp $
+'\"
+'\" RCS: @(#) $Id: ttk_combobox.n,v 1.6 2007/10/22 14:33:13 dkf Exp $
'\"
.so man.macros
.TH ttk_combobox n 8.5 Tk "Tk Themed Widget"
@@ -18,8 +18,8 @@ ttk_combobox \- text field with popdown selection list
.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
-values in the list.
+the user may select the value of the text field from among the values in the
+list.
.SO
\-class \-cursor \-takefocus \-style
.SE
@@ -27,30 +27,25 @@ values in the list.
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-exportselection exportSelection ExportSelection
-Boolean value.
-If set, the widget selection is linked to the X selection.
+Boolean value. If set, the widget selection is linked to the X selection.
.OP \-justify justify Justify
-Specifies how the text is aligned within the widget.
-One of \fBleft\fR, \fBcenter\fR, or \fBright\fR.
+Specifies how the text is aligned within the widget. One of \fBleft\fR,
+\fBcenter\fR, or \fBright\fR.
.OP \-height height Height
Specifies the height of the pop-down listbox, in rows.
.OP \-postcommand postCommand PostCommand
-A Tcl script to evaluate immediately before displaying the listbox.
-The \fB-postcommand\fR script may specify the \fB-values\fR to display.
+A Tcl script to evaluate immediately before displaying the listbox. The
+\fB\-postcommand\fR script may specify the \fB\-values\fR to display.
.OP \-state state State
-One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fR.
-In the \fBreadonly\fR state,
-the value may not be edited directly, and
-the user can only select one of the \fB-values\fR from the
-dropdown list.
-In the \fBnormal\fR state,
-the text field is directly editable.
-In the \fBdisabled\fR state, no interaction is possible.
+One of \fBnormal\fR, \fBreadonly\fR, or \fBdisabled\fR. In the \fBreadonly\fR
+state, the value may not be edited directly, and the user can only select one
+of the \fB\-values\fR from the dropdown list. In the \fBnormal\fR state, the
+text field is directly editable. In the \fBdisabled\fR state, no interaction
+is possible.
.OP \-textvariable textVariable TextVariable
-Specifies the name of a variable whose value is linked
-to the widget value.
-Whenever the variable changes value the widget value is updated,
-and vice versa.
+Specifies the name of a variable whose value is linked to the widget value.
+Whenever the variable changes value the widget value is updated, and vice
+versa.
.OP \-values values Values
Specifies the list of values to display in the drop-down listbox.
.OP \-width width Width
@@ -61,39 +56,44 @@ in average-size characters of the widget's font.
.SH "WIDGET COMMAND"
.TP
\fIpathName \fBcget\fR \fIoption\fR
-Returns the current value of the specified \fIoption\fR.
-See \fIttk_widget(n)\fR.
+.
+Returns the current value of the specified \fIoption\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.
+.
+Modify or query widget options. See \fIttk_widget(n)\fR.
.TP
\fIpathName \fBcurrent\fR ?\fInewIndex\fR?
-If \fInewIndex\fR is supplied, sets the combobox value
-to the element at position \fInewIndex\fR in the list of \fB-values\fR.
-Otherwise, returns the index of the current value in the list of \fB-values\fR
-or \fB-1\fR if the current value does not appear in the list.
+.
+If \fInewIndex\fR is supplied, sets the combobox value to the element at
+position \fInewIndex\fR in the list of \fB\-values\fR. Otherwise, returns the
+index of the current value in the list of \fB\-values\fR or \fB\-1\fR if the
+current value does not appear in the list.
.TP
\fIpathName \fBget\fR
+.
Returns the current value of the combobox.
.TP
\fIpathName \fBidentify \fIx y\fR
-Returns the name of the element at position \fIx\fR, \fIy\fR,
-or the empty string if the coordinates are outside the window.
+.
+Returns the name of the element at position \fIx\fR, \fIy\fR, 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.
+.
+Test the widget state. 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.
+.
+Modify or query the widget state. 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):
+The combobox widget also supports the following \fIttk::entry\fR widget
+commands (see \fIttk_entry(n)\fR for details):
.DS
.ta 5.5c 11c
bbox delete icursor
@@ -102,9 +102,9 @@ 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.
+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)