summaryrefslogtreecommitdiffstats
path: root/doc/ttk_combobox.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commit983fb168919502aae8279e5596bfaa149d17ff8f (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_combobox.n
parent73eb12c82342f64f6867682e31d4f7b36283c4a1 (diff)
downloadtk-983fb168919502aae8279e5596bfaa149d17ff8f.zip
tk-983fb168919502aae8279e5596bfaa149d17ff8f.tar.gz
tk-983fb168919502aae8279e5596bfaa149d17ff8f.tar.bz2
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_combobox.n')
-rw-r--r--doc/ttk_combobox.n38
1 files changed, 25 insertions, 13 deletions
diff --git a/doc/ttk_combobox.n b/doc/ttk_combobox.n
index 3e2fe23..5f08b04 100644
--- a/doc/ttk_combobox.n
+++ b/doc/ttk_combobox.n
@@ -1,17 +1,30 @@
'\"
'\" Copyright (c) 2004 Joe English
'\"
+'\" 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.3 2006/12/13 23:04:32 hobbs Exp $
+'\"
.so man.macros
.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
+values in the list.
.SO
\-class \-cursor \-takefocus \-style
.SE
.\" ALSO: Other entry widget options
+
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-exportselection exportSelection ExportSelection
Boolean value.
@@ -42,19 +55,16 @@ 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 DESCRIPTION
-A combobox 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.
+
.SH "WIDGET COMMAND"
.TP
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the specified \fIoption\fR.
-See \fIwidget(n)\fR.
+See \fIttk_widget(n)\fR.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
Modify or query widget options.
-See \fIwidget(n)\fR.
+See \fIttk_widget(n)\fR.
.TP
\fIpathName \fBcurrent\fR ?\fInewIndex\fR?
If \fInewIndex\fR is supplied, sets the combobox value
@@ -69,28 +79,30 @@ Returns the current value of the combobox.
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?
+\fIpathName \fBinstate \fIstateSpec\fR ?\fIscript\fR?
Test the widget state.
-See \fIwidget(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 \fIwidget(n)\fR.
+See \fIttk_widget(n)\fR.
.PP
-The combobox widget also supports the following \fIentry\fR
-widget commands (see \fIentry(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
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"
-widget(n), entry(n)
+ttk_widget(n), ttk_entry(n)